Skip to content

Commit 3b94631

Browse files
committed
983366: Updated the UG document for Breadcrumb
1 parent 092e49b commit 3b94631

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

blazor/breadcrumb/accessibility.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ control: Button
77
documentation: ug
88
---
99

10-
# Accessibility in Blazor Breadcrumb component
10+
# Accessibility in Blazor Breadcrumb Component
1111

1212
The Blazor Breadcrumb 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.
1313

@@ -36,7 +36,7 @@ The accessibility compliance for the Blazor Breadcrumb component is outlined bel
3636

3737
<div><img src="https://cdn.syncfusion.com/content/images/landing-page/no.png" alt="No"> - The component does not meet the requirement.</div>
3838

39-
## WAI-ARIA attributes
39+
## WAI-ARIA Attributes
4040

4141
The Blazor Breadcrumb component implements [WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/breadcrumb/) patterns to meet accessibility requirements. The following ARIA attributes are used in the Blazor Breadcrumb component:
4242

@@ -45,7 +45,7 @@ The Blazor Breadcrumb component implements [WAI-ARIA](https://www.w3.org/WAI/ARI
4545
| `aria-label` | Indicates the breadcrumb item text. |
4646
| `aria-disabled` | Indicates the disabled state of a breadcrumb item. |
4747

48-
## Keyboard interaction
48+
## Keyboard Interaction
4949

5050
The Blazor Breadcrumb component follows the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/breadcrumb/#keyboardinteraction) guideline, facilitating navigation for individuals who use assistive technologies (AT) and those who rely solely on keyboard navigation. The following keyboard shortcuts are supported by the Blazor Breadcrumb component.
5151

@@ -56,14 +56,14 @@ The Blazor Breadcrumb component follows the [keyboard interaction](https://www.w
5656
| <kbd>Enter</kbd> key in normal mode | <kbd>Enter</kbd> key in normal mode | Select the breadcrumb item. |
5757
| <kbd>Enter</kbd> key in normal mode | <kbd>Enter</kbd> key in normal mode | To open the popup of menu type overflow mode when you press enter on collapsed button and It will expand the items of collapsed type overflow mode when you press enter on collapsed button. |
5858

59-
## Ensuring accessibility
59+
## Ensuring Accessibility
6060

6161
The accessibility levels of the Blazor Breadcrumb component are ensured through automated testing using [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) with playwright tests.
6262

6363
The accessibility compliance of the Blazor Breadcrumb component is demonstrated in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/breadcrumb) in a new window to evaluate the accessibility of the Blazor Breadcrumb component with accessibility tools.
6464

6565
{% previewsample "https://ej2.syncfusion.com/accessibility/breadcrumb.html" %}
6666

67-
## See also
67+
## See Also
6868

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

blazor/breadcrumb/breadcrumb-items.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The Syncfusion [Blazor Breadcrumb](https://www.syncfusion.com/blazor-components/
3535

3636
![Blazor Breadcrumb Component](./images/blazor-Breadcrumb-tag.png)
3737

38-
## Items based on current URL
38+
## Items Based on Current URL
3939

4040
The Breadcrumb component can automatically generate its items based on the segments of the current page's URL. This provides a convenient way to create dynamic breadcrumbs without manual item definition. When the `SfBreadcrumb` is instantiated without any [BreadcrumbItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html) directives, it inspects the current URL and generates breadcrumb items accordingly. Each segment of the URL becomes a breadcrumb item, and the text is typically derived from the URL segment
4141

@@ -65,7 +65,7 @@ The Breadcrumb component can also be instructed to generate its items by parsing
6565

6666
![Blazor Breadcrumb Component](./images/blazor-Breadcrumb-static-url.png)
6767

68-
## Add or remove the Breadcrumb items
68+
## Add or Remove the Breadcrumb Items
6969

7070
The Breadcrumb component allows programmatic manipulation of its items using the [Items](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfBreadcrumb.html#Syncfusion_Blazor_Navigations_SfBreadcrumb_Items) property of Breadcrumb, so items in the breadcrumb can be dynamically add or remove from the Breadcrumb.
7171

blazor/breadcrumb/icons.md

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

1212
The [Blazor Breadcrumb](https://www.syncfusion.com/blazor-components/blazor-breadcrumb) component supports the inclusion of icons, images, and SVG elements to enhance the visual representation of its items. These visual cues improve navigation clarity and user experience.
1313

14-
## Breadcrumb with font icon
14+
## Breadcrumb With Font Icon
1515

1616
To display a font icon on a Breadcrumb item, set the [IconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_IconCss) property to `e-icons` with the required icon's class name.
1717

@@ -33,7 +33,7 @@ To display a font icon on a Breadcrumb item, set the [IconCss](https://help.sync
3333

3434
N> By default, icons are positioned to the left side of the item text.
3535

36-
## Breadcrumb with image
36+
## Breadcrumb With Image
3737

3838
Images can be incorporated into Breadcrumb items using the [IconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_IconCss) property. In the following example, an image is added to a Breadcrumb item with specific height and width by using `e-image-home` CSS class.
3939

@@ -61,7 +61,7 @@ Images can be incorporated into Breadcrumb items using the [IconCss](https://hel
6161

6262
![Blazor Breadcrumb with Image](./images/image.png)
6363

64-
## Breadcrumb with SVG image
64+
## Breadcrumb With SVG Image
6565

6666
To add an SVG image to a Breadcrumb item, use the [IconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_IconCss) property with a custom CSS class. In the following example, SVG image is added to the Breadcrumb item with height and width by using `e-svg-home` class.
6767

@@ -89,7 +89,7 @@ To add an SVG image to a Breadcrumb item, use the [IconCss](https://help.syncfus
8989

9090
![Breadcrumb with SVG Image](./images/svg.PNG)
9191

92-
## Icon only
92+
## Icon Only
9393

9494
To display Breadcrumb items consisting solely of icons, provide the [IconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_IconCss) property for each `BreadcrumbItem` without specifying the `Text` property.
9595

@@ -110,7 +110,7 @@ The following example demonstrates Breadcrumb items rendered only with icons:
110110

111111
![Breadcrumb with Icons Only](./images/icon-only.PNG)
112112

113-
## Show icon only for first item
113+
## Show Icon Only For First Item
114114
To display an icon exclusively for the first item in the Breadcrumb, set the [IconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_IconCss) property for the first `BreadcrumbItem` and omit it for subsequent items.
115115

116116
The following example demonstrates an icon only for the initial Breadcrumb item:

blazor/breadcrumb/templates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The following template options are available in the Breadcrumb component:
2121

2222
Templates used by the Breadcrumb component are of type `RenderFragment` and receive parameters that provide contextual data. Users can access these parameters using the implicit `context` parameter. You can optionally change this implicit parameter name using the `Context` attribute if needed.
2323

24-
## Item template
24+
## Item Template
2525

2626
The `ItemTemplate` enables developers to define a custom UI for each Breadcrumb item. In the following example, shopping cart details are used as Breadcrumb items and each item is rendered as Chip component using [ItemTemplate](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbTemplates.html#Syncfusion_Blazor_Navigations_BreadcrumbTemplates_ItemTemplate) tag directive. The current item's data is accessible via the `context` parameter.
2727

@@ -51,7 +51,7 @@ The `ItemTemplate` enables developers to define a custom UI for each Breadcrumb
5151

5252
![Blazor Breadcrumb Item Template with Chips](./images/blazor-Breadcrumb-item-template.png)
5353

54-
## Separator template
54+
## Separator Template
5555

5656
The [SeparatorTemplate](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbTemplates.html#Syncfusion_Blazor_Navigations_BreadcrumbTemplates_SeparatorTemplate) enables customization of the separators between Breadcrumb items. In the example below, separators are customized with icons using the[SeparatorTemplate](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbTemplates.html#Syncfusion_Blazor_Navigations_BreadcrumbTemplates_SeparatorTemplate) tag directive. The `context` parameter provides access to the previous and next item data, though it's often unused for simple icon separators.
5757

0 commit comments

Comments
 (0)