Skip to content

Commit 5785066

Browse files
Merge pull request #6687 from syncfusion-content/983366-breadcrumb
Updated the UG document for Breadcrumb Component.
2 parents 3190f68 + 3b94631 commit 5785066

File tree

10 files changed

+119
-103
lines changed

10 files changed

+119
-103
lines changed

blazor/breadcrumb/accessibility.md

Lines changed: 11 additions & 11 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

@@ -22,7 +22,7 @@ The accessibility compliance for the Blazor Breadcrumb component is outlined bel
2222
| Color Contrast | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
2323
| Mobile Device Support | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
2424
| Keyboard Navigation Support | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
25-
| [Axe-core](https://www.npmjs.com/package/axe-core) Accessibility Validation | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
25+
| [Axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) Accessibility Validation | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
2626

2727
<style>
2828
.post .post-content img {
@@ -36,18 +36,18 @@ 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

41-
The Blazor Breadcrumb component followed the [WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/breadcrumb/) patterns to meet the accessibility. The following ARIA attributes are used in the Blazor Breadcrumb component:
41+
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

4343
| Attributes | Purpose |
4444
| --- | --- |
4545
| `aria-label` | Indicates the breadcrumb item text. |
46-
| `aria-disabled` | Indicates the state of breadcrumb item whether it is disabled. |
46+
| `aria-disabled` | Indicates the disabled state of a breadcrumb item. |
4747

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

50-
The Blazor Breadcrumb component followed the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/breadcrumb/#keyboardinteraction) guideline, making it easy for people who use assistive technologies (AT) and those who completely rely on keyboard navigation. The following keyboard shortcuts are supported by the Blazor Breadcrumb component.
50+
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

5252
| Windows | Mac | Actions |
5353
| --- | --- | --- |
@@ -56,14 +56,14 @@ The Blazor Breadcrumb component followed the [keyboard interaction](https://www.
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

61-
The Blazor Breadcrumb component's accessibility levels are ensured through an [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) with playwright tests.
61+
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

63-
The accessibility compliance of the Blazor Breadcrumb component is shown 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.
63+
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: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: post
3-
title: Breadcrumb Items with Blazor Breadcrumb component | Syncfusion
3+
title: Breadcrumb Items in Blazor Breadcrumb component | Syncfusion
44
description: Checkout and learn here all about data binding with Blazor Breadcrumb component of Syncfusion and more.
55
platform: Blazor
66
control: Breadcrumb
@@ -9,15 +9,15 @@ documentation: ug
99

1010
# Breadcrumb Items in Blazor Breadcrumb Component
1111

12-
The [Blazor Breadcrumb](https://www.syncfusion.com/blazor-components/blazor-breadcrumb) supports to generate items based on the current URL by default. You can set the [BreadcrumbItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html) tag directive or [Url](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfBreadcrumb.html#Syncfusion_Blazor_Navigations_SfBreadcrumb_Url) property to generate the items.
12+
The Syncfusion [Blazor Breadcrumb](https://www.syncfusion.com/blazor-components/blazor-breadcrumb) component supports to generate items based on the current URL by default. Alternatively, breadcrumb items can be manually defined using the[BreadcrumbItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html) tag directive or by setting the [Url](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfBreadcrumb.html#Syncfusion_Blazor_Navigations_SfBreadcrumb_Url) property.
1313

1414
[BreadcrumbItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html) has the following properties for navigation and its customizations.
1515

16-
* [Url](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_Url) - Sets the URL of the Breadcrumb item and it will navigate when clicked.
16+
* [Url](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_Url) - Sets the URL of the Breadcrumb item, which is used for navigation when the item is clicked. This can be an absolute or relative URL.
1717

18-
* [IconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_IconCss) - Sets CSS class string to include an icon for the Breadcrumb item.
18+
* [IconCss](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_IconCss) - Assigns a CSS class string to include an icon next to the breadcrumb item's text.
1919

20-
* [Text](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_Text) - Sets the text content of the Breadcrumb item.
20+
* [Text](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_Text) - Specifies the display text content for the breadcrumb item.
2121

2222
```cshtml
2323
@using Syncfusion.Blazor.Navigations
@@ -35,24 +35,25 @@ The [Blazor Breadcrumb](https://www.syncfusion.com/blazor-components/blazor-brea
3535

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

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

40-
The Breadcrumb items can be generated based on the current URL of the page when the user does not specify the Breadcrumb items using the [BreadcrumbItem](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html) tag directive. The following example shows the Breadcrumb items that are auto generated based on the current URL.
40+
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

4242
```cshtml
4343
@using Syncfusion.Blazor.Navigations
4444
4545
<SfBreadcrumb></SfBreadcrumb>
46+
4647
```
47-
{% previewsample "https://blazorplayground.syncfusion.com/embed/rNhUWVWJzVObSwiI?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
48+
{% previewsample "https://blazorplayground.syncfusion.com/embed/rXhpNiBSgmQNkpCP?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
4849

4950
![Blazor Breadcrumb Component](./images/blazor-Breadcrumb-current-url.png)
5051

5152
N> This output screenshot shows the [Bind to Location](https://blazor.syncfusion.com/demos/breadcrumb/bind-to-location) sample.
5253

5354
## Absolute URL
5455

55-
You can generate the Breadcrumb items by providing the [Url](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_Url) property in the component as like the below example.
56+
The Breadcrumb component can also be instructed to generate its items by parsing a specific URL provided via the [Url](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.BreadcrumbItem.html#Syncfusion_Blazor_Navigations_BreadcrumbItem_Url) property property of the `<SfBreadcrumb>` component as like the below example.
5657

5758
```cshtml
5859
@using Syncfusion.Blazor.Navigations
@@ -64,9 +65,9 @@ You can generate the Breadcrumb items by providing the [Url](https://help.syncfu
6465

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

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

69-
Using the [Items](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfBreadcrumb.html#Syncfusion_Blazor_Navigations_SfBreadcrumb_Items) property of Breadcrumb, we can dynamically add or remove the items of Breadcrumb.
70+
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.
7071

7172
```cshtml
7273
@using Syncfusion.Blazor.Navigations
@@ -106,4 +107,4 @@ Using the [Items](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Naviga
106107
}
107108
108109
```
109-
{% previewsample "https://blazorplayground.syncfusion.com/embed/BXBStMNFgGHPMWew?appbar=true&editor=true&result=true&errorlist=true&theme=bootstrap5" %}
110+
{% previewsample "https://blazorplayground.syncfusion.com/embed/BtVSjuVgKFaADUnm?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}

0 commit comments

Comments
 (0)