-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Initial spin-button a11y commit #24075
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
5f93f24
Initial spin-button a11y commit
jxlz ec67cfe
Update packages/react-components/react-spinbutton/src/stories/SpinBut…
jxlz 73152cc
Update packages/react-components/react-spinbutton/src/stories/SpinBut…
jxlz deaa828
Update SpinButtonAccessibility.md
jxlz 7a46120
Merge branch 'master' of https://github.com/microsoft/fluentui into s…
jxlz e53ed1f
Change files
jxlz e557e31
Update SpinButtonAccessibility.md
jxlz 62d0b1a
Apply suggestions from code review
jxlz ce0b1a6
Update SpinButtonAccessibility.md
jxlz 7dd91d5
Update packages/react-components/react-spinbutton/src/stories/SpinBut…
jxlz df44603
Update packages/react-components/react-spinbutton/src/stories/SpinBut…
jxlz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
7 changes: 7 additions & 0 deletions
7
change/@fluentui-react-spinbutton-803b9a0b-82dd-471f-b57d-7717eb0d925d.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "none", | ||
| "comment": "Merge branch 'master' of https://github.com/microsoft/fluentui into spin-button", | ||
| "packageName": "@fluentui/react-spinbutton", | ||
| "email": "jennz@microsoft.com", | ||
| "dependentChangeType": "none" | ||
| } | ||
100 changes: 100 additions & 0 deletions
100
...t-components/react-spinbutton/src/stories/SpinButton/SpinButtonAccessibility.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| ## Component features and behavior | ||
|
|
||
| This section documents accessibility-related behavoirs of spin buttons. | ||
|
|
||
| ### Keyboarding | ||
|
|
||
| #### Tab Order | ||
| 1. Value field | ||
|
jxlz marked this conversation as resolved.
|
||
|
|
||
| #### States | ||
| 1. Rest (Focused) | ||
| 2. Editing (Focused and editing) | ||
|
|
||
| #### Keyboard State Diagram | ||
|
|
||
| | Starting state | Transition | Resulting state | | ||
| | ---------- | ------------ | ------- | | ||
| | Content before spin button | Tab | Rest | | ||
| | Rest | Tab | Content after spin button | | ||
| | Editing | Tab | Content after spin button (Value committed) | | ||
| | Editing | Enter | Rest (Value committed)| | ||
| | Rest | Any Edit Key (that results in a change) | Editing | | ||
| | Editing | Any Edit Key | Editing | | ||
| | Content after spin button (Value committed) | Shift + Tab | Rest | | ||
|
|
||
| ##### Edit keys | ||
| | Edit Key | Result | | ||
| | ---------- | ------------ | | ||
| | Home | First item in defined range | | ||
| | End | Last item in defined range | | ||
| | Up arrow | Increments value higher, based on the step prop (defaulting to 1) | | ||
| | Down arrow | Increments value lower, based on the step prop (defaulting to 1) | | ||
| | Page up | Increments value higher, based on the stepPage prop (defaulting to 1) | | ||
| | Page down | Increments value lower, based on the stepPage prop (defaulting to 1) | | ||
| | Typing valid value | Valid value | | ||
|
|
||
| ### High contrast mode | ||
|
|
||
| Be careful about visibility of the spin button arrows in high contrast mode. | ||
|
smhigley marked this conversation as resolved.
|
||
| TODO: Either add specifics about SVGs in high contrast and how to customize the icon color without messing up HCM or (ideally) link to the Icon section on high contrast, when it exists. | ||
|
|
||
| ### Motion and animation | ||
|
jxlz marked this conversation as resolved.
|
||
|
|
||
| There is an animation when this element receives focus. This respects reduced-motion media queries. | ||
|
|
||
| When a user holds down an edit key or mouse click, there is an animation of spinning numbers to provide a sense of how fast the value is changing. This animation is an interaction cue and therefore is acceptable even when a user has set a preference for reduced motion. | ||
|
|
||
| ### Semantics | ||
|
|
||
| ## Known issues | ||
|
|
||
| Placeholder: If there are any current known bugs with browsers or AT that impact this component, list them here. | ||
|
|
||
| Mouse press quick changes to value are not announced to screen readers. | ||
|
jxlz marked this conversation as resolved.
|
||
|
|
||
|
jxlz marked this conversation as resolved.
|
||
| ## Usage | ||
|
|
||
|
|
||
|
|
||
| ### When to choose Spin button | ||
|
|
||
| SpinButtons allow someone to incrementally adjust a value in small steps. | ||
|
jxlz marked this conversation as resolved.
|
||
|
|
||
| SpinButtons are a better choice than Input and Input with type: number when clear indication is needed that there are maximum and minimum allowed values. | ||
|
|
||
| SpinButtons are a better choice than Slider when there are many valid values and Slider would not provide enough granularity to choose a precise value. | ||
|
|
||
| ### Required props | ||
|
|
||
| Placeholder: If there are any props or other specific work that the author must do to make the default usage of the component accessible, list those here. One example is that all form components must have a label provided by the author. If the component has any internally defined strings that should be localized, list those here. | ||
|
jxlz marked this conversation as resolved.
Outdated
|
||
|
|
||
| Open question: How does everything read? Name, role, value? What about when there are prefixes or postfixes? | ||
|
jxlz marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Styling | ||
|
|
||
|
|
||
|
|
||
| ### Advanced usage | ||
|
|
||
| Placeholder: Cover potential use cases not included in our storybook examples here (or even included storybook examples, if they're complex require a notable amout of work or nuanced understanding from authors) | ||
|
|
||
| #### Child content restrictions | ||
|
|
||
| The component has the following structure: | ||
| * Input field | ||
| * Up button | ||
| * Up carat symbol | ||
|
jxlz marked this conversation as resolved.
Outdated
|
||
| * Down button | ||
| * Down carat symbol | ||
|
jxlz marked this conversation as resolved.
Outdated
|
||
|
|
||
|
|
||
| #### Component-specific usage warnings | ||
|
jxlz marked this conversation as resolved.
|
||
|
|
||
| [NVDA does not read the value of spinbuttons in Chromium](https://github.com/nvaccess/nvda/issues/13195) | ||
|
|
||
| [Narrator defaults to reading min/max as 0 when they're (intentionally) undefined](https://microsoft.visualstudio.com/Edge/_workitems/edit/39070743) | ||
|
|
||
| ## Extending [component name] | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.