Skip to content

Commit 4bf19ea

Browse files
authored
[CLNP-5460 ]Update samples/README to address prop change info (#1251)
Addresses https://sendbird.atlassian.net/browse/CLNP-5460
1 parent d01d225 commit 4bf19ea

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

samples/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Try your [message item on StackBlitz](https://stackblitz.com/edit/sendbird-uikit
100100
101101
### Message list params
102102

103-
The **queries.messageListParams** is an `instance` prop in the **channel** component which you can use to retrieve a list of messages by specifying the properties of `MessageListParams`.
103+
The **messageListQueryParams** is an `instance` prop in the `<GroupChannel/>` component which you can use to retrieve a list of messages by specifying the properties of `MessageListParams`.
104104

105105
Try your [message list params on StackBlitz](https://stackblitz.com/edit/sendbird-uikit-react-custom-message-list-params-aora77).
106106

@@ -123,7 +123,7 @@ const queryParams = useMemo(() => ({
123123

124124
### Message params
125125

126-
The **onBeforeSendUserMessage**, **onBeforeSendFileMessage**, and **onBeforeUpdateUserMessage** are `callback function` props in the **channel** component. The first two execute additional operations for a user message and a file message respectively; the corresponding modified messages are returned through the **text** and the **file** arguments respectively. The **onBeforeUpdateUserMessage** executes additional operations for a user message before updating it.
126+
The **onBeforeSendUserMessage**, **onBeforeSendFileMessage**, and **onBeforeUpdateUserMessage** are `callback function` props in the **<GroupChannel />** component. The first two execute additional operations for a user message and a file message respectively; the corresponding modified messages are returned through the **text** and the **file** arguments respectively. The **onBeforeUpdateUserMessage** executes additional operations for a user message before updating it.
127127

128128
Try your [message params on StackBlitz](https://stackblitz.com/edit/sendbird-uikit-react-custom-message-params-4yemw4)
129129

@@ -151,7 +151,7 @@ Find out more about `UserMessageCreateParams`, `UserMessageUpdateParams` and `Fi
151151

152152
### Chat header
153153

154-
The **renderChatHeader** is a `ReactElement` prop in the **channel** component which you can use to customize the header of `channel` by setting a function. This prop provides two arguments: **channel** and **user**. The channel refers to a `GroupChannel` object which is a collection of properties necessary to render the current channel view. The **user** refers to a `User` object which represents the current user.
154+
The **renderChatHeader** is a `ReactElement` prop in the **<GroupChannel />** component which you can use to customize the header of `channel` by setting a function. This prop provides two arguments: **channel** and **user**. The channel refers to a `GroupChannel` object which is a collection of properties necessary to render the current channel view. The **user** refers to a `User` object which represents the current user.
155155

156156
Try your [chat header on StackBlitz](https://stackblitz.com/edit/sendbird-uikit-react-custom-chat-header-xjewem)
157157

@@ -167,7 +167,7 @@ Try your [chat header on StackBlitz](https://stackblitz.com/edit/sendbird-uikit-
167167
168168
### Message input
169169

170-
The **renderMessageInput** is a `ReactElement` prop in the **Channel** component which allows you to customize the message input by setting a function. This prop provides three arguments: **channel**, **user**, and **disabled**. The **channel** refers to a `GroupChannel` object which is a collection of properties necessary to render the current channel view. The **user** refers to a `User` object which represents the current user. The **disabled** refers to whether to enable the message input box or not.
170+
The **renderMessageInput** is a `ReactElement` prop in the **<GroupChannel />** component which allows you to customize the message input by setting a function. This prop provides three arguments: **channel**, **user**, and **disabled**. The **channel** refers to a `GroupChannel` object which is a collection of properties necessary to render the current channel view. The **user** refers to a `User` object which represents the current user. The **disabled** refers to whether to enable the message input box or not.
171171

172172
Try your [message input on StackBlitz](https://stackblitz.com/edit/sendbird-uikit-react-custom-message-input-mnw6qv)
173173

@@ -183,7 +183,7 @@ Try your [message input on StackBlitz](https://stackblitz.com/edit/sendbird-uiki
183183
184184
### Channel preview item
185185

186-
The **renderChannelPreview** is a `ReactElement` prop in the **ChannelList** component which allows you to customize channel preview by setting a function. This prop provides two arguments: **channel** and **onLeaveChannel**. The **channel** refers to a `GroupChannel` object which is a collection of properties necessary to render the current channel view. The **onLeaveChannel** has a callback function as an argument which can be implemented with custom code for events related to the corresponding user action.
186+
The **renderChannelPreview** is a `ReactElement` prop in the **<GroupChannelList />** component which allows you to customize channel preview by setting a function. This prop provides two arguments: **channel** and **onLeaveChannel**. The **channel** refers to a `GroupChannel` object which is a collection of properties necessary to render the current channel view. The **onLeaveChannel** has a callback function as an argument which can be implemented with custom code for events related to the corresponding user action.
187187

188188
Try your [channel preview item on StackBlitz](https://stackblitz.com/edit/sendbird-uikit-react-custom-channel-preview-uekro8)
189189

@@ -210,7 +210,7 @@ const CustomizedChannelPreviewItem = (props) => {
210210

211211
### Channel list query
212212

213-
The **queries.channelListQuery** is an `instance` prop in the **ChannelList** component which filters channels by using its options.
213+
The **channelListQueryParams** is an `instance` prop in the **<GroupChannelList />** component which filters channels by using its options.
214214

215215
Try your [channel list query item on StackBlitz](https://stackblitz.com/edit/sendbird-uikit-react-custom-channel-list-queries-5ppaf9)
216216

0 commit comments

Comments
 (0)