Skip to content

Commit 437ca8c

Browse files
committed
📝 docs: improve storybook table categories
1 parent 6f643b9 commit 437ca8c

32 files changed

+315
-14
lines changed

src/components/Divider/stories/ColoredDivider.stories.tsx

+4-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ import { ColoredDivider, ColoredDividerProps } from '../ColoredDivider';
88
import dividerStory from './Divider.stories';
99

1010
const argTypes = { ...dividerStory.argTypes };
11-
delete argTypes.contrast;
12-
delete argTypes.variant;
1311

1412
export default {
1513
...dividerStory,
@@ -29,6 +27,10 @@ export default {
2927
},
3028
parameters: {
3129
...dividerStory.parameters,
30+
controls: {
31+
...dividerStory.parameters?.controls,
32+
exclude: ['contrast', 'variant'],
33+
},
3234
docs: {
3335
...dividerStory.parameters?.docs,
3436
page: () => (

src/components/Divider/stories/StyledDivider.stories.tsx

+4-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ import { StyledDivider, StyledDividerProps } from '../StyledDivider';
66
import dividerStory from './Divider.stories';
77

88
const argTypes = { ...dividerStory.argTypes };
9-
delete argTypes.contrast;
10-
delete argTypes.themeId;
11-
delete argTypes.variant;
129

1310
export default {
1411
...dividerStory,
@@ -24,6 +21,10 @@ export default {
2421
},
2522
parameters: {
2623
...dividerStory.parameters,
24+
controls: {
25+
...dividerStory.parameters?.controls,
26+
exclude: ['contrast', 'themeId', 'variant'],
27+
},
2728
docs: {
2829
...dividerStory.parameters?.docs,
2930
page: () => (

src/components/Footer/stories/StyledFooter.stories.tsx

+21
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,27 @@ export default {
1414
title: 'Surfaces/Footer/StyledFooter',
1515
component: StyledFooter,
1616
argTypes: {
17+
height: {
18+
table: {
19+
category: 'Appearance',
20+
},
21+
},
22+
23+
backgroundColor: {
24+
table: {
25+
category: 'Styled',
26+
},
27+
},
28+
borderColor: {
29+
table: {
30+
category: 'Styled',
31+
},
32+
},
33+
textColor: {
34+
table: {
35+
category: 'Styled',
36+
},
37+
},
1738
footerColor: {
1839
table: {
1940
category: 'Styled',

src/components/Form/Fieldset/stories/Fieldset.stories.tsx

+3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ export default {
1515
control: {
1616
type: 'text',
1717
},
18+
table: {
19+
category: 'Appearance',
20+
},
1821
},
1922

2023
className: {

src/components/Form/Label/stories/StyledLabel.stories.tsx

+5
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ export default {
2929
category: 'Styled',
3030
},
3131
},
32+
mutedTextColor: {
33+
table: {
34+
category: 'Styled',
35+
},
36+
},
3237
textColor: {
3338
table: {
3439
category: 'Styled',

src/components/Form/Slider/stories/MultiColorSlider.stories.tsx

+15
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ export default {
1515
},
1616
},
1717

18+
colors: {
19+
table: {
20+
category: 'Appearance',
21+
},
22+
},
1823
scale: {
1924
options: ['small', undefined],
2025
control: {
@@ -47,6 +52,16 @@ export default {
4752
category: 'Input',
4853
},
4954
},
55+
id: {
56+
table: {
57+
category: 'Input',
58+
},
59+
},
60+
name: {
61+
table: {
62+
category: 'Input',
63+
},
64+
},
5065
value: {
5166
table: {
5267
category: 'Input',

src/components/Form/Toggle/stories/Toggle.stories.tsx

+1
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ export default {
110110
],
111111
parameters: {
112112
controls: {
113+
exclude: ['aria-label'],
113114
sort: 'requiredFirst',
114115
},
115116
docs: {

src/components/Header/stories/StyledHeader.stories.tsx

+21
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,32 @@ export default {
1414
title: 'Surfaces/Header/StyledHeader',
1515
component: StyledHeader,
1616
argTypes: {
17+
height: {
18+
table: {
19+
category: 'Styled',
20+
},
21+
},
22+
23+
backgroundColor: {
24+
table: {
25+
category: 'Styled',
26+
},
27+
},
28+
borderColor: {
29+
table: {
30+
category: 'Styled',
31+
},
32+
},
1733
headerColor: {
1834
table: {
1935
category: 'Styled',
2036
},
2137
},
38+
textColor: {
39+
table: {
40+
category: 'Styled',
41+
},
42+
},
2243
...argTypes,
2344
},
2445
parameters: {

src/components/Link/stories/Link.stories.tsx

+5
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ export default {
5252
category: 'Uncommon',
5353
},
5454
},
55+
rel: {
56+
table: {
57+
category: 'Uncommon',
58+
},
59+
},
5560
style: {
5661
table: {
5762
category: 'Uncommon',

src/components/Link/stories/LinkContainer.stories.tsx

+6
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ export default {
1515
},
1616
},
1717

18+
target: {
19+
table: {
20+
category: 'Anchor',
21+
},
22+
},
23+
1824
underline: {
1925
table: {
2026
category: 'Appearance',

src/components/List/stories/List.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ export default {
134134
},
135135
parameters: {
136136
controls: {
137-
exclude: ['children'],
137+
exclude: ['aria-label', 'children'],
138138
sort: 'requiredFirst',
139139
},
140140
docs: {

src/components/Progress/stories/Progress.stories.tsx

+1
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ export default {
106106
],
107107
parameters: {
108108
controls: {
109+
exclude: ['aria-label'],
109110
sort: 'requiredFirst',
110111
},
111112
docs: {

src/components/Progress/stories/StyledProgress.stories.tsx

+4-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ import { StyledProgress, StyledProgressProps } from '../StyledProgress';
77
import progressStory from './Progress.stories';
88

99
const argTypes: Partial<ArgTypes<ProgressProps>> = { ...progressStory.argTypes };
10-
delete argTypes.color;
11-
delete argTypes.contrast;
12-
delete argTypes.themeId;
1310

1411
export default {
1512
...progressStory,
@@ -35,6 +32,10 @@ export default {
3532
},
3633
parameters: {
3734
...progressStory.parameters,
35+
controls: {
36+
...progressStory.parameters?.controls,
37+
exclude: ['color', 'contrast', 'theme', 'aria-label'],
38+
},
3839
docs: {
3940
...progressStory.parameters?.docs,
4041
page: () => (

src/components/Rhythm/stories/Rhythm.stories.tsx

+11
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,17 @@ export default {
1717
},
1818
},
1919

20+
grouped: {
21+
table: {
22+
category: 'Container',
23+
},
24+
},
25+
wrapper: {
26+
table: {
27+
category: 'Container',
28+
},
29+
},
30+
2031
m: {
2132
control: {
2233
type: 'number',

src/components/Shade/stories/StyledShade.stories.tsx

+4-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ import { StyledShade } from '../StyledShade';
77
import shadeStory from './Shade.stories';
88

99
const argTypes = { ...shadeStory.argTypes };
10-
delete argTypes.color;
11-
delete argTypes.themeId;
1210

1311
export default {
1412
...shadeStory,
@@ -39,6 +37,10 @@ export default {
3937
},
4038
parameters: {
4139
...shadeStory.parameters,
40+
controls: {
41+
...shadeStory.parameters?.controls,
42+
exclude: ['color', 'theme', 'themeId'],
43+
},
4244
docs: {
4345
...shadeStory.parameters?.docs,
4446
page: () => (

src/components/Tag/stories/Tag.stories.tsx

+14
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ export default {
5151
},
5252
},
5353

54+
onClick: {
55+
table: {
56+
category: 'Actions',
57+
},
58+
},
59+
5460
as: {
5561
control: {
5662
disable: true,
@@ -203,6 +209,14 @@ LargeSize.args = {
203209
size: 'large',
204210
};
205211

212+
export const Actionable = Template.bind({});
213+
Actionable.storyName = 'Actionable';
214+
Actionable.args = {
215+
...defaultArgs,
216+
actionable: true,
217+
onClick: () => console.log('clicked'),
218+
};
219+
206220
export const ActiveState = Template.bind({});
207221
ActiveState.storyName = 'State: Active';
208222
ActiveState.args = {

src/components/Triangle/stories/Triangle.stories.tsx

+9-3
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,20 @@ export default {
1212
control: {
1313
type: 'color',
1414
},
15-
category: 'Appearance',
15+
table: {
16+
category: 'Appearance',
17+
},
1618
},
1719
position: {
1820
control: 'radio',
19-
category: 'Appearance',
21+
table: {
22+
category: 'Appearance',
23+
},
2024
},
2125
size: {
22-
category: 'Appearance',
26+
table: {
27+
category: 'Appearance',
28+
},
2329
},
2430

2531
className: {

src/compositions/Accordion/stories/Accordion.stories.tsx

+5
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,11 @@ export default {
6161
},
6262
},
6363

64+
onKeyDown: {
65+
table: {
66+
category: 'Actions',
67+
},
68+
},
6469
onSelect: {
6570
table: {
6671
category: 'Actions',

src/compositions/Chip/stories/Chip.stories.tsx

+7
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,12 @@ export default {
7272
},
7373
},
7474

75+
onClick: {
76+
table: {
77+
category: 'Actions',
78+
},
79+
},
80+
7581
as: {
7682
control: {
7783
disable: true,
@@ -201,6 +207,7 @@ Actionable.args = {
201207
...defaultArgs,
202208
actionable: true,
203209
avatar: { initials: 'P', color: 'primary' as AvatarProps['color'] },
210+
onClick: () => console.log('clicked'),
204211
size: 'medium',
205212
};
206213

src/compositions/Dropdown/stories/Dropdown.stories.tsx

+5
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,11 @@ export default {
6262
category: 'Appearance',
6363
},
6464
},
65+
renderLabel: {
66+
table: {
67+
category: 'Appearance',
68+
},
69+
},
6570
size: {
6671
table: {
6772
category: 'Appearance',

src/compositions/Dropdown/stories/DropdownWithTags.stories.tsx

+5
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,11 @@ export default {
6262
category: 'Appearance',
6363
},
6464
},
65+
renderLabel: {
66+
table: {
67+
category: 'Appearance',
68+
},
69+
},
6570
size: {
6671
table: {
6772
category: 'Appearance',

0 commit comments

Comments
 (0)