Skip to content

Commit 8f1a768

Browse files
983104: Updated the UG Documentation for mention.
1 parent 92d31ac commit 8f1a768

File tree

10 files changed

+125
-121
lines changed

10 files changed

+125
-121
lines changed

blazor/mention/accessibility.md

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

1010
# Accessibility in Blazor Mention Component
1111

12-
Web accessibility makes web content and web applications more accessible for people with disabilities. Blazor Mention component provides built-in compliance with `WAI-ARIA` specifications. The `WAI-ARIA` support is achieved using the attributes such as `aria-selected` and `aria-activedescendent`.
12+
Web accessibility ensures that web content and applications are usable by people with disabilities. The Blazor Mention component includes built-in support for WAI-ARIA specifications to improve accessibility for assistive technologies. Key attributes such as `aria-selected` and `aria-activedescendant` are applied to communicate state and focus.
1313

14-
The [Blazor Mention](https://www.syncfusion.com/blazor-components/blazor-mention) 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.
14+
The [Blazor Mention](https://www.syncfusion.com/blazor-components/blazor-mention) component follows 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.
1515

1616
The accessibility compliance for the Blazor Mention component is outlined below.
1717

@@ -20,11 +20,11 @@ The accessibility compliance for the Blazor Mention component is outlined below.
2020
| [WCAG 2.2 Support](../common/accessibility#accessibility-standards) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
2121
| [Section 508 Support](../common/accessibility#accessibility-standards) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
2222
| [Screen Reader Support](../common/accessibility#screen-reader-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
23-
| [Right-To-Left Support](../common/accessibility#right-to-left-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
23+
| [Right-to-left Support](../common/accessibility#right-to-left-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
2424
| [Color Contrast](../common/accessibility#color-contrast) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
2525
| [Mobile Device Support](../common/accessibility#mobile-device-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
2626
| [Keyboard Navigation Support](../common/accessibility#keyboard-navigation-support) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
27-
| [Axe-core Accessibility Validation](../common/accessibility#ensuring-accessibility) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
27+
| [axe-core Accessibility Validation](../common/accessibility#ensuring-accessibility) | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
2828

2929
<style>
3030
.post .post-content img {
@@ -56,17 +56,16 @@ Here are some of the `ARIA attributes` that might be used to denote the state of
5656

5757
## Keyboard interaction
5858

59-
You can use the following key shortcuts to access the Blazor Mention without interruptions. It allows users to quickly perform actions or navigate through an application using keyboard input.
59+
Use the following key shortcuts to access the Blazor Mention component without interruptions. These shortcuts allow users to navigate and select items using only the keyboard.
6060

6161
| Windows | Mac | Actions |
6262
| --- | --- | --- |
63-
| <kbd>↓</kbd> | <kbd>↓</kbd> | Focus the first item in the Mention list. Otherwise, focus the item next to the currently focused item. |
64-
| <kbd>↑</kbd> | <kbd>↑</kbd> | Focus the item previous to the currently focused one. |
65-
| <kbd>Esc(Escape)</kbd> | <kbd>Esc(Escape)</kbd> | Closes the popup list when it is in an open state. |
66-
| <kbd>Enter</kbd> | <kbd>Enter</kbd> | Selects the focused item, and when it is in an open state the popup list closes. |
63+
| <kbd>↓</kbd> | <kbd>↓</kbd> | Focuses the first item in the Mention list; otherwise, focuses the next item. |
64+
| <kbd>↑</kbd> | <kbd>↑</kbd> | Focuses the previous item in the Mention list. |
65+
| <kbd>Esc (Escape)</kbd> | <kbd>Esc (Escape)</kbd> | Closes the popup list if it is open. |
66+
| <kbd>Enter</kbd> | <kbd>Enter</kbd> | Selects the focused item and closes the popup list if it is open. |
6767
| <kbd>Tab</kbd> | <kbd>Tab</kbd> | Focuses on the next tab index element on the page when the popup is closed. Otherwise, inserts the selected popup list item and closes the popup list. |
6868

69-
7069
{% highlight razor %}
7170

7271
{% include_relative code-snippet/accessibility.razor %}
@@ -75,9 +74,9 @@ You can use the following key shortcuts to access the Blazor Mention without int
7574

7675
## Ensuring accessibility
7776

78-
The Blazor Mention component's accessibility levels are ensured through an [axe-core](https://www.npmjs.com/package/axe-core) software tool during automated testing.
77+
The Blazor Mention components accessibility is validated using the [axe-core](https://www.npmjs.com/package/axe-core) testing tool during automated testing.
7978

80-
The accessibility compliance of the Mention component is shown in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/mention) in a new window to evaluate the accessibility of the Mention component with accessibility tools.
79+
The accessibility compliance of the Mention component is shown in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/mention) in a new window to evaluate the Mention component with accessibility tools.
8180

8281
## See also
8382

blazor/mention/customization.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,19 @@ documentation: ug
99

1010
# Customization in Blazor Mention Component
1111

12+
This page covers common customization options for the Blazor Mention component, including displaying the mention character, appending suffix text, configuring the popup list size, changing the trigger character, and controlling leading space behavior.
13+
1214
## Show or hide mention character
1315

14-
To show the mentioned character along with the text when displaying the selected mention item in the target element, you can set the [ShowMentionChar](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_ShowMentionChar) property of the Mention component to `true`. This can be useful in cases where you want to clearly differentiate between the selected mention item and the rest of the text in the Mention component.
16+
To display the mention character alongside the selected item in the target element, set the [ShowMentionChar](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_ShowMentionChar) property to `true`. This helps distinguish the selected mention from surrounding text. The default value is `false`.
1517

1618
{% highlight razor %}
1719

1820
{% include_relative code-snippet/show-mention-char.razor %}
1921

2022
{% endhighlight %}
2123

22-
![Blazor Mention with show or hide mention character](./images/blazor-mention-show-mention-char.png)
24+
![Blazor Mention showing the mention character with selected item](./images/blazor-mention-show-mention-char.png)
2325

2426
## Adding the suffix character after selection
2527

@@ -33,38 +35,42 @@ The [SuffixText](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDow
3335

3436
## Configure the popup list
3537

36-
You can customize the suggestion list's width and height using the [PopupHeight](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_PopupHeight) and [PopupWidth](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_PopupWidth) properties. These properties can accept values in pixels, percentage, or as a number. If a number value is specified, it will be treated as a pixel value.
38+
Customize the suggestion list size using the [PopupHeight](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_PopupHeight) and [PopupWidth](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_PopupWidth) properties. Values can be provided as:
39+
- A string with CSS units (for example, `"300px"`, `"50%"`)
40+
- A number (interpreted as pixels)
3741

38-
By default, the popup list width value is set to `auto`. Depending on the mentioned suggestion data list, the width value is automatically adjusted. The popup list height value is set to `300px`.
42+
Defaults:
43+
- `PopupWidth`: `auto` (adjusts based on content)
44+
- `PopupHeight`: `300px`
3945

4046
{% highlight razor %}
4147

4248
{% include_relative code-snippet/popup-list.razor %}
4349

4450
{% endhighlight %}
4551

46-
![Blazor Mention with popup list](./images/blazor-mention-popup-list.png)
52+
![Blazor Mention with configured popup width and height](./images/blazor-mention-popup-list.png)
4753

4854
## Trigger character
4955

50-
The [MentionChar](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_MentionChar) property in the Mention component allows you to specify the character that will trigger the suggestion list to display in the target area. By default, the `@` character is used as the trigger character, but you can customize it to any other character by setting the `MentionChar` property.
56+
Change the character that triggers the suggestion list using the [MentionChar](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_MentionChar) property. By default, the trigger character is `@`, but it can be set to any character.
5157

5258
{% highlight razor %}
5359

5460
{% include_relative code-snippet/trigger-char.razor %}
5561

5662
{% endhighlight %}
5763

58-
![Blazor Mention with trigger character](./images/blazor-mention-trigger-char.png)
64+
![Blazor Mention using a custom trigger character](./images/blazor-mention-trigger-char.png)
5965

6066
## Leading Space Requirement
6167

62-
You can control whether a space is required before the mention character using the [RequireLeadingSpace](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#properties) property in the Mention component. When set to `true` , a space must precede the mention character to trigger the suggestion popup. When set to `false`, the mention character can trigger suggestions without requiring a leading space.
68+
Control whether a space is required before the mention character using the [RequireLeadingSpace](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#properties) property in the Mention component. When set to `true` , a space must precede the mention character to trigger the suggestion popup. When set to `false`, the mention character can trigger suggestions without requiring a leading space.
6369

6470
{% highlight razor %}
6571

6672
{% include_relative code-snippet/require-leading-space.razor %}
6773

6874
{% endhighlight %}
6975

70-
![Blazor Mention with leading space configuration](./images/require_leading_space.gif)
76+
![Blazor Mention configured with leading space requirement](./images/require_leading_space.gif)

blazor/mention/disabled-items.md

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

1010
# Disabled Items in Blazor Mention Component
1111

12-
The [Mention](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html) provides options for individual items to be either in an enabled or disabled state for specific scenarios. The category of each list item can be mapped through the [Disabled](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.MentionFieldSettings.html#Syncfusion_Blazor_DropDowns_MentionFieldSettings_Disabled) field in the data table. Once an item is disabled, it cannot be selected as a value for the component. To configure the disabled item columns, use the `MentionFieldSettings.Disabled` property.
12+
The [Mention](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html) component supports disabling individual suggestion items for specific scenarios. Map the disabled state from your data model using the [MentionFieldSettings.Disabled](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.MentionFieldSettings.html#Syncfusion_Blazor_DropDowns_MentionFieldSettings_Disabled) field. Disabled items are not selectable and are skipped during keyboard navigation.
1313

14-
In the following sample, State are grouped according on its category using `Disabled` field.
14+
In the following sample, certain states are disabled by setting the `Disabled` field in the data source.
1515

1616
{% highlight cshtml %}
1717

blazor/mention/filtering-data.md

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

1010
# Filtering data in Blazor Mention Component
1111

12-
The Mention component has built-in support for filtering data items, which allows you to easily narrow down the list of mention suggestions based on user input. The filter operation begins as soon as the user starts typing characters in the Mention element, and it is designed to quickly and efficiently search through the available data items to find matches based on the entered characters.
12+
The Mention component includes built-in filtering to narrow the suggestion list based on user input. Filtering begins when the user types after the mention character and matches items from the data source against the entered text.
1313

1414
## Limit the minimum filter character
1515

16-
The [MinLength](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_MinLength) property that allows you to control the minimum length of user input required to initiate the search action. By default, the `MinLength` property is set to `0`, which means that the suggestion list will open as soon as the user inputs the mention character.
16+
The [MinLength](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_MinLength) property allows controlling the minimum number of characters required to start searching. By default, `MinLength` is `0`, which opens the suggestion list as soon as the mention character is entered.
1717

18-
For example, if you set `MinLength` to `3`, the suggestion list will only open when the user has entered at least three characters.
18+
For example, when `MinLength` is set to `3`, suggestions appear only after at least three characters are typed.
1919

20-
In the following example, the remote request does not fetch the search data until the search key contains three characters.
20+
In the following example, the remote request does not fetch data until the search key contains three characters.
2121

2222
{% highlight razor %}
2323

@@ -27,11 +27,11 @@ In the following example, the remote request does not fetch the search data unti
2727

2828
## Change the filter type
2929

30-
The [FilterType](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_FilterType) property allows you to specify the type of filter to use when filtering data items. By default, the `FilterType` property is set to `Contains`, which means that the Mention component will search for items that contain the entered search string as a substring. The `FilterType` property supports below three different filter types.
30+
The [FilterType](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_FilterType) property specifies the type of string comparison for filtering. By default, `FilterType` is `Contains`, which finds items containing the search text. The component supports the following filter types (see the [FilterType enum](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.FilterType.html)):
3131

32-
* `StartsWith` - This filter type searches for items that start with the entered characters.
33-
* `Contains` - This filter type searches for items that contain the entered characters as a substring.
34-
* `EndsWith` - This filter type searches for items that end with the entered characters.
32+
* `StartsWith` - Finds items that start with the entered characters.
33+
* `Contains` - Finds items that contain the entered characters as a substring.
34+
* `EndsWith` - Finds items that end with the entered characters.
3535

3636
{% highlight razor %}
3737

@@ -41,29 +41,29 @@ The [FilterType](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDow
4141

4242
## Allow spacing between search
4343

44-
The [AllowSpaces](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_AllowSpaces) property is used to control whether spaces are allowed in the middle of the mention or not. If `AllowSpaces` is set to `true`, the Mention component will allow spaces in the middle of the mention and the data source will be filtered accordingly. If `AllowSpaces` is set to `false`, the Mention component will not allow spaces in the middle of the mention and the data source will not be filtered on space key press.
45-
46-
> By default, the `AllowSpaces` property is disabled, and the space ends the Mention component search.
44+
The [AllowSpaces](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_AllowSpaces) property controls whether spaces are allowed within the search term after the mention character.
45+
- When `true`, typing a space continues filtering (for example, “John Sm” matches “John Smith”).
46+
- When `false` (default), pressing space ends the mention search and the list is not filtered on space key press.
4747

4848
{% highlight razor %}
4949

5050
{% include_relative code-snippet/allow-space.razor %}
5151

5252
{% endhighlight %}
5353

54-
![Blazor Mention with allow space between search](./images/blazor-mention-allow-space.png)
54+
![Blazor Mention allowing spaces in the search query](./images/blazor-mention-allow-space.png)
5555

5656
## Customize the suggestion item count
5757

58-
The [SuggestionCount](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_SuggestionCount) property allows you to specify the number of list items that should be displayed in the suggestion list. By default, the `SuggestionCount` property is set to `25`, which means that the Mention component will display up to `25` list items in the suggestion list. The `SuggestionCount` property can be set to any integer value.
58+
The [SuggestionCount](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DropDowns.SfMention-1.html#Syncfusion_Blazor_DropDowns_SfMention_1_SuggestionCount) property sets the maximum number of items displayed in the suggestion list. By default, `SuggestionCount` is `25`. Set it to any integer value to increase or reduce the number of visible suggestions.
5959

6060
{% highlight razor %}
6161

6262
{% include_relative code-snippet/suggestion-list-count.razor %}
6363

6464
{% endhighlight %}
6565

66-
![Blazor Mention with suggestion item count](./images/blazor-mention-suggestion-list.png)
66+
![Blazor Mention showing a limited number of suggestions](./images/blazor-mention-suggestion-list.png)
6767

6868
## See also
6969

0 commit comments

Comments
 (0)