Skip to content

docs(937286): Resolve the docs issues logged for our components. #3856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 6, 2025
Merged

docs(937286): Resolve the docs issues logged for our components. #3856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe27754
937286: Corrected the comp rendering
SenthilarasuBalu Feb 4, 2025
5b4159f
937286: sample correction
SenthilarasuBalu Feb 5, 2025
52d8c4e
937286: cs file mapping
SenthilarasuBalu Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ej2-asp-core-mvc/chat-ui/EJ2_ASP.MVC/header.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,14 +116,14 @@ You can use the `Visible` property to specify whether to show or hide the header

{% tabs %}
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/toolbarDisable/razor %}
{% include code-snippet/chat-ui/header/toolbarVisible/razor %}
{% endhighlight %}
{% highlight c# tabtitle="ToolbarDisable.cs" %}
{% include code-snippet/chat-ui/header/toolbarDisable/toolbarDisable.cs %}
{% highlight c# tabtitle="ToolbarVisible.cs" %}
{% include code-snippet/chat-ui/header/toolbarVisible/toolbarDisable.cs %}
{% endhighlight %}
{% endtabs %}

![ToolbarDisable](images/toolbar-disable.png)
![ToolbarDisable](images/toolbar-visible.png)

#### Setting disabled

Expand Down Expand Up @@ -178,7 +178,7 @@ In the following example, toolbar item type is set with `Right`.
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/toolbarIcon/razor %}
{% endhighlight %}
{% highlight c# tabtitle="ToolbarIcon.cs" %}
{% highlight c# tabtitle="ToolbarAlign.cs" %}
{% include code-snippet/chat-ui/header/toolbarIcon/toolbarIcon.cs %}
{% endhighlight %}
{% endtabs %}
Expand Down
12 changes: 12 additions & 0 deletions ej2-asp-core-mvc/chat-ui/EJ2_ASP.NETCORE/appearance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ You can use the [placeholder](https://help.syncfusion.com/cr/aspnetcore-js2/Sync
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/appearance/placeholder/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="Placeholder.cs" %}
{% include code-snippet/chat-ui/appearance/placeholder/placeholder.cs %}
{% endhighlight %}
{% endtabs %}

![Placeholder](images/placeholder.png)
Expand All @@ -30,6 +33,9 @@ You can use the [width](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusion
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/appearance/width/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="Width.cs" %}
{% include code-snippet/chat-ui/appearance/width/width.cs %}
{% endhighlight %}
{% endtabs %}

![Width](images/width.png)
Expand All @@ -42,6 +48,9 @@ You can use the [height](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusio
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/appearance/height/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="Height.cs" %}
{% include code-snippet/chat-ui/appearance/height/height.cs %}
{% endhighlight %}
{% endtabs %}

![Height](images/width.png)
Expand All @@ -54,6 +63,9 @@ You can customize the appearance of the Chat UI component by using the [cssClass
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/appearance/cssClass/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="Cssclass.cs" %}
{% include code-snippet/chat-ui/appearance/cssclass/cssclass.cs %}
{% endhighlight %}
{% endtabs %}

![Cssclass](images/cssclass.png)
9 changes: 9 additions & 0 deletions ej2-asp-core-mvc/chat-ui/EJ2_ASP.NETCORE/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ The Chat UI control triggers the [created](https://help.syncfusion.com/cr/aspnet
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/events/created/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="Created.cs" %}
{% include code-snippet/chat-ui/events/created/created.cs %}
{% endhighlight %}
{% endtabs %}

## Sending message
Expand All @@ -30,6 +33,9 @@ The [messageSend](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusion.EJ2.I
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/events/messageSend/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="MessageSend.cs" %}
{% include code-snippet/chat-ui/events/messageSend/messageSend.cs %}
{% endhighlight %}
{% endtabs %}

## User typing
Expand All @@ -40,4 +46,7 @@ The [userTyping](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusion.EJ2.In
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/events/userTyping/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="UserTyping.cs" %}
{% include code-snippet/chat-ui/events/userTyping/userTyping.cs %}
{% endhighlight %}
{% endtabs %}
3 changes: 3 additions & 0 deletions ej2-asp-core-mvc/chat-ui/EJ2_ASP.NETCORE/footer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ You can use [showFooter](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusio
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/footer/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="Footer.cs" %}
{% include code-snippet/chat-ui/footer/defaultMessages.cs %}
{% endhighlight %}
{% endtabs %}

![Footer](images/footer.png)
Expand Down
6 changes: 6 additions & 0 deletions ej2-asp-core-mvc/chat-ui/EJ2_ASP.NETCORE/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@ Now, add the Syncfusion ASP.NET Core Chat UI tag helper in `~/Pages/Index.cshtml
{% highlight cshtml tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/getting-started/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="Default.cs" %}
{% include code-snippet/chat-ui/getting-started/gettingstarted.cs %}
{% endhighlight %}
{% endtabs %}

Press <kbd>Ctrl</kbd>+<kbd>F5</kbd> (Windows) or <kbd>⌘</kbd>+<kbd>F5</kbd> (macOS) to run the app. Then, the Syncfusion ASP.NET Core Chat UI control will be rendered in the default web browser.
Expand All @@ -107,6 +110,9 @@ You can use the `<e-chatui-messages>` tag directive to group all the messages an
{% highlight cshtml tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/default-messages/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="Default.cs" %}
{% include code-snippet/chat-ui/default-messages/defaultMessages.cs %}
{% endhighlight %}
{% endtabs %}

![ASP.NET Core Chat UI default messages](images/default-messages.png)
6 changes: 6 additions & 0 deletions ej2-asp-core-mvc/chat-ui/EJ2_ASP.NETCORE/globalization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ The Chat UI can be localized to any culture by defining the text of the Chat UI
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/globalization/localization/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="Localization.cs" %}
{% include code-snippet/chat-ui/globalization/localization/timestamp.cs %}
{% endhighlight %}
{% endtabs %}

![Localization](images/localization.png)
Expand All @@ -37,6 +40,9 @@ RTL provides an option to switch the text direction and layout of the Chat UI co
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/globalization/rtl/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="Rtl.cs" %}
{% include code-snippet/chat-ui/globalization/rtl/defaultMessages.cs %}
{% endhighlight %}
{% endtabs %}

![RTL](images/rtl.png)
39 changes: 39 additions & 0 deletions ej2-asp-core-mvc/chat-ui/EJ2_ASP.NETCORE/header.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ You can use [showHeader](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusio
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/showHeader/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="ShowHeader.cs" %}
{% include code-snippet/chat-ui/header/showHeader/showHeader.cs %}
{% endhighlight %}
{% endtabs %}

![ShowHeader](images/show-header.png)
Expand All @@ -30,6 +33,9 @@ You can use the [headerText](https://help.syncfusion.com/cr/aspnetcore-js2/Syncf
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/headerText/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="HeaderText.cs" %}
{% include code-snippet/chat-ui/header/headerText/headerText.cs %}
{% endhighlight %}
{% endtabs %}

![HeaderText](images/header-text.png)
Expand All @@ -42,6 +48,9 @@ You can use the [headerIconCss](https://help.syncfusion.com/cr/aspnetcore-js2/Sy
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/headerIcon/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="HeaderIcon.cs" %}
{% include code-snippet/chat-ui/header/headerIcon/headerIcon.cs %}
{% endhighlight %}
{% endtabs %}

![HeaderIcon](images/header-icon.png)
Expand All @@ -62,6 +71,9 @@ You can customize the header toolbar icons by using the `iconCss` property.
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/toolbarIcon/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="ToolbarIcon.cs" %}
{% include code-snippet/chat-ui/header/toolbarIcon/toolbarIcon.cs %}
{% endhighlight %}
{% endtabs %}

![ToolbarIcon](images/toolbar-icon.png)
Expand All @@ -76,6 +88,9 @@ In the following example, header toolbar item type is set as `Button`.
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/toolbarType/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="ToolbarType.cs" %}
{% include code-snippet/chat-ui/header/toolbarType/toolbarType.cs %}
{% endhighlight %}
{% endtabs %}

![ToolbarType](images/toolbar-type.png)
Expand All @@ -88,6 +103,9 @@ You can use the `text` property to set the text for the header toolbar item.
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/toolbarText/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="ToolbarText.cs" %}
{% include code-snippet/chat-ui/header/toolbarText/toolbarText.cs %}
{% endhighlight %}
{% endtabs %}

![ToolbarText](images/toolbar-text.png)
Expand All @@ -100,6 +118,9 @@ You can use the `visible` property to specify whether to show or hide the header
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/toolbarVisible/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="ToolbarVisible.cs" %}
{% include code-snippet/chat-ui/header/toolbarVisible/toolbarDisable.cs %}
{% endhighlight %}
{% endtabs %}

![ToolbarVisible](images/toolbar-visible.png)
Expand All @@ -112,6 +133,9 @@ You can use the `disabled` property to disable the header toolbar item. By defau
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/toolbarDisable/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="ToolbarDisable.cs" %}
{% include code-snippet/chat-ui/header/toolbarDisable/toolbarDisable.cs %}
{% endhighlight %}
{% endtabs %}

![ToolbarDisable](images/toolbar-disable.png)
Expand All @@ -124,6 +148,9 @@ You can use the `tooltip` property to specify the tooltip text to be displayed o
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/toolbarTooltip/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="ToolbarTooltip.cs" %}
{% include code-snippet/chat-ui/header/toolbarTooltip/toolbarTooltip.cs %}
{% endhighlight %}
{% endtabs %}

#### Setting CSS Class
Expand All @@ -134,6 +161,9 @@ You can use the `cssClass` property to customize the header toolbar item.
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/toolbarCss/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="ToolbarCss.cs" %}
{% include code-snippet/chat-ui/header/toolbarCss/toolbarCss.cs %}
{% endhighlight %}
{% endtabs %}

![CssClass](images/toolbar-css.png)
Expand All @@ -148,6 +178,9 @@ In the following example, toolbar item type is set with `Right`.
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/toolbarIcon/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="ToolbarAlign.cs" %}
{% include code-snippet/chat-ui/header/toolbarIcon/toolbarIcon.cs %}
{% endhighlight %}
{% endtabs %}

![ToolbarIcon](images/toolbar-icon.png)
Expand Down Expand Up @@ -222,6 +255,9 @@ You can use the `template` property to add custom toolbar item in the Chat UI.
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/toolbarTemplate/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="ToolbarTemplate.cs" %}
{% include code-snippet/chat-ui/header/toolbarTemplate/toolbarTemplate.cs %}
{% endhighlight %}
{% endtabs %}

![ToolbarTemplate](images/toolbar-template.png)
Expand All @@ -234,4 +270,7 @@ The [itemClicked](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusion.EJ2.I
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/header/itemClicked/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="ItemClicked.cs" %}
{% include code-snippet/chat-ui/header/itemClicked/itemClicked.cs %}
{% endhighlight %}
{% endtabs %}
3 changes: 3 additions & 0 deletions ej2-asp-core-mvc/chat-ui/EJ2_ASP.NETCORE/load-on-demand.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ You can use the [loadOnDemand](https://help.syncfusion.com/cr/aspnetcore-js2/Syn
{% highlight razor tabtitle="CSHTML" %}
{% include code-snippet/chat-ui/loadOnDemand/tagHelper %}
{% endhighlight %}
{% highlight c# tabtitle="LoadOnDemand.cs" %}
{% include code-snippet/chat-ui/loadOnDemand/defaultMessages.cs %}
{% endhighlight %}
{% endtabs %}

![LoadOnDemand](images/loadOnDemand.png)
Loading