Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion blazor-toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -3745,7 +3745,7 @@
<a href="/blazor/pager/data-binding">Data Binding</a>
</li>
<li>
<a href="/blazor/pager/behaviour-settings">Behaviour Settings</a>
<a href="/blazor/pager/behavior-settings">Behavior Settings</a>
</li>
<li>
<a href="/blazor/pager/pager-with-drop-down">Pager with Dropdown</a>
Expand Down
67 changes: 41 additions & 26 deletions blazor/pager/accessibility.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
---
layout: post
title: Accessibility in Blazor Pager Component | Syncfusion
description: Checkout here and learn about accessibility in Syncfusion Blazor Pager component and much more details.
title: Accessibility Support in the Blazor Pager Component | Syncfusion
description: Learn about accessibility features and compliance in the Syncfusion Blazor Pager component, including WAI-ARIA roles and keyboard navigation.
platform: Blazor
control: Pager
documentation: ug
---

# Accessibility in Blazor Pager Component

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.
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:

The accessibility compliance for the Blazor Pager component is outlined below.
- [ADA](https://www.ada.gov/) – Americans with Disabilities Act compliance for accessible digital content.
- [Section 508](https://www.section508.gov/) – U.S. federal accessibility requirements for software applications.
- [WCAG 2.2](https://www.w3.org/TR/WCAG22/) – Web Content Accessibility Guidelines for perceivable, operable, and understandable content.
- [WAI-ARIA Roles](https://www.w3.org/TR/wai-aria/#roles) – Accessible Rich Internet Applications specifications for improved interaction with assistive technologies.

## Accessibility Compliance

The table below lists the accessibility features supported by the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component:

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

<div><img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> - All features of the component meet the requirement.</div>
**Legend:**

<div><img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> - Fully meets the requirement.</div>

<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>
<div><img src="https://cdn.syncfusion.com/content/images/documentation/partial.png" alt="Intermediate"> - Partially meets the requirement.</div>

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

## WAI-ARIA

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:
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.

| **Element** | **Purpose** | **Applied Role / Attribute** |
|----------------------|--------------------------------------------------|-------------------------------------|
| Pager root container | Identifies the region as page navigation | `role="navigation"` |
| Pager wrapper | Groups the collection of page selectors | `role="pager"` |
| Page selector | Represents an interactive control for page selection | `role="button"` |
| Navigation region | Provides an accessible name for the navigation area | `aria-label="<descriptive text>"` |

* pager (role)
* button (role)
* navigation(role)
* aria-label (Attribute)

## Keyboard navigation

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.
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:

| **Windows** | **Mac** | **Action** |
|---------------------------------|----------------------------------|-------------------------------------------|
| <kbd>Page Down</kbd> / <kbd>→</kbd> | <kbd>Page Down</kbd> / <kbd>→</kbd> | Navigate to the next page |
| <kbd>Page Up</kbd> / <kbd>←</kbd> | <kbd>Page Up</kbd> / <kbd>←</kbd> | Navigate to the previous page |
| <kbd>Enter</kbd> / <kbd>Space</kbd> | <kbd>Enter</kbd> / <kbd>Space</kbd> | Select the currently focused page |
| <kbd>Tab</kbd> | <kbd>Tab</kbd> | Move focus to the next pager item |
| <kbd>Shift</kbd> + <kbd>Tab</kbd> | <kbd>⇧</kbd> + <kbd>Tab</kbd> | Move focus to the previous pager item |
| <kbd>Home</kbd> | <kbd>Home</kbd> | Navigate to the first page |
| <kbd>End</kbd> | <kbd>End</kbd> | Navigate to the last page |
| <kbd>Alt</kbd> + <kbd>Page Up</kbd> | <kbd>⌥</kbd> + <kbd>Page Up</kbd> | Navigate to the previous pager group |
| <kbd>Alt</kbd> + <kbd>Page Down</kbd>| <kbd>⌥</kbd> + <kbd>Page Down</kbd> | Navigate to the next pager group |

|Windows | Mac |Description|
|-----|-----| --- |
|<kbd>Page down</kbd> / <kbd>→</kbd> | <kbd>Page down</kbd> / <kbd>→</kbd> |Navigates to the next page.|
|<kbd>Page up</kbd> / <kbd>←</kbd> | <kbd>Page up</kbd> / <kbd>←</kbd> | Navigates to the previous page.|
|<kbd>Enter</kbd> / <kbd>Space</kbd> | <kbd>Enter</kbd> / <kbd>Space</kbd> | Select the currently focused page.|
|<kbd>Tab</kbd> | <kbd>Tab</kbd> | Focus on the next pager item.|
|<kbd>Shift</kbd> + <kbd>Tab</kbd> | <kbd>⇧</kbd> + <kbd>Tab</kbd> | Focus on the previous pager item.|
|<kbd>Home</kbd> | <kbd>Home</kbd> | Navigates to the first page.|
|<kbd>End</kbd> | <kbd>End</kbd> | Navigates to the last page.|
|<kbd>Alt</kbd> + <kbd>Page up</kbd> | <kbd>⌥</kbd> + <kbd>Page up</kbd> | Navigates to the previous pager.|
|<kbd>Alt</kbd> + <kbd>Page down</kbd> | <kbd>⌥</kbd> + <kbd>Page down</kbd> | Navigates to the next pager.|

## Ensuring accessibility

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

An interactive sample is available to evaluate the component’s accessibility using standard tools:

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.
- [Accessibility Evaluation Sample](https://blazor.syncfusion.com/accessibility/pager)

## See also

Expand Down
82 changes: 82 additions & 0 deletions blazor/pager/behavior-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
layout: post
title: Behavior Settings in Blazor Pager Component | Syncfusion
description: Learn how to configure core behavior settings page size, numeric item count, total item count, and more in the Syncfusion Blazor Pager component.
platform: Blazor
control: Pager
documentation: ug
---

# Behavior Settings in Pager Component

The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component includes properties that control its rendering behavior, such as numeric items and navigation buttons. The total number of pages is determined by the values of the [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) properties.

**Core properties of the pager component**

* [PageSize](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_PageSize) – Specifies the number of items displayed per page.
* [NumericItemsCount](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_NumericItemsCount) – Defines the number of numeric items shown for navigation.
* [TotalItemsCount](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_TotalItemsCount) – Indicates the total number of items in the data collection.
* [CurrentPage](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_CurrentPage) – Sets the page to display initially.
* [ShowPagerMessage](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_ShowPagerMessage) – Controls the visibility of the pager information message.

## Page size

The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component provides the [PageSize](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_PageSize) property to define the number of items displayed per page. The default value is **12**.

```csharp
@using Syncfusion.Blazor.Navigations

<SfPager PageSize="5" TotalItemsCount="20">
</SfPager>

```

## Numeric items count

The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component provides the [NumericItemsCount](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_NumericItemsCount) property to define how many numeric navigation items are displayed in the pager. The default value is **10**.

```csharp
@using Syncfusion.Blazor.Navigations

<SfPager NumericItemsCount="5" TotalItemsCount="20" PageSize="4">
</SfPager>

```

## Total items count

The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component provides the [TotalItemsCount](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_TotalItemsCount) property to specify the total number of items in the data collection. This value is used to calculate the total number of pages and render numeric items and navigation buttons.

```csharp
@using Syncfusion.Blazor.Navigations

<SfPager TotalItemsCount="75">
</SfPager>

```

## Current page

The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component provides the [CurrentPage](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_CurrentPage) property to specify which page is displayed initially when the pager is rendered. The default value is **1**.

```csharp
@using Syncfusion.Blazor.Navigations

<SfPager CurrentPage="3" TotalItemsCount="20" PageSize="4" NumericItemsCount="5">
</SfPager>

```

## Show pager message

The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Pager component provides the [ShowPagerMessage](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Navigations.SfPager.html#Syncfusion_Blazor_Navigations_SfPager_ShowPagerMessage) property to control the visibility of the pager information message. The default value is **true**. Setting this property to **false** hides the message from the pager container.

```csharp
@using Syncfusion.Blazor.Navigations

<SfPager ShowPagerMessage="true" PageSize="4" NumericItemsCount="5" TotalItemsCount="20">
</SfPager>

```

![Show Blazor Pager Message](./images/blazor-pager-message.png)
74 changes: 0 additions & 74 deletions blazor/pager/behaviour-settings.md

This file was deleted.

17 changes: 10 additions & 7 deletions blazor/pager/customization.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,37 @@
---
layout: post
title: Customization in Blazor Pager Component | Syncfusion
description: Checkout here and learn about how to customize the elements of Syncfusion Blazor Pager component and much more.
description: Learn how to customize the Syncfusion Blazor Pager component, including custom text and styling options.
platform: Blazor
control: Pager
documentation: ug
---

# Customization in Pager Component

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.

## Custom text for numeric items

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.
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.

```csharp

@using Syncfusion.Blazor.Navigations

<SfPager TotalItemsCount="75" NumericItemPrefix="PageNo" PageSize="5" NumericItemsCount="2">
<SfPager TotalItemsCount="75"
PageSize="5"
NumericItemsCount="2"
NumericItemPrefix="PageNo">
</SfPager>

```

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

## Custom CSS

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.
## Apply custom CSS

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.
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.

```csharp

Expand Down
Loading