Skip to content
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.

Sign up for GitHub

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

docs(SelectPanel): update docs with keyboard interactions #2335

Merged
merged 10 commits into from
Oct 10, 2022
Merged

docs(SelectPanel): update docs with keyboard interactions #2335

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a54be28
docs(SelectPanel): update docs with keyboard interactions
joshblack Sep 14, 2022
c91688a
Update docs/content/SelectPanel.mdx
joshblack Sep 16, 2022
320392b
Update docs/content/SelectPanel.mdx
joshblack Sep 16, 2022
7d880a3
Update docs/content/SelectPanel.mdx
joshblack Sep 16, 2022
da25394
Update docs/content/SelectPanel.mdx
joshblack Sep 16, 2022
6074ce9
Update docs/content/SelectPanel.mdx
joshblack Sep 16, 2022
5c96041
docs: add selected and onSelectedChanges to docs
joshblack Oct 10, 2022
c756253
Merge branch 'main' of github.com:primer/react into docs/add-keyboard…
joshblack Oct 10, 2022
e619499
chore: update SelectPanel docs
joshblack Oct 10, 2022
d3a7a13
Merge branch 'main' into docs/add-keyboard-behavior-to-select-panel
joshblack Oct 10, 2022
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
83 changes: 82 additions & 1 deletion docs/content/SelectPanel.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,85 @@ function DemoComponent() {
render(<DemoComponent />)
```

## Component props
## Accessibility

### Keyboard

Pressing `Enter` or `Space` on the `SelectPanel` anchor will
open the `SelectPanel` and place focus on the filter input. Pressing `Escape` or interacting with the cancel or close buttons will close the `SelectPanel` and restore focus to the anchor.

A user may use `Tab` and `Shift+Tab` to navigate between the filter input, list of
items, action buttons, and the close button.

When focus is on the list of items, pressing `ArrowDown` and `ArrowUp` will allow navigation between items. Support for `Home` and `End` is also provided to quickly navigate to the first and last items in the list, respectively. Pressing `Space` will select an item.

The `Enter` key may be used when focus is within the `SelectPanel` as an
alternative to activating the save button.

## Props

### SelectPanel

<!-- TODO: add remaining props -->

<PropsTable>
joshblack marked this conversation as resolved.
Show resolved Hide resolved
<PropsTableRow
name="onOpenChange"
type={`(
open: boolean,
gesture:
| 'anchor-click'
| 'anchor-key-press'
| 'click-outside'
| 'escape'
| 'selection'
) => void`}
required
/>
<PropsTableRow name="placeholder" type="string" />
<PropsTableRow
name="overlayProps"
type="Partial<OverlayProps>"
description={
<>
See <a href="/react/Overlay#props">Overlay props</a>.
</>
}
/>
joshblack marked this conversation as resolved.
Show resolved Hide resolved
<PropsTableRow name="title" type="string" />
<PropsTableRow name="inputLabel" type="string" />
<PropsTableRow name="inputPlaceholder" type="string" />

<PropsTableRow
name="selected"
type="ItemInput | ItemInput[] | undefined"
description="Specify the selected item(s)"
/>
<PropsTableRow
name="onSelectedChange"
type="(selected: ItemInput | ItemInput[]) => void"
description="Provide a callback called when the selected item(s) change"
/>

</PropsTable>
joshblack marked this conversation as resolved.
Show resolved Hide resolved

## Status

<ComponentChecklist
items={{
propsDocumented: false,
noUnnecessaryDeps: true,
adaptsToThemes: true,
adaptsToScreenSizes: true,
fullTestCoverage: false,
usedInProduction: true,
usageExamplesDocumented: false,
hasStorybookStories: false,
designReviewed: false,
a11yReviewed: false,
stableApi: false,
addressedApiFeedback: false,
hasDesignGuidelines: false,
hasFigmaComponent: false
}}
/>