Skip to content

Commit cdeb26e

Browse files
authored
[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
1 parent 63ed666 commit cdeb26e

File tree

10 files changed

+61
-0
lines changed

10 files changed

+61
-0
lines changed

src/modules/Channel/components/ChannelHeader/index.tsx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ export interface ChannelHeaderProps {
66
className?: string;
77
}
88

9+
/**
10+
* @deprecated This component is deprecated and will be removed in the next major update.
11+
* Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
12+
* For more information, please refer to the migration guide:
13+
* https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
14+
*/
915
export const ChannelHeader = ({ className }: ChannelHeaderProps) => {
1016
const context = useChannelContext();
1117
return (

src/modules/Channel/components/ChannelUI/index.tsx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ export interface ChannelUIProps extends GroupChannelUIBasicProps {
1818
renderMessage?: GroupChannelUIBasicProps['renderMessage'];
1919
}
2020

21+
/**
22+
* @deprecated This component is deprecated and will be removed in the next major update.
23+
* Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
24+
* For more information, please refer to the migration guide:
25+
* https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
26+
*/
2127
const ChannelUI = (props: ChannelUIProps) => {
2228
const context = useChannelContext();
2329
const { channelUrl, isInvalid } = context;

src/modules/Channel/components/FileViewer/index.tsx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ export interface FileViewerProps {
88
message: FileMessage;
99
}
1010

11+
/**
12+
* @deprecated This component is deprecated and will be removed in the next major update.
13+
* Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
14+
* For more information, please refer to the migration guide:
15+
* https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
16+
*/
1117
export const FileViewer = (props: FileViewerProps) => {
1218
const { deleteMessage } = useChannelContext();
1319
return <FileViewerView {...props} deleteMessage={deleteMessage} />;

src/modules/Channel/components/Message/index.tsx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ import MessageView, { MessageProps } from '../../../GroupChannel/components/Mess
88
import FileViewer from '../FileViewer';
99
import RemoveMessageModal from '../RemoveMessageModal';
1010

11+
/**
12+
* @deprecated This component is deprecated and will be removed in the next major update.
13+
* Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
14+
* For more information, please refer to the migration guide:
15+
* https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
16+
*/
1117
const Message = (props: MessageProps) => {
1218
const { config } = useSendbirdStateContext();
1319
const {

src/modules/Channel/components/MessageInputWrapper/index.tsx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ export interface MessageInputWrapperProps {
1212
renderSendMessageIcon?: GroupChannelUIBasicProps['renderSendMessageIcon'];
1313
}
1414

15+
/**
16+
* @deprecated This component is deprecated and will be removed in the next major update.
17+
* Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
18+
* For more information, please refer to the migration guide:
19+
* https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
20+
*/
1521
export const MessageInputWrapper = (props: MessageInputWrapperProps) => {
1622
const context = useChannelContext();
1723
const { quoteMessage, currentGroupChannel, sendMessage, sendFileMessage, sendVoiceMessage, sendMultipleFilesMessage } = context;

src/modules/Channel/components/MessageList/index.tsx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@ export interface MessageListProps extends GroupChannelMessageListProps {
3535
* */
3636
renderMessage?: GroupChannelUIBasicProps['renderMessage'];
3737
}
38+
39+
/**
40+
* @deprecated This component is deprecated and will be removed in the next major update.
41+
* Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
42+
* For more information, please refer to the migration guide:
43+
* https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
44+
*/
3845
export const MessageList = (props: MessageListProps) => {
3946
const { className = '' } = props;
4047
const {

src/modules/Channel/components/RemoveMessageModal/index.tsx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ import RemoveMessageModalView, {
44
} from '../../../GroupChannel/components/RemoveMessageModal/RemoveMessageModalView';
55
import { useChannelContext } from '../../context/ChannelProvider';
66

7+
/**
8+
* @deprecated This component is deprecated and will be removed in the next major update.
9+
* Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
10+
* For more information, please refer to the migration guide:
11+
* https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
12+
*/
713
const RemoveMessageModal = (props: RemoveMessageModalProps) => {
814
const { deleteMessage } = useChannelContext();
915
return <RemoveMessageModalView {...props} deleteMessage={deleteMessage} />;

src/modules/Channel/components/SuggestedMentionList/index.tsx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ import { useChannelContext } from '../../context/ChannelProvider';
55

66
export type SuggestedMentionListProps = Omit<SuggestedMentionListViewProps, 'currentChannel'>;
77

8+
/**
9+
* @deprecated This component is deprecated and will be removed in the next major update.
10+
* Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
11+
* For more information, please refer to the migration guide:
12+
* https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
13+
*/
814
export const SuggestedMentionList = (props: SuggestedMentionListProps) => {
915
const { currentGroupChannel } = useChannelContext();
1016
return (

src/modules/ChannelList/components/ChannelListUI/index.tsx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ export interface ChannelListUIProps {
2323
renderPlaceHolderEmptyList?: (props: void) => React.ReactElement;
2424
}
2525

26+
/**
27+
* @deprecated This component is deprecated and will be removed in the next major update.
28+
* Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
29+
* For more information, please refer to the migration guide:
30+
* https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
31+
*/
2632
const ChannelListUI: React.FC<ChannelListUIProps> = (props: ChannelListUIProps) => {
2733
const { renderHeader, renderChannelPreview, renderPlaceHolderError, renderPlaceHolderLoading, renderPlaceHolderEmptyList } = props;
2834

src/modules/ChannelList/components/ChannelPreview/index.tsx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ interface ChannelPreviewInterface extends GroupChannelListItemBasicProps {
1212
isActive?: boolean;
1313
}
1414

15+
/**
16+
* @deprecated This component is deprecated and will be removed in the next major update.
17+
* Please use the `GroupChannel` component from '@sendbird/uikit-react/GroupChannel' instead.
18+
* For more information, please refer to the migration guide:
19+
* https://docs.sendbird.com/docs/chat/uikit/v3/react/introduction/group-channel-migration-guide
20+
*/
1521
const ChannelPreview = ({
1622
channel,
1723
isActive = false,

0 commit comments

Comments
 (0)