Skip to content

Commit 9216553

Browse files
Merge pull request #6682 from syncfusion-content/983717-Ug-docs-chatui-3
983717: Enhanced the blazor documentation for chat ui
2 parents 4ad0d2d + ee1fa7d commit 9216553

File tree

4 files changed

+37
-34
lines changed

4 files changed

+37
-34
lines changed

blazor/chat-ui/globalization.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,13 @@ documentation: ug
99

1010
# Globalization in Blazor Chat UI Component
1111

12+
The Syncfusion Blazor Chat component supports globalization features like `Localization` and `Right-to-Left (RTL)` alignment, enabling it to be adapted for different cultures and languages.
13+
1214
## Localization
1315

14-
`Blazor Chat UI` component can be localized. Refer to [Blazor Localization](https://blazor.syncfusion.com/documentation/common/localization) topic to localize Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components.
16+
The `Localization` feature allows for the translation of static text elements within the Chat component to a specific language.
17+
To localize the Chat UI component, refer to the guidance provided in the main [Blazor Localization](https://blazor.syncfusion.com/documentation/common/localization) topic to localize Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components.
1518

16-
## RTL
19+
## Right-to-Left (RTL)
1720

18-
RTL provides an option to switch the text direction and layout of the Chat UI component from right to left. Refer to [Blazor RTL](https://blazor.syncfusion.com/documentation/common/right-to-left) topic to provide RTL support for the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components.
21+
The Right-to-Left (RTL) feature reverses the component's layout and text direction to support languages that are read from right to left, such as Arabic or Hebrew. Refer to [Blazor RTL](https://blazor.syncfusion.com/documentation/common/right-to-left) topic to provide RTL support for the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components.

blazor/chat-ui/header.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ control: Chat UI
77
documentation: ug
88
---
99

10-
# Header in Blazor Chat UI component
10+
# Header in Blazor Chat UI Component
1111

1212
## Show or hide header
1313

14-
You can use [ShowHeader](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_ShowHeader) property to enable or disable the chat header. It contains the following options [HeaderText](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_HeaderText) and [HeaderIconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_HeaderIconCss).
14+
The [ShowHeader](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_ShowHeader) property allows you to control the visibility of the chat header. When enabled, the header can display text and an icon, which are configured using the [HeaderText](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_HeaderText) and [HeaderIconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_HeaderIconCss) properties, respectively.
1515

1616
```cshtml
1717
@@ -39,7 +39,7 @@ You can use [ShowHeader](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor
3939

4040
### Setting header text
4141

42-
You can use the [HeaderText](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_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.
42+
Use the [HeaderText](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_HeaderText) property to set the text that appears in the header. This typically displays the current username or group name to provide context for the conversation.
4343

4444
```cshtml
4545
@@ -67,7 +67,7 @@ You can use the [HeaderText](https://help.syncfusion.com/cr/blazor/Syncfusion.Bl
6767

6868
### Setting header icon CSS
6969

70-
You can use the [HeaderIconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_HeaderIconCss) property to customize the styling of the header icon.
70+
The [HeaderIconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_HeaderIconCss) property allows you to customize the styling of the header icon.allows customization of the header icon's styling in the Blazor Chat UI component by applying custom CSS classes.
7171

7272
```cshtml
7373
@@ -95,15 +95,15 @@ You can use the [HeaderIconCss](https://help.syncfusion.com/cr/blazor/Syncfusion
9595

9696
## Toolbar
9797

98-
You can render the Chat UI toolbar items by using the [HeaderToolbar](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbar.html), [HeaderToolbarItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html) tag directives.
98+
Items can be rendered in the Chat UI header's toolbar using the [HeaderToolbar](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbar.html) and [HeaderToolbarItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html) tag directives.
9999

100100
### Setting items
101101

102-
Items can be constructed with the following built-in command types or item template.
102+
Items can be configured using built-in command types or a custom item template, as detailed in the following sections.
103103

104104
#### Adding icon CSS
105105

106-
You can customize the header toolbar icons by using the [IconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_IconCss) property.
106+
Customize the header toolbar icons by using the [IconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_IconCss) property.
107107

108108
```cshtml
109109
@@ -137,9 +137,9 @@ You can customize the header toolbar icons by using the [IconCss](https://help.s
137137

138138
#### Setting item type
139139

140-
You can change the header toolbar item type by using the [Type](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_Type) property. The `Type` supports four types of items such as `Button`, `Separator`, `Spacer` and `Input`. By default, the type is `Button`.
140+
To change the header toolbar item type, use the [Type](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_Type) property. The `Type` property supports four item types: `Button`, `Separator`, `Spacer`, and `Input`. The default type is `Button`.
141141

142-
In the following example, header toolbar item type is set as `Button`.
142+
In the following example, a header toolbar item type is set to `Button`.
143143

144144
```cshtml
145145
@@ -173,7 +173,7 @@ In the following example, header toolbar item type is set as `Button`.
173173

174174
#### Setting text
175175

176-
You can use the [Text](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_Text) property to set the text for the header toolbar item.
176+
The [Text](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_Text) property sets the display text for a header toolbar item.
177177

178178
```cshtml
179179
@@ -207,7 +207,7 @@ You can use the [Text](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.I
207207

208208
#### Show or hide toolbar item
209209

210-
You can use the [Visible](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_Visible) property to specify whether to show or hide the header toolbar item. By default, its value is `true`.
210+
Use the [Visible](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_Visible) property to specify whether a header toolbar item is shown or hidden. Its default value is `true`.
211211

212212
```cshtml
213213
@@ -242,7 +242,7 @@ You can use the [Visible](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazo
242242

243243
#### Setting disabled
244244

245-
You can use the [Disabled](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_Disabled) property to disable the header toolbar item. By default, its value is `false`.
245+
The [Disabled](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_Disabled) property is used to disable a header toolbar item in the Blazor Chat UI component. Its default value is `false`.
246246

247247
```cshtml
248248
@@ -277,7 +277,7 @@ You can use the [Disabled](https://help.syncfusion.com/cr/blazor/Syncfusion.Blaz
277277

278278
#### Setting tooltip text
279279

280-
You can use the [Tooltip](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_Tooltip) property to specify the tooltip text to be displayed on hovering the header toolbar item.
280+
Use the [Tooltip](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_Tooltip) property to specify the tooltip text that displays when hovering over a header toolbar item.
281281

282282
```cshtml
283283
@@ -311,7 +311,7 @@ You can use the [Tooltip](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazo
311311

312312
#### Setting CSS Class
313313

314-
You can use the [CssClass](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_CssClass) property to customize the header toolbar item.
314+
The [CssClass](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_CssClass) property allows applying a custom CSS class to a header toolbar item for styling purposes.
315315

316316
```cshtml
317317
@@ -356,11 +356,11 @@ You can use the [CssClass](https://help.syncfusion.com/cr/blazor/Syncfusion.Blaz
356356

357357
#### Enabling tab key navigation in toolbar
358358

359-
You can use the [TabIndex](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_TabIndex) property of a header toolbar item to enable tab key navigation for the item. By default, the user can switch between items using the arrow keys, but the `TabIndex` property allows you to switch between items using the `Tab` and `Shift+Tab` keys as well.
359+
Set the [TabIndex](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_TabIndex) property of a header toolbar item to enable tab key navigation. By default, navigation between items is handled using arrow keys, but the TabIndex property allows switching between items using the `Tab` and `Shift+Tab` keys.
360360

361361
To use the `TabIndex` property, set it for each Toolbar item which you want to enable tab key navigation. The `TabIndex` property should be set to a positive integer value. A value of `0` or a negative value will disable tab key navigation for the item.
362362

363-
For example, to enable tab key navigation for two Toolbar items you can use the following code:
363+
To enable `Tab` key navigation for two toolbar items, use the following code:
364364

365365
```cshtml
366366
@@ -378,9 +378,9 @@ For example, to enable tab key navigation for two Toolbar items you can use the
378378
379379
```
380380

381-
With the above code, the user can switch between the two Toolbar items using the Tab and Shift+Tab keys, in addition to using the arrow keys. The items will be navigated in the order specified by the `TabIndex` values.
381+
With the above configuration, the user can switch between the two toolbar items using the `Tab` and `Shift+Tab` keys, and the items will be navigated in the order specified by their `TabIndex` values.
382382

383-
If you set the `TabIndex` value to 0 for all Toolbar items, tab key navigation will be based on the element order rather than the `TabIndex` values. For example:
383+
If the `TabIndex` is set to 0 for all toolbar items, tab key navigation will be based on the element order in the DOM.
384384

385385
```cshtml
386386
@@ -398,11 +398,11 @@ If you set the `TabIndex` value to 0 for all Toolbar items, tab key navigation w
398398
399399
```
400400

401-
In this case, the user can switch between the two Toolbar items using the Tab and Shift+Tab keys, and the items will be navigated in the order in which they appear in the DOM.
401+
In this case, the user can navigate between the two items using the `Tab` and `Shift+Tab` keys in the order they appear in the DOM.
402402

403403
#### Setting template
404404

405-
You can use the [Template](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_Template) tag directive to add custom header toolbar item in the Chat UI component. Template property can be given as the `HTML element` or `RenderFragment`.
405+
Use the [Template](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbarItem.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbarItem_Template) tag directive to render a custom component or HTML element as a header toolbar item. Template property can be given as the `HTML element` or `RenderFragment`.
406406

407407
```cshtml
408408
@@ -454,7 +454,7 @@ You can use the [Template](https://help.syncfusion.com/cr/blazor/Syncfusion.Blaz
454454

455455
### Item clicked
456456

457-
You can define [ItemClicked](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbar.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbar_ItemClicked) event in the [HeaderToolbar](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbar.html) tag directive which will be triggered when the header toolbar item is clicked.
457+
Define the [ItemClicked](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbar.html#Syncfusion_Blazor_InteractiveChat_HeaderToolbar_ItemClicked) event handle for the [HeaderToolbar](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.HeaderToolbar.html) tag directive which will be triggered when the header toolbar item is clicked.
458458

459459
```cshtml
460460
@@ -477,4 +477,4 @@ You can define [ItemClicked](https://help.syncfusion.com/cr/blazor/Syncfusion.Bl
477477
}
478478
}
479479
480-
```
480+
```

blazor/chat-ui/load-on-demand.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ control: Chat UI
77
documentation: ug
88
---
99

10-
# Load on-demand in Blazor Chat UI component
10+
# Load on-demand in Blazor Chat UI Component
1111

1212
You can use the [LoadOnDemand](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_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.
1313

blazor/chat-ui/mention.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ documentation: ug
99

1010
# Mention Integration in Blazor Chat UI component
1111

12-
The Syncfusion<sup style="font-size:70%">&reg;</sup> ChatUI allows users to mention others in messages using the `@` character, with an dropdown for selecting users. The following sections explain how to configure mentions
12+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Chat UI allows users to mention others in messages using the `@` character, which displays a dropdown for selecting users. The following sections explain how to configure mentions.
1313

1414
## Configure Mention Users
1515

16-
You can use the [MentionUsers](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_MentionUsers) property to define an array of users for the mention suggestion popup.
16+
Use the [MentionUsers](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_MentionUsers) property to define a list of users for the mention suggestion popup.
1717

1818
```cshtml
1919
@using Syncfusion.Blazor.InteractiveChat
@@ -46,7 +46,7 @@ You can use the [MentionUsers](https://help.syncfusion.com/cr/blazor/Syncfusion.
4646

4747
## Customize the Mention trigger character
4848

49-
You can use the [MentionChar](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_MentionChar) property to customize the character which triggers the mention popup. The default value is `@`.
49+
Use the [MentionChar](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_MentionChar) property to customize the character that triggers the mention popup. The default value is `@`.
5050

5151
```cshtml
5252
@@ -78,11 +78,11 @@ You can use the [MentionChar](https://help.syncfusion.com/cr/blazor/Syncfusion.B
7878

7979
![Blazor Chat UI MentionCharacter](./images/MentionCharacter.png)
8080

81-
## Predefine Mentions with messages
81+
## Predefined Mentions in Messages
8282

83-
You can use the [Text](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.ChatMessage.html#Syncfusion_Blazor_InteractiveChat_ChatMessage_Text) property in the [ChatMessage](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.ChatMessage.html#Syncfusion_Blazor_InteractiveChat_ChatMessage) to include predefined mentions in chat messages. The mentions field stores the selected users for each message.
83+
Use the [Text](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.ChatMessage.html#Syncfusion_Blazor_InteractiveChat_ChatMessage_Text) property in the [ChatMessage](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.ChatMessage.html#Syncfusion_Blazor_InteractiveChat_ChatMessage) to include predefined mentions in chat messages. The mentions logic maps placeholders like `{0}` and `{1}` to users listed in the message's `MentionUsers` property.
8484

85-
> The `MentionUsers` property in a message contains a list of users, mapped by their order where the placeholder {0} is replaced by the first user, {1} by the second, and so on, automatically generating mentions in the user interface. If a placeholder's index is negative or exceeds the bounds of the mentionUsers array (e.g., using {5} with only two users), the mapping for that placeholder fails, and the placeholder text itself (e.g., {5}) is displayed in the final message.
85+
> The `MentionUsers` property in a message contains a list of users, mapped by their order where `{0}` is replaced by the first user, `{1}` by the second, and so on. If a placeholder's index is out of bounds (e.g., using `{5}` with only two users), the placeholder text itself (e.g., `{5}`) is displayed.
8686
8787
```cshtml
8888
@@ -114,7 +114,7 @@ You can use the [Text](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.I
114114

115115
## Configure mentionSelect
116116

117-
You can use the [ValueSelecting](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_ValueSelecting) event which triggers when a user selects an item from the mention dropdown, providing access to the selected user’s details for custom handling.
117+
Use the [ValueSelecting](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_ValueSelecting) event to execute custom logic when a user is selected from the mention dropdown. The event provides access to the selected user’s details.
118118

119119
```cshtml
120120
@@ -141,4 +141,4 @@ You can use the [ValueSelecting](https://help.syncfusion.com/cr/blazor/Syncfusio
141141
}
142142
}
143143
144-
```
144+
```

0 commit comments

Comments
 (0)