[CLNP-6249] deprecated mark for ChannelXXX (#1302)

- Added @deprecated annotation to the deprecated Channel components Fixes [CLNP-6249](https://sendbird.atlassian.net/browse/CLNP-6249) ### Changelogs ### Checklist Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If unsure, ask the members. This is a reminder of what we look for before merging your code. - [ ] **All tests pass locally with my changes** - [ ] **I have added tests that prove my fix is effective or that my feature works** - [ ] **Public components / utils / props are appropriately exported** - [ ] I have added necessary documentation (if appropriate) ## External Contributions This project is not yet set up to accept pull requests from external contributors. If you have a pull request that you believe should be accepted, please contact the Developer Relations team <[email protected]> with details and we'll evaluate if we can set up a [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement) to allow for the contribution. [CLNP-6249]: https://sendbird.atlassian.net/browse/CLNP-6249?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
sendbird · Jan 22, 2025 · cdeb26e · cdeb26e
1 parent 63ed666
commit cdeb26e
Show file tree

Hide file tree

Showing 10 changed files with 61 additions and 0 deletions.
diff --git a/src/modules/Channel/components/ChannelHeader/index.tsx b/src/modules/Channel/components/ChannelHeader/index.tsx
@@ -6,6 +6,12 @@ export interface ChannelHeaderProps {
   className?: string;
 }
 
+/**
+ * @deprecated This component is deprecated and will be removed in the next major update.
+ * Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
+ * For more information, please refer to the migration guide:
+ * https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
+ */
 export const ChannelHeader = ({ className }: ChannelHeaderProps) => {
   const context = useChannelContext();
   return (

diff --git a/src/modules/Channel/components/ChannelUI/index.tsx b/src/modules/Channel/components/ChannelUI/index.tsx
@@ -18,6 +18,12 @@ export interface ChannelUIProps extends GroupChannelUIBasicProps {
   renderMessage?: GroupChannelUIBasicProps['renderMessage'];
 }
 
+/**
+ * @deprecated This component is deprecated and will be removed in the next major update.
+ * Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
+ * For more information, please refer to the migration guide:
+ * https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
+ */
 const ChannelUI = (props: ChannelUIProps) => {
   const context = useChannelContext();
   const { channelUrl, isInvalid } = context;

diff --git a/src/modules/Channel/components/FileViewer/index.tsx b/src/modules/Channel/components/FileViewer/index.tsx
@@ -8,6 +8,12 @@ export interface FileViewerProps {
   message: FileMessage;
 }
 
+/**
+ * @deprecated This component is deprecated and will be removed in the next major update.
+ * Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
+ * For more information, please refer to the migration guide:
+ * https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
+ */
 export const FileViewer = (props: FileViewerProps) => {
   const { deleteMessage } = useChannelContext();
   return <FileViewerView {...props} deleteMessage={deleteMessage} />;

diff --git a/src/modules/Channel/components/Message/index.tsx b/src/modules/Channel/components/Message/index.tsx
@@ -8,6 +8,12 @@ import MessageView, { MessageProps } from '../../../GroupChannel/components/Mess
 import FileViewer from '../FileViewer';
 import RemoveMessageModal from '../RemoveMessageModal';
 
+/**
+ * @deprecated This component is deprecated and will be removed in the next major update.
+ * Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
+ * For more information, please refer to the migration guide:
+ * https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
+ */
 const Message = (props: MessageProps) => {
   const { config } = useSendbirdStateContext();
   const {

diff --git a/src/modules/Channel/components/MessageInputWrapper/index.tsx b/src/modules/Channel/components/MessageInputWrapper/index.tsx
@@ -12,6 +12,12 @@ export interface MessageInputWrapperProps {
   renderSendMessageIcon?: GroupChannelUIBasicProps['renderSendMessageIcon'];
 }
 
+/**
+ * @deprecated This component is deprecated and will be removed in the next major update.
+ * Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
+ * For more information, please refer to the migration guide:
+ * https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
+ */
 export const MessageInputWrapper = (props: MessageInputWrapperProps) => {
   const context = useChannelContext();
   const { quoteMessage, currentGroupChannel, sendMessage, sendFileMessage, sendVoiceMessage, sendMultipleFilesMessage } = context;

diff --git a/src/modules/Channel/components/MessageList/index.tsx b/src/modules/Channel/components/MessageList/index.tsx
@@ -35,6 +35,13 @@ export interface MessageListProps extends GroupChannelMessageListProps {
    * */
   renderMessage?: GroupChannelUIBasicProps['renderMessage'];
 }
+
+/**
+ * @deprecated This component is deprecated and will be removed in the next major update.
+ * Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
+ * For more information, please refer to the migration guide:
+ * https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
+ */
 export const MessageList = (props: MessageListProps) => {
   const { className = '' } = props;
   const {

diff --git a/src/modules/Channel/components/RemoveMessageModal/index.tsx b/src/modules/Channel/components/RemoveMessageModal/index.tsx
@@ -4,6 +4,12 @@ import RemoveMessageModalView, {
 } from '../../../GroupChannel/components/RemoveMessageModal/RemoveMessageModalView';
 import { useChannelContext } from '../../context/ChannelProvider';
 
+/**
+ * @deprecated This component is deprecated and will be removed in the next major update.
+ * Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
+ * For more information, please refer to the migration guide:
+ * https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
+ */
 const RemoveMessageModal = (props: RemoveMessageModalProps) => {
   const { deleteMessage } = useChannelContext();
   return <RemoveMessageModalView {...props} deleteMessage={deleteMessage} />;

diff --git a/src/modules/Channel/components/SuggestedMentionList/index.tsx b/src/modules/Channel/components/SuggestedMentionList/index.tsx
@@ -5,6 +5,12 @@ import { useChannelContext } from '../../context/ChannelProvider';
 
 export type SuggestedMentionListProps = Omit<SuggestedMentionListViewProps, 'currentChannel'>;
 
+/**
+ * @deprecated This component is deprecated and will be removed in the next major update.
+ * Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
+ * For more information, please refer to the migration guide:
+ * https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
+ */
 export const SuggestedMentionList = (props: SuggestedMentionListProps) => {
   const { currentGroupChannel } = useChannelContext();
   return (

diff --git a/src/modules/ChannelList/components/ChannelListUI/index.tsx b/src/modules/ChannelList/components/ChannelListUI/index.tsx
@@ -23,6 +23,12 @@ export interface ChannelListUIProps {
   renderPlaceHolderEmptyList?: (props: void) => React.ReactElement;
 }
 
+/**
+ * @deprecated This component is deprecated and will be removed in the next major update.
+ * Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
+ * For more information, please refer to the migration guide:
+ * https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
+ */
 const ChannelListUI: React.FC<ChannelListUIProps> = (props: ChannelListUIProps) => {
   const { renderHeader, renderChannelPreview, renderPlaceHolderError, renderPlaceHolderLoading, renderPlaceHolderEmptyList } = props;
 

diff --git a/src/modules/ChannelList/components/ChannelPreview/index.tsx b/src/modules/ChannelList/components/ChannelPreview/index.tsx
@@ -12,6 +12,12 @@ interface ChannelPreviewInterface extends GroupChannelListItemBasicProps {
   isActive?: boolean;
 }
 
+/**
+ * @deprecated This component is deprecated and will be removed in the next major update.
+ * Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
+ * For more information, please refer to the migration guide:
+ * https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
+ */
 const ChannelPreview = ({
   channel,
   isActive = false,