Skip to content

Commit 4073413

Browse files
Integrated latest changes at 12-17-2024 4:31:26 PM
1 parent caae995 commit 4073413

23 files changed

+515
-43
lines changed

ej2-react-toc.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -546,6 +546,7 @@
546546
<li><a href="/ej2-react/chat-ui/accessibility">Accessibility</a></li>
547547
<li><a href="/ej2-react/chat-ui/methods">Methods</a></li>
548548
<li><a href="/ej2-react/chat-ui/events">Events</a></li>
549+
<li><a href="https://ej2.syncfusion.com/react/documentation/api/chat-ui">API Reference</a></li>
549550
</ul>
550551
</li><li>
551552
Check box

ej2-react/chat-ui/appearance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ domainurl: ##DomainURL##
1212

1313
## Setting placeholder
1414

15-
You can use the `placeholder` property to display the placeholder text that appears in the message input field to guide users on what to type. The default is `Type your message…`.
15+
You can use the [placeholder](../api/chat-ui#placeholder) property to display the placeholder text that appears in the message input field to guide users on what to type. The default is `Type your message…`.
1616

1717
{% tabs %}
1818
{% highlight js tabtitle="index.jsx" %}
@@ -27,7 +27,7 @@ You can use the `placeholder` property to display the placeholder text that appe
2727

2828
## Setting width
2929

30-
You can use the `width` property to specify the dimensions of the Chat UI within the application layout. By default, the value is `100%`.
30+
You can use the [width](../api/chat-ui#width) property to specify the dimensions of the Chat UI within the application layout. By default, the value is `100%`.
3131

3232
{% tabs %}
3333
{% highlight js tabtitle="index.jsx" %}
@@ -42,7 +42,7 @@ You can use the `width` property to specify the dimensions of the Chat UI within
4242

4343
## Setting height
4444

45-
You can use the `height` property to specify the dimensions of the Chat UI within the application layout. By default, the value is `100%`.
45+
You can use the [height](../api/chat-ui#height) property to specify the dimensions of the Chat UI within the application layout. By default, the value is `100%`.
4646

4747
{% tabs %}
4848
{% highlight js tabtitle="index.jsx" %}
@@ -57,7 +57,7 @@ You can use the `height` property to specify the dimensions of the Chat UI withi
5757

5858
## CSS Class
5959

60-
You can use the `cssClass` property to customize the appearance of the chat UI component.
60+
You can use the [cssClass](../api/chat-ui#cssclass) property to customize the appearance of the chat UI component.
6161

6262
{% tabs %}
6363
{% highlight js tabtitle="index.jsx" %}

ej2-react/chat-ui/events.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This section describes the Chat UI events that will be triggered when appropriat
1414

1515
## Created
1616

17-
The Chat UI component triggers the `created` event when the component rendering is completed.
17+
The Chat UI component triggers the [created](../api/chat-ui#created) event when the component rendering is completed.
1818

1919
{% tabs %}
2020
{% highlight js tabtitle="index.jsx" %}
@@ -27,7 +27,7 @@ The Chat UI component triggers the `created` event when the component rendering
2727

2828
## Sending message
2929

30-
The `messageSend` event is triggered before sending a message in the Chat UI component.
30+
The [messageSend](../api/chat-ui#messagesend) event is triggered before sending a message in the Chat UI component.
3131

3232
{% tabs %}
3333
{% highlight js tabtitle="index.jsx" %}
@@ -40,7 +40,7 @@ The `messageSend` event is triggered before sending a message in the Chat UI com
4040

4141
## User typing
4242

43-
The `userTyping` event is triggered when the user is typing a message in the Chat UI component.
43+
The [userTyping](../api/chat-ui#usertyping) event is triggered when the user is typing a message in the Chat UI component.
4444

4545
{% tabs %}
4646
{% highlight js tabtitle="index.jsx" %}

ej2-react/chat-ui/footer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ domainurl: ##DomainURL##
1212

1313
## Show or hide footer
1414

15-
You can use showFooter property to enable or disable the chat footer.
15+
You can use [showFooter](../api/chat-ui#showfooter) property to enable or disable the chat footer.
1616

1717
{% tabs %}
1818
{% highlight js tabtitle="index.jsx" %}

ej2-react/chat-ui/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ npm start
145145

146146
## Configure messages and user
147147

148-
You can use the `MessagesDirective` tag to group all the messages and `MessageDirective` tag to define each message and the `user` property to configure the current user for the chat.
148+
You can use the `MessagesDirective` tag to group all the messages and `MessageDirective` tag to define each message and the [user](../api/chat-ui#user) property to configure the current user for the chat.
149149

150150
{% tabs %}
151151
{% highlight js tabtitle="index.jsx" %}

ej2-react/chat-ui/globalization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The Chat UI can be localized to any culture by defining the text of the Chat UI
3434

3535
## RTL
3636

37-
RTL provides an option to switch the text direction and layout of the Chat UI component from right to left by setting the `enableRtl` property to `true`.
37+
RTL provides an option to switch the text direction and layout of the Chat UI component from right to left by setting the [enableRtl](../api/chat-ui#enablertl) property to `true`.
3838

3939
{% tabs %}
4040
{% highlight js tabtitle="index.jsx" %}

ej2-react/chat-ui/header.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ domainurl: ##DomainURL##
1212

1313
## Show or hide header
1414

15-
You can use `showHeader` property to enable or disable the chat header. It contains the following options `headerText` and `headerIconCss`.
15+
You can use [showHeader](../api/chat-ui#showheader) property to enable or disable the chat header. It contains the following options `headerText` and `headerIconCss`.
1616

1717
{% tabs %}
1818
{% highlight js tabtitle="index.jsx" %}
@@ -27,7 +27,7 @@ You can use `showHeader` property to enable or disable the chat header. It conta
2727

2828
### Setting header text
2929

30-
You can use the `headerText` property to display the text that appears in the header, which indicates the current username or the group name providing the context for the conversation.
30+
You can use the [headerText](../api/chat-ui#headertext) property to display the text that appears in the header, which indicates the current username or the group name providing the context for the conversation.
3131

3232
{% tabs %}
3333
{% highlight js tabtitle="index.jsx" %}
@@ -42,7 +42,7 @@ You can use the `headerText` property to display the text that appears in the he
4242

4343
### Setting header icon CSS
4444

45-
You can use the `headerIconCss` property to customize the styling of the header icon.
45+
You can use the [headerIconCss](../api/chat-ui#headericoncss) property to customize the styling of the header icon.
4646

4747
{% tabs %}
4848
{% highlight js tabtitle="index.jsx" %}
@@ -57,7 +57,7 @@ You can use the `headerIconCss` property to customize the styling of the header
5757

5858
## Toolbar
5959

60-
You can render the Chat UI toolbar items by using theitemsproperty in theheaderToolbar.
60+
You can render the Chat UI toolbar items by using the items property in the [headerToolbar](../api/chat-ui#headertoolbar).
6161

6262
### Setting items
6363

ej2-react/chat-ui/load-on-demand.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ domainurl: ##DomainURL##
1010

1111
# Load on-demand in React Chat UI component
1212

13-
You can use the `loadOnDemand` property to load messages dynamically when the scroll reaches the top of the message list improving performance and reducing load times, particularly in long conversations. This ensures a smooth user experience by only fetching messages as needed rather than loading the entire conversation at once.
13+
You can use the [loadOnDemand](../api/chat-ui#loadondemand) property to load messages dynamically when the scroll reaches the top of the message list improving performance and reducing load times, particularly in long conversations. This ensures a smooth user experience by only fetching messages as needed rather than loading the entire conversation at once.
1414

1515
{% tabs %}
1616
{% highlight js tabtitle="index.jsx" %}

ej2-react/chat-ui/messages.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The Chat UI allows to add messages using the `MessagesDirective` tag. The mess
1414

1515
## Configure messages
1616

17-
You can use the `text` property to add message content for the user. Each message can be configured with options such as id, text, author, timestamp, and more.
17+
You can use the [text](../api/chat-ui/messageModel/#text) property to add message content for the user. Each message can be configured with options such as id, text, author, timestamp, and more.
1818

1919
{% tabs %}
2020
{% highlight js tabtitle="index.jsx" %}
@@ -29,9 +29,9 @@ You can use the `text` property to add message content for the user. Each messa
2929

3030
### Define current user
3131

32-
You can use the `author` property to identify the current user of the chat. Each user can be configured with options such as id, user, avatarUrl, and more.
32+
You can use the [author](../api/chat-ui/messageModel/#author) property to identify the current user of the chat. Each user can be configured with options such as id, user, avatarUrl, and more.
3333

34-
> You can use the `user` property to display the user name and `id` property is necessary to differentiate between the multiple users.
34+
> You can use the [user](../api/chat-ui/userModel/#user) property to display the user name and [id](../api/chat-ui/userModel/#id) property is necessary to differentiate between the multiple users.
3535
3636
{% tabs %}
3737
{% highlight js tabtitle="index.jsx" %}
@@ -46,7 +46,7 @@ You can use the `author` property to identify the current user of the chat. Each
4646

4747
#### Setting avatar URL
4848

49-
You can use the `avatarUrl` property to define the image URL’s for the user avatar. If no URL is provided, fallback initials of the first and last name from the user’s name will be used.
49+
You can use the [avatarUrl](../api/chat-ui/userModel/#avatarurl) property to define the image URL’s for the user avatar. If no URL is provided, fallback initials of the first and last name from the user’s name will be used.
5050

5151
{% tabs %}
5252
{% highlight js tabtitle="index.jsx" %}
@@ -61,7 +61,7 @@ You can use the `avatarUrl` property to define the image URL’s for the user av
6161

6262
#### Setting avatar background color
6363

64-
You can use `avatarBgColor` property to set a specific background color for user avatars using hexadecimal values. If no color is set, a custom background color is set based on specified theme.
64+
You can use [avatarBgColor](../api/chat-ui/userModel/#avatarbgcolor) property to set a specific background color for user avatars using hexadecimal values. If no color is set, a custom background color is set based on specified theme.
6565

6666
{% tabs %}
6767
{% highlight js tabtitle="index.jsx" %}
@@ -76,7 +76,7 @@ You can use `avatarBgColor` property to set a specific background color for user
7676

7777
#### Setting CSS class
7878

79-
You can use the cssClass property to customize the appearance of the chat user.
79+
You can use the [cssClass](../api/chat-ui/userModel/#cssclass) property to customize the appearance of the chat user.
8080

8181
{% tabs %}
8282
{% highlight js tabtitle="index.jsx" %}
@@ -91,7 +91,7 @@ You can use the cssClass property to customize the appearance of the chat user.
9191

9292
## Define timestamp
9393

94-
You can use the `timeStamp` property to indicate the date and time of each message being sent. By default it is set to the current date and time when the message is sent.
94+
You can use the [timeStamp](../api/chat-ui/messageModel/#timestamp) property to indicate the date and time of each message being sent. By default it is set to the current date and time when the message is sent.
9595

9696
{% tabs %}
9797
{% highlight js tabtitle="index.jsx" %}
@@ -106,7 +106,7 @@ You can use the `timeStamp` property to indicate the date and time of each messa
106106

107107
### Setting timestamp format
108108

109-
You can use the `timeStampFormat` to display specific time format for the timestamp. The default format is `dd/MM/yyyy hh:mm a`, but this can be customized to meet different localization and display needs.
109+
You can use the [timeStampFormat](../api/chat-ui/messageModel/#timestampformat) to display specific time format for the timestamp. The default format is `dd/MM/yyyy hh:mm a`, but this can be customized to meet different localization and display needs.
110110

111111
{% tabs %}
112112
{% highlight js tabtitle="index.jsx" %}
@@ -121,11 +121,11 @@ You can use the `timeStampFormat` to display specific time format for the timest
121121

122122
## Define message status
123123

124-
You can use the `status` property to update the status for the message(e.g., sent, received, read). It helps in managing message delivery and read receipts within the chat interface.
124+
You can use the [status](../api/chat-ui/messageModel/#status) property to update the status for the message(e.g., sent, received, read). It helps in managing message delivery and read receipts within the chat interface.
125125

126126
### Setting icon CSS
127127

128-
You can use the `iconCss` property to update the styling of status icons associated with messages, aiding visual differentiation between statuses.
128+
You can use the [iconCss](../api/chat-ui/messageStatusModel/#iconcss) property to update the styling of status icons associated with messages, aiding visual differentiation between statuses.
129129

130130
{% tabs %}
131131
{% highlight js tabtitle="index.jsx" %}
@@ -140,7 +140,7 @@ You can use the `iconCss` property to update the styling of status icons associa
140140

141141
### Setting text
142142

143-
You can use the `text` property to provide information about the messages through descriptive text, providing users with the context of the message.
143+
You can use the [text](../api/chat-ui/messageStatusModel/#text) property to provide information about the messages through descriptive text, providing users with the context of the message.
144144

145145
{% tabs %}
146146
{% highlight js tabtitle="index.jsx" %}
@@ -155,7 +155,7 @@ You can use the `text` property to provide information about the messages throug
155155

156156
### Setting tooltip
157157

158-
You can use the `tooltip` property to provide information about the messages by tooltips while hovering the status icon, providing users with additional data upon hovering.
158+
You can use the [tooltip](../api/chat-ui/messageStatusModel/#tooltip) property to provide information about the messages by tooltips while hovering the status icon, providing users with additional data upon hovering.
159159

160160
{% tabs %}
161161
{% highlight js tabtitle="index.jsx" %}
@@ -170,7 +170,7 @@ You can use the `tooltip` property to provide information about the messages by
170170

171171
## Setting auto scroll
172172

173-
You can use the `autoScrollToBottom` property to automatically scroll the chats when a new message is received in a conversation. By default, the value is false, requires manual scrolling or the FAB button to quick access to the bottom of the view.
173+
You can use the [autoScrollToBottom](../api/chat-ui#autoscrolltobottom) property to automatically scroll the chats when a new message is received in a conversation. By default, the value is false, requires manual scrolling or the FAB button to quick access to the bottom of the view.
174174

175175
- By default, it scrolls to bottom for each message being sent or when the scroll is maintained at the bottom in the chat, in order to prevent the automatic scroll for different user messages you can use the `autoScrollToBottom` property.
176176

@@ -187,7 +187,7 @@ You can use the `autoScrollToBottom` property to automatically scroll the chats
187187

188188
## Setting suggestions
189189

190-
You can use the `suggestions` property, to add the suggestions in both initial and on-demand which help users to quick-reply options above the input field.
190+
You can use the [suggestions](../api/chat-ui#suggestions) property, to add the suggestions in both initial and on-demand which help users to quick-reply options above the input field.
191191

192192
{% tabs %}
193193
{% highlight js tabtitle="index.jsx" %}

ej2-react/chat-ui/methods.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ domainurl: ##DomainURL##
1212

1313
## Adding message
1414

15-
You can use the `addMessage` public method to add the messages in the Chat UI. You can add it either as a string or MessageModel collection. It programmatically adds a new message to the chat.
15+
You can use the [addMessage](../api/chat-ui#addmessage) public method to add the messages in the Chat UI. You can add it either as a string or MessageModel collection. It programmatically adds a new message to the chat.
1616

1717
{% tabs %}
1818
{% highlight js tabtitle="index.jsx" %}
@@ -38,7 +38,7 @@ You can use the `addMessage` public method to add the messages in the Chat UI. Y
3838

3939
## Edit message
4040

41-
You can use the `updateMessage` public method to update the messages in the ChatUI to modify an existing message within the chat, useful for editing or correcting sent messages.
41+
You can use the [updateMessage](../api/chat-ui#updatemessage) public method to update the messages in the ChatUI to modify an existing message within the chat, useful for editing or correcting sent messages.
4242

4343
{% tabs %}
4444
{% highlight js tabtitle="index.jsx" %}
@@ -53,7 +53,7 @@ You can use the `updateMessage` public method to update the messages in the Chat
5353

5454
## Scroll to bottom
5555

56-
You can use the `scrollToBottom` public method to scroll the chat view to the latest message, ensuring users see the new content updated.
56+
You can use the [scrollToBottom](../api/chat-ui#scrolltobottom) public method to scroll the chat view to the latest message, ensuring users see the new content updated.
5757

5858
{% tabs %}
5959
{% highlight js tabtitle="index.jsx" %}

0 commit comments

Comments
 (0)