Skip to content

Commit 9acdf00

Browse files
authored
docs(pagination): minor updates
1 parent fed31e4 commit 9acdf00

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

docs/components/pagination/README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,13 @@
1111
<b-pagination size="md" :total-rows="100" v-model="currentPage" :per-page="10">
1212
</b-pagination>
1313

14-
<br>
15-
<br>
14+
<br><br>
1615

1716
<h6>Small</h6>
1817
<b-pagination size="sm" :total-rows="100" v-model="currentPage" :per-page="10">
1918
</b-pagination>
2019

21-
<br>
22-
<br>
20+
<br><br>
2321

2422
<h6>Large</h6>
2523
<b-pagination size="lg" :total-rows="100" v-model="currentPage" :per-page="10">
@@ -46,11 +44,11 @@ The value should be bound via `v-model` in your app. Page numbers are indexed fr
4644
of pages is computed from the provided prop values for `total-rows` and `per-page`.
4745

4846
### Customizing
49-
`<b-pagination>` supports selveral props that allow you to customize the apperance.
47+
`<b-pagination>` supports several props that allow you to customize the apperance.
5048

5149
| Prop | Description
5250
| ---- | -----------
53-
| `limit` | Limit the maximum numbr of page buttons (including ellipsis if present, but not the first/prev/next/last buttons)
51+
| `limit` | Limit the maximum numbr of displayed page buttons (including ellipsis if present, and excluding first/prev/next/last buttons)
5452
| `total-rows` | The total number of records in your data
5553
| `per-page` | The maximum number of data records per page
5654
| `first-text` | The "goto first page" button text (html supported)
@@ -77,12 +75,17 @@ along with the goto _first_, _prev_, _next_, and _last_ buttons.
7775

7876
### Accessibility
7977
The `<b-pagination>` component provides many features to support assistive technology users,
80-
including `aria-label`, `aria-posinset` and `aria-setsize`. The features are
78+
including `aria-label`, `aria-posinset` and `aria-setsize`. The attributes are
8179
automatically aplied, and can be cusomized.
8280

83-
#### Accessibility:
81+
Whan pagination is controling anohter component on the page (such as `<b-table>`), add
82+
the `aria-controls="<element-id>"` attribute to `<b-pagination>` and set its value
83+
to the `id` of the element it is controling. This will help non-sighted users know
84+
what component is being updated/controlled.
85+
86+
#### ARIA labels:
8487
`<b-pagination>` provides various `*-label-*` props which are used to set the `aria-label`
85-
attributes on the various elements within the component, to help users of
88+
attributes on the various elements within the component, which will help users of
8689
assistive technology.
8790

8891
| Prop | `aria-label` content default
@@ -91,8 +94,8 @@ assistive technology.
9194
| `label-prev-page` | "Goto previous page"
9295
| `label-next-page` | "Goto next page"
9396
| `label-last-page` | "Goto last page"
94-
| `label-page` | "Goto page" apprended with the page number
95-
| `aria-label` | "Pagination". applied to the outer pagination container
97+
| `label-page` | "Goto page", appended with the page number
98+
| `aria-label` | "Pagination", applied to the outer pagination container
9699

97100
#### Keyboard navigtion support:
98101
`<b-pagination>` supports keyborad navigation out of the box.

0 commit comments

Comments
 (0)