Skip to content

Commit e832a7e

Browse files
Merge pull request #7158 from syncfusion-content/993664-Pager
993664: Updated the UG content and samples for Blazor Pager Component
2 parents daac408 + 37b29ac commit e832a7e

12 files changed

+584
-391
lines changed

blazor-toc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3749,7 +3749,7 @@
37493749
<a href="/blazor/pager/data-binding">Data Binding</a>
37503750
</li>
37513751
<li>
3752-
<a href="/blazor/pager/behaviour-settings">Behaviour Settings</a>
3752+
<a href="/blazor/pager/behavior-settings">Behavior Settings</a>
37533753
</li>
37543754
<li>
37553755
<a href="/blazor/pager/pager-with-drop-down">Pager with Dropdown</a>

blazor/pager/accessibility.md

Lines changed: 41 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
---
22
layout: post
3-
title: Accessibility in Blazor Pager Component | Syncfusion
4-
description: Checkout here and learn about accessibility in Syncfusion Blazor Pager component and much more details.
3+
title: Accessibility Support in the Blazor Pager Component | Syncfusion
4+
description: Learn about accessibility features and compliance in the Syncfusion Blazor Pager component, including WAI-ARIA roles and keyboard navigation.
55
platform: Blazor
66
control: Pager
77
documentation: ug
88
---
99

1010
# Accessibility in Blazor Pager Component
1111

12-
The Blazor Pager 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 Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component is designed to meet widely recognized accessibility standards, ensuring compatibility with assistive technologies and delivering an inclusive experience. It adheres to the following guidelines:
1313

