Skip to content

Commit cc20935

Browse files
Merge pull request #6681 from syncfusion-content/983717-Ug-docs-chatui-2
983717: Enhanced the blazor documentation for chat ui
2 parents 9216553 + 04d005c commit cc20935

File tree

3 files changed

+44
-45
lines changed

3 files changed

+44
-45
lines changed

blazor/chat-ui/footer.md

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

10-
# Footer in Blazor Chat UI component
10+
# Footer in the Blazor Chat Component
1111

12-
## Show or hide footer
12+
The Blazor Chat component includes a footer that serves as the primary user interaction area, typically containing the message input field and send button.
1313

14-
You can use [ShowFooter](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_ShowFooter) property to enable or disable the chat footer.
14+
## Show or hide the footer
15+
16+
The chat footer in the Blazor Chat UI component is displayed by default and includes the text input field along with the send button. Its visibility can be managed using the [ShowFooter](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_ShowFooter) and submission. This configuration is useful in scenarios such as read-only chat views or restricted interaction modes.
1517

1618
```cshtml
1719

blazor/chat-ui/getting-started-webapp.md

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

10-
# Getting Started with Blazor Chat UI in Blazor Web App
10+
# Getting Started with Blazor Chat UI in a Blazor Web App
1111

12-
This section briefly explains about how to include [Blazor Chat UI](https://www.syncfusion.com/blazor-components/blazor-chat-ui) component in your Blazor Web App using [Visual Studio](https://visualstudio.microsoft.com/vs/) and Visual Studio Code.
12+
This section explains how to add the [Blazor Chat UI](https://www.syncfusion.com/blazor-components/blazor-chat-ui) component to your Blazor Web App using [Visual Studio](https://visualstudio.microsoft.com/vs/) or Visual Studio Code.
1313

14-
To get started quickly with Blazor Chat UI component, check on the following video:
14+
To get started quickly with the Blazor Chat UI component, refer to the following video guide:
1515

1616
{% youtube
1717
"youtube:https://www.youtube.com/watch?v=jNeuk12Kurw" %}
@@ -24,19 +24,19 @@ To get started quickly with Blazor Chat UI component, check on the following vid
2424

2525
* [System requirements for Blazor components](https://blazor.syncfusion.com/documentation/system-requirements)
2626

27-
## Create a new Blazor Web App in Visual Studio
27+
## Create a New Blazor Web App in Visual Studio
2828

29-
You can create a **Blazor Web App** using Visual Studio 2022 via [Microsoft Templates](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=vs) or the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Extension](https://blazor.syncfusion.com/documentation/visual-studio-integration/template-studio).
29+
A **Blazor Web App** can be created using Visual Studio 2022 with either the official [Microsoft Templates](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=vs) or the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Extension](https://blazor.syncfusion.com/documentation/visual-studio-integration/template-studio).
3030

31-
You need to configure the corresponding [Interactive render mode](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes?view=aspnetcore-8.0#render-modes) and [Interactivity location](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=vs) while creating a Blazor Web Application.
31+
Ensure you configure the appropriate [Interactive render mode](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes?view=aspnetcore-8.0#render-modes) and [Interactivity location](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=vs) when creating the Blazor Web Application.
3232

3333
## Install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor InteractiveChat and Themes NuGet in the App
3434

35-
To add **Blazor Chat UI** component in the app, open the NuGet package manager in Visual Studio (*Tools → NuGet Package Manager → Manage NuGet Packages for Solution*), search and install `Syncfusion.Blazor.InteractiveChat` and [Syncfusion.Blazor.Themes](https://www.nuget.org/packages/Syncfusion.Blazor.Themes/).
35+
To add the **Blazor Chat UI** component to your app, open the NuGet package manager in Visual Studio (*Tools → NuGet Package Manager → Manage NuGet Packages for Solution*), then search for and install `Syncfusion.Blazor.InteractiveChat` and [Syncfusion.Blazor.Themes](https://www.nuget.org/packages/Syncfusion.Blazor.Themes/).
3636

3737
If you utilize `WebAssembly or Auto` render modes in the Blazor Web App need to be install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components NuGet packages within the client project.
3838

39-
Alternatively, you can utilize the following package manager command to achieve the same.
39+
Alternatively, the required packages can be installed using the Package Manager Console commands.
4040

4141
{% tabs %}
4242
{% highlight C# tabtitle="Package Manager" %}
@@ -47,7 +47,7 @@ Install-Package Syncfusion.Blazor.Themes -Version {{ site.releaseversion }}
4747
{% endhighlight %}
4848
{% endtabs %}
4949

50-
N> Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components are available in [nuget.org](https://www.nuget.org/packages?q=syncfusion.blazor). Refer to [NuGet packages](https://blazor.syncfusion.com/documentation/nuget-packages) topic for available NuGet packages list with component details.
50+
N> Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components are available at [nuget.org](https://www.nuget.org/packages?q=syncfusion.blazor). Refer to the [NuGet packages](https://blazor.syncfusion.com/documentation/nuget-packages) documentation for a complete list of available packages.
5151

5252
{% endtabcontent %}
5353

@@ -57,13 +57,13 @@ N> Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components are availa
5757

5858
* [System requirements for Blazor components](https://blazor.syncfusion.com/documentation/system-requirements)
5959

60-
## Create a new Blazor Web App in Visual Studio Code
60+
## Create a New Blazor Web App in Visual Studio Code
6161

62-
You can create a **Blazor Web App** using Visual Studio Code via [Microsoft Templates](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=vsc) or the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Extension](https://blazor.syncfusion.com/documentation/visual-studio-code-integration/create-project).
62+
A **Blazor Web App** can be created using Visual Studio code with either the official [Microsoft Templates](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=vsc) or the [Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Extension](https://blazor.syncfusion.com/documentation/visual-studio-code-integration/create-project).
6363

64-
You need to configure the corresponding [Interactive render mode](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes?view=aspnetcore-8.0#render-modes) and [Interactivity location](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=vsc) while creating a Blazor Web Application.
64+
To ensure proper functionality of a Blazor Web App, configure the appropriate [Interactive render mode](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/render-modes?view=aspnetcore-8.0#render-modes) and [Interactivity location](https://learn.microsoft.com/en-us/aspnet/core/blazor/tooling?view=aspnetcore-8.0&pivots=vsc) during application setup.
6565

66-
For example, in a Blazor Web App with the `Auto` interactive render mode, use the following commands.
66+
For example, to create a Blazor Web App with `Auto` interactive render mode, use the following commands:
6767

6868
{% tabs %}
6969
{% highlight c# tabtitle="Blazor Web App" %}
@@ -97,20 +97,18 @@ dotnet restore
9797

9898
{% endtabs %}
9999

100-
N> Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components are available in [nuget.org](https://www.nuget.org/packages?q=syncfusion.blazor). Refer to [NuGet packages](https://blazor.syncfusion.com/documentation/nuget-packages) topic for available NuGet packages list with component details.
100+
N> Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components are available at [nuget.org](https://www.nuget.org/packages?q=syncfusion.blazor). Refer to the [NuGet packages](https://blazor.syncfusion.com/documentation/nuget-packages) documentation for a complete list of available packages.
101101

102102
{% endtabcontent %}
103103

104104
{% endtabcontents %}
105105

106106
## Register Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Service
107107

108-
| Interactive Render Mode | Description |
109-
| -- | -- |
110-
| WebAssembly or Auto | Open **~/_Imports.razor** file from the client project.|
111-
| Server | Open **~/_import.razor** file, which is located in the `Components` folder.|
108+
First, import the `Syncfusion.Blazor` and `Syncfusion.Blazor.InteractiveChat` namespace.
112109

113-
Import the `Syncfusion.Blazor` and `Syncfusion.Blazor.InteractiveChat` namespace.
110+
* **WebAssembly or Auto Mode**: Open the `~/_Imports.razor` file from the `.Client` project.
111+
* **Server Mode**: Open the `~/_Imports.razor` file located in the main project's `Components` folder.
114112

115113
{% tabs %}
116114
{% highlight C# tabtitle="~/_Imports.razor" %}
@@ -121,9 +119,9 @@ Import the `Syncfusion.Blazor` and `Syncfusion.Blazor.InteractiveChat` namespace
121119
{% endhighlight %}
122120
{% endtabs %}
123121

124-
Now, register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Service in the **~/Program.cs** file of your Blazor Web App.
122+
Next, register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor service in your **~/Program.cs** file.
125123

126-
If the **Interactive Render Mode** is set to `WebAssembly` or `Auto`, you need to register the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor service in both **~/Program.cs** files of your Blazor Web App.
124+
If the **Interactive Render Mode** is set to `WebAssembly` or `Auto`, the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor service must be registered in both **~/Program.cs** files of the Blazor Web App.
127125

128126
{% tabs %}
129127
{% highlight c# tabtitle="Server(~/_Program.cs)" hl_lines="3 11" %}
@@ -178,7 +176,7 @@ var app = builder.Build();
178176
{% endhighlight %}
179177
{% endtabs %}
180178

181-
## Add stylesheet and script resources
179+
## Add Stylesheet and Script Resources
182180

183181
The theme stylesheet and script can be accessed from NuGet through [Static Web Assets](https://blazor.syncfusion.com/documentation/appearance/themes#static-web-assets). Include the stylesheet reference in the `<head>` section and the script reference at the end of the `<body>` in the **~/Components/App.razor** file as shown below:
184182

@@ -196,18 +194,17 @@ The theme stylesheet and script can be accessed from NuGet through [Static Web A
196194

197195
N> Check out the [Blazor Themes](https://blazor.syncfusion.com/documentation/appearance/themes) topic to discover various methods ([Static Web Assets](https://blazor.syncfusion.com/documentation/appearance/themes#static-web-assets), [CDN](https://blazor.syncfusion.com/documentation/appearance/themes#cdn-reference), and [CRG](https://blazor.syncfusion.com/documentation/common/custom-resource-generator)) for referencing themes in your Blazor application. Also, check out the [Adding Script Reference](https://blazor.syncfusion.com/documentation/common/adding-script-references) topic to learn different approaches for adding script references in your Blazor application.
198196

199-
## Add Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Chat UI component
197+
## Add Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Chat UI Component
200198

201199
Add the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Chat UI component in the **~Pages/.razor** file. If an interactivity location as `Per page/component` in the web app, define a render mode at the top of the `~Pages/.razor` component, as follows:
202200

203-
| Interactivity location | RenderMode | Code |
201+
| Interactivity Location | Render Mode | Code Example |
204202
| --- | --- | --- |
205-
| Per page/component | Auto | @rendermode InteractiveAuto |
206-
| | WebAssembly | @rendermode InteractiveWebAssembly |
207-
| | Server | @rendermode InteractiveServer |
208-
| | None | --- |
203+
| Per page/component | Auto | `@rendermode InteractiveAuto` |
204+
| | WebAssembly | `@rendermode InteractiveWebAssembly` |
205+
| | Server | `@rendermode InteractiveServer` |
209206

210-
N> If an **Interactivity Location** is set to `Global` and the **Render Mode** is set to `Auto` or `WebAssembly` or `Server`, the render mode is configured in the `App.razor` file by default.
207+
N> If the **Interactivity Location** is set to `Global`, the **Render Mode** is configured globally in the `App.razor` file and does not need to be specified on each component.
211208

212209
{% tabs %}
213210
{% highlight razor %}
@@ -230,13 +227,13 @@ N> If an **Interactivity Location** is set to `Global` and the **Render Mode** i
230227

231228
{% previewsample "https://blazorplayground.syncfusion.com/embed/VDBfMLiHUEAVqRkp?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
232229

233-
* Press <kbd>Ctrl</kbd>+<kbd>F5</kbd> (Windows) or <kbd>⌘</kbd>+<kbd>F5</kbd> (macOS) to launch the application. This will render the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Chat UI component in your default web browser.
230+
Press <kbd>Ctrl</kbd>+<kbd>F5</kbd> (Windows) or <kbd>⌘</kbd>+<kbd>F5</kbd> (macOS) to launch the application. The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Chat UI component will be rendered in your browser.
234231

235232
![Blazor Chat UI Component](./images/chat-ui-component.png)
236233

237-
## Configure messages and user
234+
## Configure Messages and User
238235

239-
You can use the [Messages](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_Messages) property to add messages and the [User](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_User) property to configure the current user for the chat.
236+
Use the [Messages](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_Messages) property to populate the chat with an initial set of messages and the [User](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfChatUI.html#Syncfusion_Blazor_InteractiveChat_SfChatUI_User) property to define the current user.
240237

241238
{% tabs %}
242239
{% highlight razor %}

blazor/chat-ui/getting-started.md

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

1010
# Getting Started with Blazor Chat UI Component
1111

12-
This section briefly explains about how to include [Blazor Chat UI](https://www.syncfusion.com/blazor-components/blazor-chat-ui) component in your Blazor WebAssembly App using Visual Studio and Visual Studio Code.
12+
This section explains how to add the [Blazor Chat UI](https://www.syncfusion.com/blazor-components/blazor-chat-ui) component to a Blazor WebAssembly App using Visual Studio and Visual Studio Code.
1313

1414
{% tabcontents %}
1515

@@ -25,7 +25,7 @@ You can create a **Blazor WebAssembly App** using Visual Studio via [Microsoft T
2525

2626
## Install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor InteractiveChat and Themes NuGet in the App
2727

28-
To add **Blazor Chat UI** component in the app, open the NuGet package manager in Visual Studio (*Tools → NuGet Package Manager → Manage NuGet Packages for Solution*), search and install `Syncfusion.Blazor.InteractiveChat` and [Syncfusion.Blazor.Themes](https://www.nuget.org/packages/Syncfusion.Blazor.Themes/). Alternatively, you can utilize the following package manager command to achieve the same.
28+
To add the **Blazor Chat UI** component to the application, open the NuGet Package Manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for and install `Syncfusion.Blazor.InteractiveChat` and [Syncfusion.Blazor.Themes](https://www.nuget.org/packages/Syncfusion.Blazor.Themes/). Alternatively, the required packages can be installed using the Package Manager Console command.
2929

3030
{% tabs %}
3131
{% highlight C# tabtitle="Package Manager" %}
@@ -36,7 +36,7 @@ Install-Package Syncfusion.Blazor.Themes -Version {{ site.releaseversion }}
3636
{% endhighlight %}
3737
{% endtabs %}
3838

39-
N> Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components are available in [nuget.org](https://www.nuget.org/packages?q=syncfusion.blazor). Refer to [NuGet packages](https://blazor.syncfusion.com/documentation/nuget-packages) topic for available NuGet packages list with component details.
39+
N> Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components are available on [nuget.org](https://www.nuget.org/packages?q=syncfusion.blazor). Refer to the [NuGet packages](https://blazor.syncfusion.com/documentation/nuget-packages) topic for a complete list of available packages with component details.
4040

4141
{% endtabcontent %}
4242

@@ -65,9 +65,9 @@ cd BlazorApp
6565

6666
## Install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor InteractiveChat and Themes NuGet in the App
6767

68-
* Press <kbd>Ctrl</kbd>+<kbd>`</kbd> to open the integrated terminal in Visual Studio Code.
69-
* Ensure you’re in the project root directory where your `.csproj` file is located.
70-
* Run the following command to install a [Syncfusion.Blazor.InteractiveChat](https://www.nuget.org/packages/Syncfusion.Blazor.InteractiveChat) and [Syncfusion.Blazor.Themes](https://www.nuget.org/packages/Syncfusion.Blazor.Themes/) NuGet package and ensure all dependencies are installed.
68+
* Press <kbd>Ctrl</kbd>+<kbd>`</kbd> to open the integrated terminal in Visual Studio Code.
69+
* Ensure the current working directory is set to the project root where the `.csproj` file is located.
70+
* Run the following command to install the [Syncfusion.Blazor.InteractiveChat](https://www.nuget.org/packages/Syncfusion.Blazor.InteractiveChat) and [Syncfusion.Blazor.Themes](https://www.nuget.org/packages/Syncfusion.Blazor.Themes/) NuGet packages.
7171

7272
{% tabs %}
7373

@@ -81,15 +81,15 @@ dotnet restore
8181

8282
{% endtabs %}
8383

84-
N> Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components are available in [nuget.org](https://www.nuget.org/packages?q=syncfusion.blazor). Refer to [NuGet packages](https://blazor.syncfusion.com/documentation/nuget-packages) topic for available NuGet packages list with component details.
84+
N> Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components are available on [nuget.org](https://www.nuget.org/packages?q=syncfusion.blazor). Refer to the [NuGet packages](https://blazor.syncfusion.com/documentation/nuget-packages) topic for a complete list of available packages with component details.
8585

8686
{% endtabcontent %}
8787

8888
{% endtabcontents %}
8989

9090
## Register Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Service
9191

92-
Open **~/_Imports.razor** file and import the `Syncfusion.Blazor` and `Syncfusion.Blazor.InteractiveChat` namespace.
92+
Open the **~/_Imports.razor** file and import the `Syncfusion.Blazor` and `Syncfusion.Blazor.InteractiveChat` namespaces.
9393

9494
{% tabs %}
9595
{% highlight razor tabtitle="~/_Imports.razor" %}
@@ -137,7 +137,7 @@ N> Check out the [Blazor Themes](https://blazor.syncfusion.com/documentation/app
137137

138138
## Add Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Chat UI component
139139

140-
Add the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Chat UI component in the **~/Pages/Index.razor** file.
140+
Add the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Chat UI component to the **~/Pages/Index.razor** file.
141141

142142
{% tabs %}
143143
{% highlight razor %}
@@ -149,7 +149,7 @@ Add the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Chat UI componen
149149
{% endhighlight %}
150150
{% endtabs %}
151151

152-
* Press <kbd>Ctrl</kbd>+<kbd>F5</kbd> (Windows) or <kbd>⌘</kbd>+<kbd>F5</kbd> (macOS) to launch the application. This will render the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Chat UI component in your default web browser.
152+
* Press <kbd>Ctrl</kbd>+<kbd>F5</kbd> (Windows) or <kbd>⌘</kbd>+<kbd>F5</kbd> (macOS) to launch the application. This will render the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Chat UI component in your default web browser.
153153

154154
{% previewsample "https://blazorplayground.syncfusion.com/embed/VDBfMLiHUEAVqRkp?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
155155

0 commit comments

Comments
 (0)