Skip to content

Commit 1ca80ff

Browse files
ActionList doc cleanup (#1879)
* refactor naming convention * upgrade sb * clarify stories for a11y testing * fix divider bug * Stylelint auto-fixes * make a11y page render (in a less cool way) * revert bug fix for new pr * lint Co-authored-by: Actions Auto Build <actions@github.com>
1 parent 499a70e commit 1ca80ff

13 files changed

+1629
-1748
lines changed

docs/package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,16 @@
4949
},
5050
"devDependencies": {
5151
"@babel/core": "^7.16.7",
52-
"@storybook/addon-a11y": "6.4.9",
53-
"@storybook/addon-actions": "^6.4.9",
54-
"@storybook/addon-essentials": "^6.4.9",
55-
"@storybook/addon-links": "^6.4.9",
52+
"@storybook/addon-a11y": "6.4.12",
53+
"@storybook/addon-actions": "^6.4.12",
54+
"@storybook/addon-essentials": "^6.4.12",
55+
"@storybook/addon-links": "^6.4.12",
5656
"@storybook/addon-postcss": "2.0.0",
5757
"@storybook/preset-scss": "^1.0.3",
58-
"@storybook/react": "6.4.9",
58+
"@storybook/react": "6.4.12",
5959
"@whitespace/storybook-addon-html": "^5.0.0",
6060
"babel-loader": "^8.2.3",
61-
"storybook-addon-designs": "6.2.0",
62-
"storybook-color-picker": "2.1.5"
61+
"storybook-addon-designs": "6.2.1",
62+
"storybook-color-picker": "2.3.0"
6363
}
6464
}

docs/src/stories/components/ActionList/Accessibility.stories.mdx

Lines changed: 0 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,6 @@ The `menu` role should be reserved for dropdown menu scenarios
4444
| `li` | has child link `role="none"` |
4545
| `a` | `role="menuitem"` |
4646

47-
#### Example
48-
49-
<Canvas>
50-
<Story id="components-actionlist-patterns--menu-with-section-divider" />
51-
</Canvas>
52-
5347
### Navigational list of links
5448

5549
[Navigation spec](https://www.w3.org/TR/wai-aria-practices-1.2/examples/landmarks/navigation.html)
@@ -58,12 +52,6 @@ Wrap `ActionList` in a `nav` element for site or page navigation, like a sidebar
5852

5953
No roles needed
6054

61-
#### Example
62-
63-
<Canvas>
64-
<Story id="components-actionlist-patterns--nav-with-sub-items" />
65-
</Canvas>
66-
6755
### Multi select dropdown menu
6856

6957
[Menu spec](https://www.w3.org/TR/wai-aria-practices-1.2/examples/menubar/menubar-2/menubar-2.html)
@@ -74,12 +62,6 @@ No roles needed
7462
| `li` | `role="menuitemcheckbox"` |
7563
| `li` | `aria-checked="true/false"` |
7664

77-
#### Example
78-
79-
<Canvas>
80-
<Story id="components-actionlist-patterns--menu-multi-select" />
81-
</Canvas>
82-
8365
### Single select dropdown menu
8466

8567
[Menu spec](https://www.w3.org/TR/wai-aria-practices-1.2/examples/menubar/menubar-2/menubar-2.html)
@@ -90,12 +72,6 @@ No roles needed
9072
| `li` | `role="menuitemradio"` |
9173
| `li` | `aria-checked="true/false"` |
9274

93-
#### Example
94-
95-
<Canvas>
96-
<Story id="components-actionlist-patterns--menu-single-select" />
97-
</Canvas>
98-
9975
### Multi select listbox
10076

10177
[Listbox spec](https://www.w3.org/TR/wai-aria-practices-1.2/examples/listbox/listbox-collapsible.html)
@@ -107,12 +83,6 @@ No roles needed
10783
| `li` | `role="option"` |
10884
| `li` | `aria-selected="true/false"` |
10985

110-
#### Example
111-
112-
<Canvas>
113-
<Story id="components-actionlist-patterns--list-multi-select" />
114-
</Canvas>
115-
11686
### Single select listbox
11787

11888
[Listbox spec](https://www.w3.org/TR/wai-aria-practices-1.2/examples/listbox/listbox-collapsible.html)
@@ -125,42 +95,14 @@ Note: JS is required for to provide [keyboard handling](https://www.w3.org/TR/wa
12595
| `li` | `role="option"` |
12696
| `li` | `aria-selected="true/false"` |
12797

128-
#### Example
129-
130-
<Canvas>
131-
<Story id="components-actionlist-patterns--list-single-select" />
132-
</Canvas>
133-
134-
### List of links
135-
136-
No roles needed
137-
138-
#### Example
139-
140-
<Canvas>
141-
<Story id="components-actionlist-patterns--list" />
142-
</Canvas>
143-
14498
### Dividers
14599

146100
| Element | Role |
147101
| :------ | :----------------- |
148102
| `li` | `role="separator"` |
149103

150-
#### Empty example
151-
152-
<Canvas>
153-
<Story id="components-actionlist-actionlistitem-features--divider-empty" />
154-
</Canvas>
155-
156104
| Element | Role |
157105
| :------ | :------------------------------------------ |
158106
| `li` | `role="presentation"` |
159107
| `li` | id for nested group `id="group-id"` |
160108
| `li` | if it has id for group `aria-hidden="true"` |
161-
162-
#### With title example
163-
164-
<Canvas>
165-
<Story id="components-actionlist-actionlistitem-features--divider-text" />
166-
</Canvas>

docs/src/stories/components/ActionList/ActionList.stories.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import clsx from 'clsx'
33
import {ListItemTemplate} from './ActionListItem.stories'
44

55
export default {
6-
title: 'Components/ActionList',
6+
title: 'Components/ActionList/ActionList',
77
excludeStories: ['ListTemplate'],
88
parameters: {
99
design: {
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
import React from 'react'
2+
import clsx from 'clsx'
3+
import {ListTemplate} from './ActionList.stories'
4+
import {ListItemTemplate} from './ActionListItem.stories'
5+
import {DividerTemplate} from './ActionListDivider.stories'
6+
7+
export default {
8+
title: 'Components/ActionList/ActionListDivider/Features',
9+
decorators: [
10+
Story => (
11+
<ul className="ActionList" role="menu">
12+
<Story />
13+
</ul>
14+
)
15+
]
16+
}
17+
18+
export const WithTitle = DividerTemplate.bind({})
19+
WithTitle.args = {
20+
title: 'List group title'
21+
}
22+
23+
export const Subtle = DividerTemplate.bind({})
24+
Subtle.args = {
25+
variant: 'subtle',
26+
title: 'List group title'
27+
}
28+
29+
export const Filled = DividerTemplate.bind({})
30+
Filled.args = {
31+
variant: 'ActionList-sectionDivider--filled',
32+
title: 'List group title'
33+
}
34+
35+
export const WithDescription = DividerTemplate.bind({})
36+
WithDescription.args = {
37+
title: 'List group title',
38+
description: 'Group description'
39+
}
40+
41+
export const RolePresentation = DividerTemplate.bind({})
42+
RolePresentation.storyName = '[role="presentation"]'
43+
RolePresentation.args = {
44+
title: 'List group title'
45+
}
46+
47+
export const RoleSeparator = DividerTemplate.bind({})
48+
RoleSeparator.storyName = '[role="separator"]'
49+
RoleSeparator.args = {}
50+
51+
export const Empty = DividerTemplate.bind({})

0 commit comments

Comments
 (0)