Extra 25% off for all sale items + Free CoreUI Icons PRO with every order! Limited offer for the first 100 people, use code 2024BWCW25 during checkout.
Documentation and examples for showing Angular pagination to indicate a series of related content exists across multiple pages.
Loading...
## Overview
We use a large block of connected links for our pagination, making links hard to miss and easily scalable—all while providing large hit areas. Pagination is built with list HTML elements so screen readers can announce the number of available links. Use a wrapping `<nav>` element to identify it as a navigation section to screen readers and other assistive technologies.
In addition, as pages likely have more than one such navigation section, it's advisable to provide a descriptive `aria-label` for the `<nav>` to reflect its purpose. For example, if the pagination component is used to navigate between a set of search results, an appropriate label could be `aria-label="Search results pages"`.
Loading...
Loading...
Loading...
## Working with icons
Looking to use an icon or symbol in place of text for some pagination links? Be sure to provide proper screen reader support with `aria` attributes.
Loading...
Loading...
Loading...
## Disabled and active states
Pagination links are customizable for different circumstances. Use `disabled` for links that appear un-clickable and `.active` to indicate the current page.
While the `disabled` prop uses `pointer-events: none` to _try_ to disable the link functionality of `<a>`s, that CSS property is not yet standardized and doesn't account for keyboard navigation. As such, we always add `tabindex="-1"` on disabled links and use custom JavaScript to fully disable their functionality.
Loading...
Loading...
Loading...
You can optionally swap out active or disabled anchors for `<span>`, or omit the anchor in the case of the prev/next arrows, to remove click functionality and prevent keyboard focus while retaining intended styles.
Loading...
Loading...
Loading...
## Sizing
Fancy larger or smaller pagination? Add `size="lg"` or `size="sm"` for additional sizes.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
## Alignment
Change the alignment of pagination components with [flexbox utilities](https://coreui.io/docs/utilities/flex/).
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
---
## API
### Pagination Module
```typescript
import { PaginationModule } from '@coreui/angular';
@NgModule({
imports: [PaginationModule,]
})
export class AppModule(){}
```
---
### c-pagination
_component_
| name | description | type | default |
| ---- | ----------- | ---- | ------- |
| `align` | Set the alignment of pagination components. | ``""`` \| ``"start"`` \| ``"end"`` \| ``"center"`` | `''` |
| `role` | Default role for pagination. | `string` | `'navigation'` |
| `size` | Size the component small or large. | ``"sm"`` \| ``"lg"`` | |
| name | description | type | default |
| ---- | ----------- | ---- | ------- |
| `active` | Toggle the active state for the component. | `boolean` | |
| `disabled` | Toggle the disabled state for the component. | `boolean` | |