14-
The accessibility compliance for the Blazor Pager component is outlined below.
14+
- [ADA](https://www.ada.gov/) – Americans with Disabilities Act compliance for accessible digital content.
15+
- [Section 508](https://www.section508.gov/) – U.S. federal accessibility requirements for software applications.
16+
- [WCAG 2.2](https://www.w3.org/TR/WCAG22/) – Web Content Accessibility Guidelines for perceivable, operable, and understandable content.
17+
- [WAI-ARIA Roles](https://www.w3.org/TR/wai-aria/#roles) – Accessible Rich Internet Applications specifications for improved interaction with assistive technologies.
18+
19+
## Accessibility Compliance
20+
21+
The table below lists the accessibility features supported by the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component:
1522

1623
| Accessibility Criteria | Compatibility |
1724
| -- | -- |
@@ -31,42 +38,50 @@ The accessibility compliance for the Blazor Pager component is outlined below.
3138
}
3239
</style>
3340

34-
<div><img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> - All features of the component meet the requirement.</div>
41+
**Legend:**
42+
43+
<div><img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> - Fully meets the requirement.</div>
3544

36-
<div><img src="https://cdn.syncfusion.com/content/images/documentation/partial.png" alt="Intermediate"> - Some features of the component do not meet the requirement.</div>
45+
<div><img src="https://cdn.syncfusion.com/content/images/documentation/partial.png" alt="Intermediate"> - Partially meets the requirement.</div>
3746

38-
<div><img src="https://cdn.syncfusion.com/content/images/documentation/not-supported.png" alt="No"> - The component does not meet the requirement.</div>
47+
<div><img src="https://cdn.syncfusion.com/content/images/documentation/not-supported.png" alt="No"> - Does not meet the requirement.</div>
3948

4049
## WAI-ARIA
4150

42-
The Blazor Pager component followed the [WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/) patterns to meet the accessibility. The following ARIA attributes are used in the Blazor Pager component:
51+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component applies Accessible Rich Internet Applications ([WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/)) roles and attributes to improve interoperability with assistive technologies.
52+
53+
| **Element** | **Purpose** | **Applied Role / Attribute** |
54+
|----------------------|--------------------------------------------------|-------------------------------------|
55+
| Pager root container | Identifies the region as page navigation | `role="navigation"` |
56+
| Pager wrapper | Groups the collection of page selectors | `role="pager"` |
57+
| Page selector | Represents an interactive control for page selection | `role="button"` |
58+
| Navigation region | Provides an accessible name for the navigation area | `aria-label="<descriptive text>"` |
4359

44-
* pager (role)
45-
* button (role)
46-
* navigation(role)
47-
* aria-label (Attribute)
4860

4961
## Keyboard navigation
5062

51-
The Blazor Pager component followed the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/alert/#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 Pager component.
63+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component supports keyboard interactions to ensure accessibility for individuals relying on assistive technologies or keyboard navigation. The available shortcuts are:
64+
65+
| **Windows** | **Mac** | **Action** |
66+
|---------------------------------|----------------------------------|-------------------------------------------|
67+
| <kbd>Page Down</kbd> / <kbd>→</kbd> | <kbd>Page Down</kbd> / <kbd>→</kbd> | Navigate to the next page |
68+
| <kbd>Page Up</kbd> / <kbd>←</kbd> | <kbd>Page Up</kbd> / <kbd>←</kbd> | Navigate to the previous page |
69+
| <kbd>Enter</kbd> / <kbd>Space</kbd> | <kbd>Enter</kbd> / <kbd>Space</kbd> | Select the currently focused page |
70+
| <kbd>Tab</kbd> | <kbd>Tab</kbd> | Move focus to the next pager item |
71+
| <kbd>Shift</kbd> + <kbd>Tab</kbd> | <kbd>⇧</kbd> + <kbd>Tab</kbd> | Move focus to the previous pager item |
72+
| <kbd>Home</kbd> | <kbd>Home</kbd> | Navigate to the first page |
73+
| <kbd>End</kbd> | <kbd>End</kbd> | Navigate to the last page |
74+
| <kbd>Alt</kbd> + <kbd>Page Up</kbd> | <kbd>⌥</kbd> + <kbd>Page Up</kbd> | Navigate to the previous pager group |
75+
| <kbd>Alt</kbd> + <kbd>Page Down</kbd>| <kbd>⌥</kbd> + <kbd>Page Down</kbd> | Navigate to the next pager group |
5276

53-
|Windows | Mac |Description|
54-
|-----|-----| --- |
55-
|<kbd>Page down</kbd> / <kbd>→</kbd> | <kbd>Page down</kbd> / <kbd>→</kbd> |Navigates to the next page.|
56-
|<kbd>Page up</kbd> / <kbd>←</kbd> | <kbd>Page up</kbd> / <kbd>←</kbd> | Navigates to the previous page.|
57-
|<kbd>Enter</kbd> / <kbd>Space</kbd> | <kbd>Enter</kbd> / <kbd>Space</kbd> | Select the currently focused page.|
58-
|<kbd>Tab</kbd> | <kbd>Tab</kbd> | Focus on the next pager item.|
59-
|<kbd>Shift</kbd> + <kbd>Tab</kbd> | <kbd>⇧</kbd> + <kbd>Tab</kbd> | Focus on the previous pager item.|
60-
|<kbd>Home</kbd> | <kbd>Home</kbd> | Navigates to the first page.|
61-
|<kbd>End</kbd> | <kbd>End</kbd> | Navigates to the last page.|
62-
|<kbd>Alt</kbd> + <kbd>Page up</kbd> | <kbd>⌥</kbd> + <kbd>Page up</kbd> | Navigates to the previous pager.|
63-
|<kbd>Alt</kbd> + <kbd>Page down</kbd> | <kbd>⌥</kbd> + <kbd>Page down</kbd> | Navigates to the next pager.|
6477

6578
## Ensuring accessibility
6679

67-
The Blazor Pager component's accessibility levels are ensured through an [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) with playwright tests.
80+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component’s accessibility compliance is validated using [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) integrated with Playwright tests. This automated testing ensures adherence to accessibility standards and identifies potential issues.
81+
82+
An interactive sample is available to evaluate the component’s accessibility using standard tools:
6883

69-
The accessibility compliance of the Blazor Pager component is shown in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/pager) in a new window to evaluate the accessibility of the Blazor Pager component with accessibility tools.
84+
- [Accessibility Evaluation Sample](https://blazor.syncfusion.com/accessibility/pager)
7085

7186
## See also
7287

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

10-
# Behaviour Settings in Pager Component
10+
# Behavior Settings in Pager Component
1111

12-
This section briefly explains how the Pager APIS are helped to render the elements (numeric items and navigation buttons) of the Pager component. The total pages of the Pager component is calculated based on the defined [PageSize](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_PageSize) and [TotalItemsCount](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_TotalItemsCount) property.
12+
This section briefly explains how the Pager API's are helped to render the elements (numeric items and navigation buttons) of the Pager component. The total pages of the Pager component is calculated based on the defined [PageSize](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_PageSize) and [TotalItemsCount](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_TotalItemsCount) property.
1313

1414
## Page size
1515

@@ -61,7 +61,7 @@ Blazor Pager component support to define which page to be displayed currently in
6161

6262
## Show pager message
6363

64-
The Pager component provides an option to show or hide the Pager information in the Pager container. This can be achieved by using the [ShowPagerMessage](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_ShowPagerMessage) property. The default value of the `ShowPagerMessage` is "true". If you set the `ShowPagerMessage` to false, then the Pager information will be hidden.
64+
The Pager component provides an option to show or hide the Pager information in the Pager container. This can be achieved by using the [ShowPagerMessage](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_ShowPagerMessage) property. The default value of the `ShowPagerMessage` is **true**. Setting `ShowPagerMessage` to **false** hides the Pager information.
6565
6666
```csharp
6767
@using Syncfusion.Blazor.Navigations

blazor/pager/customization.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,37 @@
11
---
22
layout: post
33
title: Customization in Blazor Pager Component | Syncfusion
4-
description: Checkout here and learn about how to customize the elements of Syncfusion Blazor Pager component and much more.
4+
description: Learn how to customize the Syncfusion Blazor Pager component, including custom text and styling options.
55
platform: Blazor
66
control: Pager
77
documentation: ug
88
---
99

1010
# Customization in Pager Component
1111

12+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component provides options to customize its appearance and behavior. Customization can include modifying numeric item text and applying custom styles through CSS classes.
13+
1214
## Custom text for numeric items
1315

14-
The Pager component provides an option to define custom text and it is added as a prefix for numeric items. This can be achieved by using the [NumericItemPrefix](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_NumericItemPrefix) property.
16+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component allows adding a custom prefix to numeric items using the [NumericItemPrefix](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_NumericItemPrefix) property. This property accepts a string value that appears before each numeric item in the pager.
1517

1618
```csharp
1719

1820
@using Syncfusion.Blazor.Navigations
1921

20-
<SfPager TotalItemsCount="75" NumericItemPrefix="PageNo" PageSize="5" NumericItemsCount="2">
22+
<SfPager TotalItemsCount="75"
23+
PageSize="5"
24+
NumericItemsCount="2"
25+
NumericItemPrefix="PageNo">
2126
</SfPager>
2227

2328
```
2429

2530
![Blazor Pager with Custom Text](./images/blazor-pager-custom-text.png)
2631

27-
## Custom CSS
28-
29-
To modify the Pager's appearance, you need to override the default CSS of the Pager. This can be achieved by using the [CssClass](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_CssClass) property.
32+
## Apply custom CSS
3033

31-
In the following sample, the value for the `CssClass` property is set as custom CSS, and this root class is used to customize the Pager appearance.
34+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component supports customizing its appearance by applying custom CSS classes. This customization is enabled through the [CssClass](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_CssClass) property. Assign a class name to this property and define the required styles in the CSS file.
3235
3336
```csharp
3437

blazor/pager/data-binding.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,24 @@
11
---
22
layout: post
33
title: Data Binding in Blazor Pager Component | Syncfusion
4-
description: Checkout and learn here all about working Syncfusion Blazor Pager component with both local or remote data collection and how it splits into sectioned pages.
4+
description: Learn how the Syncfusion Blazor Pager component segments local or remote data collections into paged views.
55
platform: Blazor
66
control: Pager
77
documentation: ug
88
---
99

1010
# Data Binding in Blazor Pager Component
1111

12-
## Local Data
12+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component divides **local** or **remote** data collections into paged views. It provides navigation controls to manage large datasets efficiently.
1313

14-
The Blazor Pager component has an option to split the collection of data sets (local data) into sectioned pages.
14+
**When to Use:**
1515

16-
In the following sample, initially list view items are displayed per page based on the Pager's PageSize property. While navigating the numeric items in the Pager, the `ItemClick` event will be triggered. In the `ItemClick` event of the Pager, we have calculated the number of items displayed per page in the ListView component. Here, items in the ListView component are loaded from local data collection.
16+
- Use **Local Data** for **small**, **static** collections that can be loaded in memory.
17+
- Use **Remote Data** for **large** or **dynamic** datasets that require server-side operations.
18+
19+
## Local Data Binding
20+
21+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component can segment an in-memory data collection into multiple pages. The [PageSize](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_PageSize) property defines the number of items displayed per page. The [ItemClick](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_ItemClick) event updates the displayed subset when navigating between pages.
1722

1823
```csharp
1924
@using Syncfusion.Blazor.Data
@@ -82,7 +87,7 @@ In the following sample, initially list view items are displayed per page based
8287

8388
<style>
8489
.listview-container {
85-
margin: 0 auto 2em;
90+
margin: 0 auto 2em;
8691
max-width: 460px;
8792
}
8893
.pager-container {
@@ -92,11 +97,9 @@ In the following sample, initially list view items are displayed per page based
9297
</style>
9398
```
9499

95-
## Remote Data
96-
97-
The Blazor Pager component has an option to split the collection of data sets (remote data) into sectioned pages.
100+
## Remote Data Binding
98101

99-
In the following sample, initially list view items are displayed per page based on the Pager's PageSize property. While navigating the numeric items in the Pager, the `ItemClick` event will be triggered. In the `ItemClick` event of the Pager, we have calculated the number of items displayed per page in the ListView component. Here, items in the ListView component are loaded from the remote data services.
102+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component supports paging for data retrieved from remote services. The [DataManager](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.SfDataManager.html) component manages remote operations such as **querying**, **filtering**, and **paging**. The [PageSize](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_PageSize) property specifies the number of items displayed per page. The [ItemClick](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_ItemClick) event updates query parameters to fetch the correct subset of data.
100103
101104
```csharp
102105
@using Syncfusion.Blazor.Lists

0 commit comments

Comments
 (0)