Skip to content

Commit 113df44

Browse files
committed
update storybook structure
1 parent 51768bc commit 113df44

File tree

75 files changed

+120
-122
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+120
-122
lines changed

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
"scripts": {
2424
"setup": "corepack enable && corepack prepare [email protected] --activate",
2525
"build": "turbo run build",
26+
"dev": "turbo run dev",
2627
"build:storybook": "turbo run --no-cache build:storybook",
2728
"generate": "turbo run generate && turbo run format",
2829
"preinstall": "npx only-allow pnpm",
@@ -31,7 +32,7 @@
3132
"lint": "turbo run lint --filter='./packages/*'",
3233
"lint:fix": "turbo run lint:fix --filter='./packages/*'",
3334
"clean": "pnpm -r --stream clean && rm -rf node_modules",
34-
"dev": "turbo run dev --no-cache --parallel --continue --filter='./packages/*'",
35+
"dev:web": "pnpm run build --filter \"@utilitywarehouse/css-reset\" && pnpm run dev --filter \"@utilitywarehouse/web-ui\"",
3536
"changeset": "changeset",
3637
"ci:version": "changeset version && pnpm install --no-frozen-lockfile",
3738
"ci:publish": "NODE_OPTIONS=\"--max_old_space_size=4096\" pnpm run build && changeset publish",

packages/design-tokens/build/native/dark/tokens-dark.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Do not edit directly
3-
* Generated on Thu Nov 21 2024 19:55:00 GMT+0000 (Coordinated Universal Time)
3+
* Generated on Mon Nov 25 2024 16:04:12 GMT+0000 (Greenwich Mean Time)
44
*/
55

66
export const tokens = {

packages/design-tokens/build/native/default/tokens-default.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Do not edit directly
3-
* Generated on Thu Nov 21 2024 19:55:00 GMT+0000 (Coordinated Universal Time)
3+
* Generated on Mon Nov 25 2024 16:04:12 GMT+0000 (Greenwich Mean Time)
44
*/
55

66
export const tokens = {

packages/design-tokens/build/native/light/tokens-light.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Do not edit directly
3-
* Generated on Thu Nov 21 2024 19:55:00 GMT+0000 (Coordinated Universal Time)
3+
* Generated on Mon Nov 25 2024 16:04:12 GMT+0000 (Greenwich Mean Time)
44
*/
55

66
export const tokens = {

packages/web-ui/.storybook/preview.js

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
import '@utilitywarehouse/fontsource';
2-
import '@utilitywarehouse/css-reset';
3-
import { breakpoints, Box } from '../src';
41
import { INITIAL_VIEWPORTS } from '@storybook/addon-viewport';
5-
import { colorsCommon } from '@utilitywarehouse/colour-system';
62
import { SyntaxHighlighter } from '@storybook/components';
7-
import diff from 'react-syntax-highlighter/dist/esm/languages/prism/diff';
83
import { Analytics } from '@vercel/analytics/react';
94

5+
import { colorsCommon } from '@utilitywarehouse/colour-system';
6+
import '@utilitywarehouse/css-reset';
7+
import '@utilitywarehouse/fontsource';
8+
9+
import { breakpoints, Box } from '../src';
10+
import diff from 'react-syntax-highlighter/dist/esm/languages/prism/diff';
11+
1012
SyntaxHighlighter.registerLanguage('diff', diff);
1113

1214
const customerUiViewports = {
@@ -47,7 +49,7 @@ const preview = {
4749
storySort: {
4850
order: [
4951
'Web UI',
50-
['Introduction', 'Guides', 'Helpers', 'Layout', 'Typography', 'Components', 'Lab'],
52+
['Introduction', 'Guides', 'Documentation', 'Design Guidelines', 'Stories'],
5153
'CSS Reset',
5254
'Colour System',
5355
['Introduction', 'Common', 'Colors'],

packages/web-ui/docs/web-ui/helpers/media-queries.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@ import { mediaQueries } from '../../../src/utils';
66

77
<Analytics />
88

9-
<Meta title="Web UI / Helpers / Media Queries" />
9+
<Meta title="Web UI / Documentation / Media Queries" />
10+
11+
# Media Queries
1012

1113
- [Base media queries](#base-media-queries)
12-
- [Media query helpers](#media-query-helpers)
14+
- [Media queries helpers](#media-queries-helpers)
1315
- [useMediaQueries hook](#usemediaqueries-hook)
1416
- [useMediaQuery hook](#usemediaquery-hook)
1517

16-
# Media Queries
18+
## Base media queries
1719

1820
While you should be able to do most things using the responsive style props, if
1921
you need to you can use the `mediaQueries` object to help create responsive
@@ -36,8 +38,6 @@ import { mediaQueries } from '@utilitywarehouse/web-ui';
3638
</Box>
3739
```
3840

39-
## Base media queries
40-
4141
<Flex direction="column" gap={1} width={500}>
4242
<Flex justify="space-between" align="center">
4343
<Text variant="body" component="span">
@@ -76,7 +76,7 @@ import { mediaQueries } from '@utilitywarehouse/web-ui';
7676
</Flex>
7777
</Flex>
7878

79-
## Media query helpers
79+
## Media queries helpers
8080

8181
There are also some media query helper functions available for more specific media queries. These helpers all take only the breakpoint values as arguments (`mobile`, `tablet`, `desktop`, `wide`).
8282

packages/web-ui/docs/web-ui/helpers/tokens.mdx

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
import { Meta } from '@storybook/blocks';
2-
import { breakpoints, fonts, fontWeights } from '../../../src/tokens';
3-
import { Text, Flex, Divider } from '../../../src';
42
import { Analytics } from '@vercel/analytics/react';
53

4+
import { Text, Flex, Divider } from '../../../src';
5+
import { breakpoints, fonts, fontWeights } from '../../../src/tokens';
6+
67
<Analytics />
78

8-
<Meta title="Web UI / Helpers / Tokens" />
9+
<Meta title="Web UI / Documentation / Tokens" />
10+
11+
# Tokens
912

10-
# Breakpoints (px)
13+
## Breakpoints (px)
1114

1215
<Flex direction="column" gap={1} width={400}>
1316
{Object.keys(breakpoints).map((bp, i) => (
@@ -25,7 +28,7 @@ import { Analytics } from '@vercel/analytics/react';
2528
))}
2629
</Flex>
2730

28-
# Font families
31+
## Font families
2932

3033
<Flex direction="column" gap={1} width={400}>
3134
{Object.keys(fonts).map((font, i) => (
@@ -43,7 +46,7 @@ import { Analytics } from '@vercel/analytics/react';
4346
))}
4447
</Flex>
4548

46-
# Font weights
49+
## Font weights
4750

4851
<Flex direction="column" gap={1} width={400}>
4952
<Flex justify="space-between" align="center">

packages/web-ui/src/components/Alert/Alert.docs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Stories from './Alert.stories';
44

55
import { DocsHeader } from '../../storybook-components';
66

7-
<Meta of={Stories} />
7+
<Meta title="Web UI / Documentation / Alert" />
88

99
<DocsHeader
1010
componentName="Alert"

packages/web-ui/src/components/Alert/Alert.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { Flex } from '../Flex';
1010
const colorSchemes = ['cyan', 'red', 'green', 'gold'] as const;
1111

1212
const meta: Meta<typeof Alert> = {
13-
title: 'Web UI / Components / Alert',
13+
title: 'Web UI / Stories / Alert',
1414
component: Alert,
1515
argTypes: {
1616
children: { control: { type: 'text' } },

packages/web-ui/src/components/Badge/Badge.docs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Stories from './Badge.stories';
44

55
import { DocsHeader } from '../../storybook-components';
66

7-
<Meta of={Stories} />
7+
<Meta title="Web UI / Documentation / Badge" />
88

99
<DocsHeader
1010
componentName="Badge"

packages/web-ui/src/components/Badge/Badge.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const variants = ['soft', 'strong', 'outline'] as const;
1616
const colorSchemes = ['cyan', 'green', 'red', 'gold', 'grey'] as const;
1717

1818
const meta: Meta<typeof Badge> = {
19-
title: 'Web UI / Components / Badge',
19+
title: 'Web UI / Stories / Badge',
2020
component: Badge,
2121
argTypes: {
2222
children: { control: { type: 'text' } },

packages/web-ui/src/components/Box/Box.docs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Stories from './Box.stories';
44

55
import { DocsHeader } from '../../storybook-components';
66

7-
<Meta of={Stories} />
7+
<Meta title="Web UI / Documentation / Box" />
88

99
<DocsHeader componentName="Box" stories={Stories} />
1010

packages/web-ui/src/components/Box/Box.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import { Text } from '../Text';
1313
import { fonts } from '../../tokens';
1414

1515
const meta: Meta<typeof Box> = {
16-
title: 'Web UI / Layout / Box',
16+
title: 'Web UI / Stories / Box',
1717
component: Box,
1818
};
1919

packages/web-ui/src/components/Button/Button.docs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Stories from './Button.stories';
44

55
import { DocsHeader } from '../../storybook-components';
66

7-
<Meta of={Stories} />
7+
<Meta title="Web UI / Documentation / Button" />
88

99
<DocsHeader
1010
componentName="Button"
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { Meta } from '@storybook/blocks';
2+
3+
import { Heading } from '../Heading';
4+
5+
<Meta title="Web UI / Design Guidelines / Button" />
6+
7+
<Heading variant="h1">Button Design Guidelines</Heading>

packages/web-ui/src/components/Button/Button.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const solidColorSchemes = ['cyan', 'red', 'green'] as const;
1818
const colorSchemes = [...solidColorSchemes, 'grey', 'gold'] as const;
1919

2020
const meta: Meta<typeof Button> = {
21-
title: 'Web UI / Components / Button',
21+
title: 'Web UI / Stories / Button',
2222
component: Button,
2323
argTypes: {
2424
children: { control: { type: 'text' } },

packages/web-ui/src/components/Checkbox/Checkbox.docs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Stories from './Checkbox.stories';
44

55
import { DocsHeader } from '../../storybook-components';
66

7-
<Meta of={Stories} />
7+
<Meta title="Web UI / Documentation / Checkbox" />
88

99
<DocsHeader
1010
componentName="Checkbox"

packages/web-ui/src/components/Checkbox/Checkbox.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Flex } from '../Flex';
88
import { Text } from '../Text';
99

1010
const meta: Meta<typeof Checkbox> = {
11-
title: 'Web UI / Components / Checkbox / Checkbox',
11+
title: 'Web UI / Stories / Checkbox',
1212
component: Checkbox,
1313
argTypes: {
1414
helperText: { control: { type: 'text' } },

packages/web-ui/src/components/CheckboxGridGroup/CheckboxGridGroup.docs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Stories from './CheckboxGridGroup.stories';
44

55
import { DocsHeader } from '../../storybook-components';
66

7-
<Meta of={Stories} />
7+
<Meta title="Web UI / Documentation / CheckboxGridGroup" />
88

99
<DocsHeader
1010
componentName="CheckboxGridGroup"

packages/web-ui/src/components/CheckboxGridGroup/CheckboxGridGroup.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { Flex } from '../Flex';
1010
import { Text } from '../Text';
1111

1212
const meta: Meta<typeof CheckboxGridGroup> = {
13-
title: 'Web UI / Components / Checkbox / CheckboxGridGroup',
13+
title: 'Web UI / Stories / CheckboxGridGroup',
1414
component: CheckboxGridGroup,
1515
argTypes: {
1616
helperText: { control: { type: 'text' } },

packages/web-ui/src/components/CheckboxGroup/CheckboxGroup.docs.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { Text } from '../Text';
99

1010
import { DocsHeader } from '../../storybook-components';
1111

12-
<Meta of={Stories} />
12+
<Meta title="Web UI / Documentation / CheckboxGroup" />
1313

1414
<DocsHeader
1515
componentName="CheckboxGroup"
@@ -30,10 +30,10 @@ import { DocsHeader } from '../../storybook-components';
3030

3131
## Alternatives
3232

33-
- [CheckboxGridGroup](?path=/docs/components-checkboxgridgroup--documentation) - For presenting checkboxes in columns or a grid layout.
34-
- [CheckboxGroupRoot](?path=/story/web-ui-components-checkbox-checkboxgroup--checkbox-group-root-story) - For presenting checkboxes, outside of a fieldset, without label, helper text, or error message.
35-
- [RadioGroup](?path=/docs/components-radiogroup--documentation) - For single-select
36-
- [RadioGridGroup](?path=/docs/components-radiogridgroup--documentation) - For single-select in columns or a grid layout.
33+
- CheckboxGridGroup: For presenting checkboxes in columns or a grid layout.
34+
- CheckboxGroupRoot: For presenting checkboxes, outside of a fieldset, without label, helper text, or error message.
35+
- RadioGroup: For single-select
36+
- RadioGridGroup: For single-select in columns or a grid layout.
3737

3838
## Accessibility
3939

packages/web-ui/src/components/CheckboxGroup/CheckboxGroup.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import { Flex } from '../Flex';
1515
import { Text } from '../Text';
1616

1717
const meta: Meta<typeof CheckboxGroup> = {
18-
title: 'Web UI / Components / Checkbox / CheckboxGroup',
18+
title: 'Web UI / Stories / CheckboxGroup',
1919
component: CheckboxGroup,
2020
argTypes: {
2121
direction: {

packages/web-ui/src/components/CheckboxTile/CheckboxTile.docs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Text } from '../Text';
88

99
import { DocsHeader } from '../../storybook-components';
1010

11-
<Meta of={Stories} />
11+
<Meta title="Web UI / Documentation / CheckboxTile" />
1212

1313
<DocsHeader
1414
componentName="CheckboxTile"

packages/web-ui/src/components/CheckboxTile/CheckboxTile.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Flex } from '../Flex';
88
import { Text } from '../Text';
99

1010
const meta: Meta<typeof CheckboxTile> = {
11-
title: 'Web UI / Components / Checkbox / CheckboxTile',
11+
title: 'Web UI / Stories / CheckboxTile',
1212
component: CheckboxTile,
1313
argTypes: {
1414
helperText: { control: { type: 'text' } },

packages/web-ui/src/components/Divider/Divider.docs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Stories from './Divider.stories';
44

55
import { DocsHeader } from '../../storybook-components';
66

7-
<Meta of={Stories} />
7+
<Meta title="Web UI / Documentation / Divider" />
88

99
<DocsHeader
1010
componentName="Divider"

packages/web-ui/src/components/Divider/Divider.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import { Strong } from '../Strong';
1313
import { Text } from '../Text';
1414

1515
const meta: Meta<typeof Divider> = {
16-
title: 'Web UI / Components / Divider',
16+
title: 'Web UI / Stories / Divider',
1717
component: Divider,
1818
};
1919

packages/web-ui/src/components/Em/Em.docs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Stories from './Em.stories';
44

55
import { DocsHeader } from '../../storybook-components';
66

7-
<Meta of={Stories} />
7+
<Meta title="Web UI / Documentation / Em" />
88

99
<DocsHeader componentName="Em" stories={Stories} />
1010

packages/web-ui/src/components/Em/Em.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { Text } from '../Text';
1010
const textVariants = ['subtitle', 'body', 'legalNote', 'caption'] as const;
1111

1212
const meta: Meta<typeof Em> = {
13-
title: 'Web UI / Typography / Em',
13+
title: 'Web UI / Stories / Em',
1414
component: Em,
1515
};
1616

packages/web-ui/src/components/Fieldset/Fieldset.docs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Stories from './Fieldset.stories';
44

55
import { DocsHeader } from '../../storybook-components';
66

7-
<Meta of={Stories} />
7+
<Meta title="Web UI / Documentation / Fieldset" />
88

99
<DocsHeader componentName="Fieldset" stories={Stories} />
1010

packages/web-ui/src/components/Fieldset/Fieldset.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { FieldsetLegend } from '../FieldsetLegend';
99
import { Placeholder } from '../../storybook-components';
1010

1111
const meta: Meta<typeof Fieldset> = {
12-
title: 'Web UI / Components / Fieldset',
12+
title: 'Web UI / Stories / Fieldset',
1313
component: Fieldset,
1414
};
1515

packages/web-ui/src/components/FieldsetLegend/FieldsetLegend.docs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Stories from './FieldsetLegend.stories';
44

55
import { DocsHeader } from '../../storybook-components';
66

7-
<Meta of={Stories} />
7+
<Meta title="Web UI / Documentation / FieldsetLegend" />
88

99
<DocsHeader componentName="FieldsetLegend" stories={Stories} />
1010

packages/web-ui/src/components/FieldsetLegend/FieldsetLegend.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { FieldsetLegend } from './FieldsetLegend';
77
import { Box } from '../Box';
88

99
const meta: Meta<typeof FieldsetLegend> = {
10-
title: 'Web UI / Typography / FieldsetLegend',
10+
title: 'Web UI / Stories / FieldsetLegend',
1111
component: FieldsetLegend,
1212
};
1313

packages/web-ui/src/components/Flex/Flex.docs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import * as Stories from './Flex.stories';
44

55
import { DocsHeader } from '../../storybook-components';
66

7-
<Meta of={Stories} />
7+
<Meta title="Web UI / Documentation / Flex" />
88

99
<DocsHeader componentName="Flex" stories={Stories} />
1010

0 commit comments

Comments
 (0)