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.

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: improve story descriptions for Color Sample #413

Merged
merged 6 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/storybook-non-conforming/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"@nl-design-system-candidate/storybook-shared": "workspace:*",
"@nl-design-system-unstable/design-tokens-table-react": "1.0.0",
"@nl-design-system-unstable/tokens-lib": "0.1.0",
"@nl-design-system-unstable/voorbeeld-design-tokens": "3.3.0",
"@nl-design-system-unstable/voorbeeld-design-tokens": "3.3.3",
"@storybook/addon-a11y": "8.4.5",
"@storybook/addon-controls": "8.4.5",
"@storybook/addon-docs": "8.4.5",
Expand Down
2 changes: 1 addition & 1 deletion packages/storybook-test/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"@nl-design-system-candidate/storybook-shared": "workspace:*",
"@nl-design-system-unstable/design-tokens-table-react": "1.0.0",
"@nl-design-system-unstable/tokens-lib": "0.1.0",
"@nl-design-system-unstable/voorbeeld-design-tokens": "3.3.0",
"@nl-design-system-unstable/voorbeeld-design-tokens": "3.3.3",
"@storybook/addon-a11y": "8.4.5",
"@storybook/addon-controls": "8.4.5",
"@storybook/addon-docs": "8.4.5",
Expand Down
186 changes: 155 additions & 31 deletions packages/storybook-test/stories/color-sample/color-sample.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,20 @@ export default meta;
type Story = StoryObj<typeof meta>;

