Skip to content

Commit b186dc8

Browse files
Merge pull request #6665 from syncfusion-content/982891-Blazor-UG-Updation-2
982891: Updated the Blazor UG contents for Ai Assistview
2 parents 992367b + 1bd9297 commit b186dc8

File tree

3 files changed

+22
-20
lines changed

3 files changed

+22
-20
lines changed

blazor/ai-assistview/accessibility.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ control: AI AssistView
77
documentation: ug
88
---
99

10-
# Accessibility in Blazor AI AssistView component
10+
# Accessibility in the Blazor AI AssistView component
1111

12-
The Blazor AI AssistView component followed the accessibility guidelines and standards, including [ADA](https://www.ada.gov/), [Section 508](https://www.section508.gov/), [WCAG 2.2](https://www.w3.org/TR/WCAG22/) standards, and [WCAG roles](https://www.w3.org/TR/wai-aria/#roles) that are commonly used to evaluate accessibility.
12+
The Blazor AI AssistView component follows established accessibility guidelines and standards, including [ADA](https://www.ada.gov/), [Section 508](https://www.section508.gov/), [WCAG 2.2](https://www.w3.org/TR/WCAG22/) standards, and [WCAG roles](https://www.w3.org/TR/wai-aria/#roles) that are commonly used to evaluate accessibility.
1313

14-
The accessibility compliance for the Blazor AI AssistView component is outlined below.
14+
The component’s accessibility compliance is summarized below.
1515

1616
| Accessibility Criteria | Compatibility |
1717
| -- | -- |
@@ -45,7 +45,7 @@ The following ARIA attributes are used in the AI AssistView component:
4545
| ------------ | ----------------------- |
4646
| `role=button` | Indicates that the element is clickable and triggers an action when activated by the user. |
4747
| `role=toolbar` | Specifies that the element is a toolbar. |
48-
| `aria-label` | Defines a string value that labels an interactive element for accessibility. |
48+
| `aria-label` | Provides an accessible name for interactive elements (for example, buttons, toolbar, or prompt input). |
4949
| `aria-orientation` | Specifies the orientation of the toolbar. |
5050
| `aria-disabled` | Indicates whether the toolbar or element is currently disabled and not interactive. |
5151
| `aria-multiline` | Indicates that a textbox accepts multiple lines of input or only a single line. |
@@ -57,19 +57,19 @@ The following keyboard shortcuts are supported by the AI AssistView component.
5757
| Windows | Mac | Actions |
5858
| --- | --- | --- |
5959
| <kbd>Enter</kbd> | <kbd>Enter</kbd> | Select the focused item. |
60-
| <kbd>Tab</kbd> | <kbd>Tab</kbd> | Moves focus forward through the interactive elements. |
61-
| <kbd>Shift</kbd> + <kbd>Tab</kbd> | <kbd>⇧</kbd> + <kbd>Tab</kbd> | Moves focus backward through the interactive elements. |
62-
<b>AI AssistView Toolbars</b>|||
63-
| <kbd>←</kbd> | <kbd>←</kbd> | Focuses the previous toolbar element. |
64-
| <kbd>→</kbd> | <kbd>→</kbd> | Focuses the next toolbar element. |
60+
| <kbd>Tab</kbd> | <kbd>Tab</kbd> | Move focus forward through interactive elements. |
61+
| <kbd>Shift</kbd> + <kbd>Tab</kbd> | <kbd>⇧</kbd> + <kbd>Tab</kbd> | Move focus backward through interactive elements. |
62+
<b>AI AssistView toolbar</b>|||
63+
| <kbd>←</kbd> | <kbd>←</kbd> | Move focus to the previous toolbar element. |
64+
| <kbd>→</kbd> | <kbd>→</kbd> | Move focus to the next toolbar element. |
6565
| <kbd>Enter</kbd> / <kbd>Space</kbd> | <kbd>Enter</kbd> / <kbd>Space</kbd> | Select the focused item or activate the selected option. |
66-
| <kbd>Home</kbd> | <kbd>Home</kbd> | Moves focus to the first toolbar element. |
67-
| <kbd>End</kbd> | <kbd>End</kbd> | Moves focus to the last toolbar element. |
66+
| <kbd>Home</kbd> | <kbd>Home</kbd> | Move focus to the first toolbar element. |
67+
| <kbd>End</kbd> | <kbd>End</kbd> | Move focus to the last toolbar element. |
6868

6969
## Ensuring accessibility
7070

7171
The Blazor AI AssistView component's accessibility levels are ensured through an [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) with playwright tests.
7272

7373
## See also
7474

75-
* [Accessibility in Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components](https://blazor.syncfusion.com/documentation/common/accessibility)
75+
* Accessibility in Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components (https://blazor.syncfusion.com/documentation/common/accessibility)

blazor/ai-assistview/appearance.md

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

1010
# Appearance in Blazor AI AssistView component
1111

12+
Customize the AI AssistView appearance by configuring width and height and by applying custom styles through the CssClass property.
13+
1214
## Setting width
1315

1416
You can use the [Width](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_Width) property to set the width of the AI AssistView. The default value is `100%`.

blazor/ai-assistview/assist-view.md

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

1212
## Setting prompt text
1313

14-
You can use the [Prompt](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_Prompt) property to define the prompt text for the AI AssistView component.
14+
Use the [Prompt](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_Prompt) property to define the initial prompt text displayed in the AI AssistView component. This value is sent when the prompt is requested and can be processed to generate a response.
1515

1616
```cshtml
1717
@@ -36,7 +36,7 @@ You can use the [Prompt](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor
3636

3737
## Setting prompt placeholder
3838

39-
You can use the [PromptPlaceholder](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_PromptPlaceholder) property to set the placeholder text for the prompt textarea. The default value is `Type prompt for assistance...`.
39+
Use the [PromptPlaceholder](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_PromptPlaceholder) property to set the placeholder text in the prompt text area. The default placeholder is displayed when the text area is empty. The default value is `Type prompt for assistance...`.
4040

4141
```cshtml
4242
@@ -61,9 +61,9 @@ You can use the [PromptPlaceholder](https://help.syncfusion.com/cr/blazor/Syncfu
6161

6262
## Prompt-response collection
6363

64-
You can use the [Prompts](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_Prompts) property to initialize the component with the configured data as a collection of prompts and responses or individual entries.
64+
Use the [Prompts](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_Prompts) property to initialize the component with a predefined collection of prompts and responses, or with individual entries.
6565

66-
The `Prompts` collection stores all the prompts and responses generated.
66+
The `Prompts` collection stores all prompts and responses generated during the session.
6767

6868
```cshtml
6969
@@ -93,7 +93,7 @@ The `Prompts` collection stores all the prompts and responses generated.
9393

9494
## Adding prompt suggestions
9595

96-
You can use the [PromptSuggestions](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_PromptSuggestions) property, to add the suggestions in both initial and on-demand which help users to refine their prompts. Additionally, custom header can be set for suggestions further enhancing the user experience.
96+
Use the [PromptSuggestions](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_PromptSuggestions) property to provide suggested prompts on initial load and on demand, helping users refine their input. Additionally, a custom header can be set for suggestions to enhance usability.
9797

9898
```cshtml
9999
@@ -121,7 +121,7 @@ You can use the [PromptSuggestions](https://help.syncfusion.com/cr/blazor/Syncfu
121121

122122
### Adding suggestion headers
123123

124-
You can use the [PromptSuggestionsHeader](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_PromptSuggestionsHeader) property to set the header text for the prompt suggestions in the AI AssistView.
124+
Use the [PromptSuggestionsHeader](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_PromptSuggestionsHeader) property to set the header text for the prompt suggestions displayed in the AI AssistView.
125125

126126
```cshtml
127127
@@ -149,7 +149,7 @@ You can use the [PromptSuggestionsHeader](https://help.syncfusion.com/cr/blazor/
149149

150150
## Adding prompt iconCss
151151

152-
You can customize the appearance of the prompter avatar by using the [PromptIconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_PromptIconCss) property.
152+
Customize the appearance of the prompter avatar using the [PromptIconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_PromptIconCss) property.
153153

154154
```cshtml
155155
@@ -179,7 +179,7 @@ You can customize the appearance of the prompter avatar by using the [PromptIcon
179179

180180
## Adding response iconCss
181181

182-
You can use the [ResponseIconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_ResponseIconCss) property to customize the appearance of the responder avatar. By default, the `e-assistview-icon` class is added as the built-in AI AssistView response icon.
182+
Use the [ResponseIconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.InteractiveChat.SfAIAssistView.html#Syncfusion_Blazor_InteractiveChat_SfAIAssistView_ResponseIconCss) property to customize the appearance of the responder avatar. By default, the `e-assistview-icon` class is applied as the built-in AI AssistView response icon.
183183

184184
```cshtml
185185

0 commit comments

Comments
 (0)