🌐 AI搜索 & 代理 主页
Skip to content

Commit 7714ec4

Browse files
docs(a11y): add references to reduced motion for certain component animations (#4896)
* docs(a11y): add references to reduced motion for certain component animations * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update package.json * Update README.md Co-authored-by: Jacob M��ller <jacob.mueller.elz@gmail.com>
1 parent 3fa3147 commit 7714ec4

File tree

7 files changed

+36
-4
lines changed

7 files changed

+36
-4
lines changed

src/components/carousel/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,4 +312,9 @@ features. It is highly recommended to always add an ID to all components.
312312
All carousel controls and indicators have aria labels. These can be customized by setting the
313313
various `label-*` props.
314314

315+
**Note:** The animation effect of this component is dependent on the `prefers-reduced-motion` media
316+
query. See the
317+
[reduced motion section of our accessibility documentation](/docs/reference/accessibility) for
318+
additional details.
319+
315320
<!-- Component reference added automatically from component package.json -->

src/components/collapse/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,4 +295,9 @@ inside an element with `role="tablist"` and set `role="tab"` on each trigger ele
295295
order to help screen reader users navigate the accordion group. Unfortunately, BootstrapVue cannot
296296
apply those roles for you automatically, as it depends on your final document markup.
297297

298+
**Note:** The animation effect of this component is dependent on the `prefers-reduced-motion` media
299+
query. See the
300+
[reduced motion section of our accessibility documentation](/docs/reference/accessibility) for
301+
additional details.
302+
298303
<!-- Component reference added automatically from component package.json -->

src/components/form-timepicker/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,6 @@
209209
"slots": [
210210
{
211211
"name": "button-content",
212-
"version": "2.6.0",
213212
"description": "Content to place in the timepicker's icon button",
214213
"scope": [
215214
{

src/components/modal/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ present, nor can you use the `modal-title` slot.
4040
Modals will not render their content in the document until they are shown (lazily rendered). Modals,
4141
when visible, are rendered **appended to the `<body>` element**. The placement of the `<b-modal>`
4242
component will not affect layout, as it always renders as a placeholder comment node (`<!---->`).
43-
You can revert to the behaviour of previous BootstrapVue versions via the use of the
43+
You can revert to the behaviour of older BootstrapVue versions via the use of the
4444
[`static` prop](#lazy-loading-and-static-modals).
4545

4646
## Toggle modal visibility
@@ -1021,6 +1021,11 @@ emitted.
10211021
`<b-modal>` provides several accessibility features, including auto focus, return focus, keyboard
10221022
(tab) _focus containment_, and automated `aria-*` attributes.
10231023

1024+
**Note:** The animation effect of this component is dependent on the `prefers-reduced-motion` media
1025+
query. See the
1026+
[reduced motion section of our accessibility documentation](/docs/reference/accessibility) for
1027+
additional details.
1028+
10241029
### Modal ARIA attributes
10251030

10261031
The `aria-labelledby` and `aria-describedby` attributes will appear on the modal automatically in
@@ -1035,11 +1040,11 @@ most cases.
10351040
- If the `aria-label` prop is specified with a string value, the `aria-labelledby` attribute will
10361041
not be rendered, even if you have a title/header for your modal.
10371042

1038-
The `aria-label` and `title-sr-only` props were added in version 2.0.0-rc.27.
1043+
The `aria-label` and `title-sr-only` props were added in version `v2.0.0-rc.27`.
10391044

10401045
### Auto focus on open
10411046

1042-
`<b-modal>` will autofocus the modal container when opened.
1047+
`<b-modal>` will autofocus the modal _container_ when opened.
10431048

10441049
You can pre-focus an element within the `<b-modal>` by listening to the `<b-modal>` `shown` event,
10451050
and call the element's `focus()` method. `<b-modal>` will not attempt to autofocus if an element

src/components/popover/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -910,6 +910,11 @@ possible. When the popover is closed, you should return focus back to your trigg
910910
You may also want to implement focus containment in the popover content while the user is
911911
interacting with it (keeping focus inside the popover until it is closed by the user).
912912

913+
**Note:** The animation effect of this component is dependent on the `prefers-reduced-motion` media
914+
query. See the
915+
[reduced motion section of our accessibility documentation](/docs/reference/accessibility) for
916+
additional details.
917+
913918
### Making popovers work for keyboard and assistive technology users
914919

915920
To allow keyboard users to activate your popovers, you should only add them to HTML elements that

src/components/progress/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,9 @@ Notes:
313313

314314
- if `animated` is true, `striped` will automatically be enabled.
315315
- Animated progress bars don't work in Opera 12 — as they don't support CSS3 animations.
316+
- The animation effect of this component is dependent on the `prefers-reduced-motion` media query.
317+
See the [reduced motion section of our accessibility documentation](/docs/reference/accessibility)
318+
for additional details.
316319

317320
## Multiple bars
318321

src/components/tooltip/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -527,4 +527,14 @@ export default {
527527
Refer to the [Events](/docs/components/tooltip#component-reference) section of documentation for the
528528
full list of events.
529529

530+
## Accessibility
531+
532+
The trigger element, when the tooltip is showing, will have the attribute `aria-describedby` set
533+
with the auto generated ID of the tooltip.
534+
535+
**Note:** The animation effect of this component is dependent on the `prefers-reduced-motion` media
536+
query. See the
537+
[reduced motion section of our accessibility documentation](/docs/reference/accessibility) for
538+
additional details.
539+
530540
<!-- Component reference added automatically from component package.json -->

0 commit comments

Comments
 (0)