export const Default: Story = {
name: 'Color Sample voor "deep pink"',
args: { value: '#ff1493' },
name: 'Color Sample voor een huisstijlkleur',
args: { value: '#154273' },
globals: {
dir: 'ltr',
lang: 'nl',
title: 'Huisstijlkleuren',
},
parameters: {
ariaLabelledBy: 'De kleur "#ff1493".',
ariaLabelledBy: 'De kleur "lintblauw".',
docs: {
description: {
story: 'Een kleurstaal met beschrijving.',
story: `Een kleurstaal met beschrijving voor een doelgroep die gewend is met kleurcodes te werken.

De Color Sample en de tekst staan in dezelfde Paragraph, dus het is duidelijk dat ze bij elkaar horen.`,
},
},
status: { type: [] },
Expand All @@ -60,26 +63,86 @@ export const Default: Story = {
const id = useId();

return (
<Paragraph>
<ColorSample {...props} aria-labelledby={id} /> <span id={id}>{context.parameters['ariaLabelledBy']}</span>
</Paragraph>
);
},
};

export const SoloColorSample: Story = {
name: 'Color Sample als zelfstandige afbeelding met toegankelijke naam',
args: {
['aria-label']: 'De kleur "#154273".',
value: '#154273',
},
decorators: [
(Story, context) => (
<>
<ColorSample {...props} aria-labelledby={id} />
<Paragraph id={id}>{context.parameters['ariaLabelledBy']}</Paragraph>
<Paragraph>{Story()}</Paragraph>
<Paragraph> {context.args['aria-label']}</Paragraph>
</>
),
...meta.decorators,
],
globals: {
dir: 'ltr',
lang: 'nl',
title: 'De kleur "#154273".',
},
parameters: {
docs: {
description: {
story:
'Een kleurstaal met expliciete beschrijving in een `aria-label` attribuut, die helemaal los staat in een element staat die bedoeld is om gerelateerde inhoud te groeperen, zoals een Paragraph, Table Cell of List Item. Deze vorm mag alleen gebruikt worden als de kleur elders in de context toegelicht is.',
},
},
status: { type: [] },
},
};

export const White: Story = {
name: 'Color Sample voor de kleur wit',
args: { value: '#FFFFFF' },
globals: {
dir: 'ltr',
lang: 'nl',
title: 'Huisstijlkleuren',
},
parameters: {
ariaLabelledBy: 'De kleur "wit".',
docs: {
description: {
story:
'Een kleurstaal met voor de kleur "wit". De kleurstaal is te herkennen op een lichte achtergrondkleur door een border-color met voldoende contrast.',
},
},
status: { type: [] },
},
render(props, context) {
const id = useId();

return (
<Paragraph>
<ColorSample {...props} aria-labelledby={id} /> <span id={id}>{context.parameters['ariaLabelledBy']}</span>
</Paragraph>
);
},
};

export const SemiTransparentColorSample: Story = {
name: 'Color Sample met semi-transparente "deep pink"',
args: { value: '#ff14937f' },
export const Black: Story = {
name: 'Color Sample voor de kleur zwart',
args: { value: '#000000' },
globals: {
dir: 'ltr',
lang: 'nl',
title: 'Huisstijlkleuren',
},
parameters: {
ariaLabelledBy: 'De semi-transparante kleur "#ff14937f".',
ariaLabelledBy: 'De kleur "zwart".',
docs: {
description: {
story: 'Een kleurstaal met een semitransparante kleur en beschrijving.',
story: 'Een kleurstaal met voor de kleur "zwart".',
},
},
status: { type: [] },
Expand All @@ -88,33 +151,94 @@ export const SemiTransparentColorSample: Story = {
const id = useId();

return (
<>
<ColorSample {...props} aria-labelledby={id} />
<Paragraph id={id}>{context.parameters['ariaLabelledBy']}</Paragraph>
</>
<Paragraph>
<ColorSample {...props} aria-labelledby={id} /> <span id={id}>{context.parameters['ariaLabelledBy']}</span>
</Paragraph>
);
},
};

export const SoloColorSample: Story = {
name: 'Color Sample als afbeelding met toegankelijke naam',
args: {
title: 'De kleur "#ff1493".',
value: '#ff1493',
export const CssColorCode: Story = {
name: 'Color Sample voor CSS-kleurcode van "deep pink"',
args: { value: '#ff1493' },
globals: {
dir: 'ltr',
lang: 'nl',
},
parameters: {
ariaLabelledBy: 'De kleur "#ff1493".',
docs: {
description: {
story: 'Een kleurstaal met beschrijving voor een doelgroep die gewend is met kleurcodes te werken.',
},
},
status: { type: [] },
},
render(props, context) {
const id = useId();

return (
<Paragraph>
<ColorSample {...props} aria-labelledby={id} /> <span id={id}>{context.parameters['ariaLabelledBy']}</span>
</Paragraph>
);
},
};

export const TransparentColorSample: Story = {
name: 'Color Sample met een 100% transparante kleur',
args: { value: '#ffffff00' },
globals: {
dir: 'ltr',
lang: 'nl',
},
parameters: {
ariaLabelledBy: 'De 100% transparante kleur "#ffffff00".',
docs: {
description: {
story:
'Een kleurstaal met een 100% transparante kleur en beschrijving, voor een doelgroep die gewend is [alpha-transparantie](https://en.wikipedia.org/wiki/Alpha_compositing) te beoordelen met een checkerboard pattern. De 8-cijferige hexadecimale kleurcode maakt ook duidelijk dat er transparantie is.',
},
},
status: { type: [] },
},
render(props, context) {
const id = useId();

return (
<Paragraph>
<ColorSample {...props} aria-labelledby={id} /> <span id={id}>{context.parameters['ariaLabelledBy']}</span>
</Paragraph>
);
},
};

export const SemiTransparentColorSample: Story = {
name: 'Color Sample met semi-transparente "deep pink"',
args: { value: '#ff14937f' },
globals: {
dir: 'ltr',
lang: 'nl',
},
parameters: {
ariaLabelledBy: 'De semi-transparante kleur "#ff14937f".',
docs: {
description: {
story:
'Een kleurstaal zonder expliciete beschrijving. Deze vorm mag alleen gebruikt worden als de kleur elders in de context toegelicht is.',
'Een kleurstaal met een semitransparante kleur en beschrijving, voor een doelgroep die gewend is [alpha-transparantie](https://en.wikipedia.org/wiki/Alpha_compositing) te beoordelen met een checkerboard pattern. De 8-cijferige hexadecimale kleurcode maakt ook duidelijk dat er transparantie is.',
},
},
status: { type: [] },
},
render(props, context) {
const id = useId();

return (
<Paragraph>
<ColorSample {...props} aria-labelledby={id} /> <span id={id}>{context.parameters['ariaLabelledBy']}</span>
</Paragraph>
);
},
};

export const Arabic: Story = {
Expand All @@ -129,7 +253,8 @@ export const Arabic: Story = {
ariaLabelledBy: 'أخضر',
docs: {
description: {
story: 'Een kleurstaal met beschrijving in Arabisch.',
story:
'Een kleurstaal met beschrijving in Arabisch, voor de kleur groen (["أخضر" in Arabisch](https://ar.wikipedia.org/wiki/أخضر)).',
},
},
status: { type: [] },
Expand All @@ -138,10 +263,9 @@ export const Arabic: Story = {
const id = useId();

return (
<>
<ColorSample {...props} aria-labelledby={id} />
<Paragraph id={id}>{context.parameters['ariaLabelledBy']}</Paragraph>
</>
<Paragraph>
<ColorSample {...props} aria-labelledby={id} /> <span id={id}>{context.parameters['ariaLabelledBy']}</span>
</Paragraph>
);
},
};
Expand All @@ -159,7 +283,8 @@ export const Japanese: Story = {
ariaLabelledBy: '緑',
docs: {
description: {
story: 'Een kleurstaal met beschrijving in het Japans.',
story:
'Een kleurstaal met beschrijving in het Japans, voor de kleur groen (["緑" in Japans](https://ja.wikipedia.org/wiki/緑)).',
},
},
status: { type: [] },
Expand All @@ -168,10 +293,9 @@ export const Japanese: Story = {
const id = useId();

return (
<>
<ColorSample {...props} aria-labelledby={id} />
<Paragraph id={id}>{context.parameters['ariaLabelledBy']}</Paragraph>
</>
<Paragraph>
<ColorSample {...props} aria-labelledby={id} /> <span id={id}>{context.parameters['ariaLabelledBy']}</span>
</Paragraph>
);
},
};
2 changes: 1 addition & 1 deletion packages/storybook/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"@fontsource/fira-sans": "5.1.0",
"@fontsource/source-serif-pro": "5.1.0",
"@nl-design-system-candidate/storybook-shared": "workspace:*",
"@nl-design-system-unstable/voorbeeld-design-tokens": "3.3.0",
"@nl-design-system-unstable/voorbeeld-design-tokens": "3.3.3",
"@storybook/addon-a11y": "8.4.5",
"@storybook/addon-actions": "8.4.5",
"@storybook/addon-docs": "8.4.5",
Expand Down
18 changes: 9 additions & 9 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading