aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/atoms/lists/description-list.stories.tsx
diff options
context:
space:
mode:
authorArmand Philippot <git@armandphilippot.com>2023-10-02 17:01:57 +0200
committerArmand Philippot <git@armandphilippot.com>2023-11-11 18:14:41 +0100
commit36890cfafeba6e30782df1260d7f9e678c7da4bf (patch)
tree1abe20cf36d60e048b75828dd5516529e504ddd8 /src/components/atoms/lists/description-list.stories.tsx
parent4f768afe543bbf9e1857c41d03804f8e37ab3512 (diff)
refactor(components): rewrite DescriptionList component
* add a `spacing` prop * replace `layout` prop with `isInline` prop * remove `items` prop (and classNames props) in favor of new components: Description, Group, Term * remove `withSeparator` prop (CSS content is announced by screen readers and Firefox/Safari have no support for alternative text so the consumer should add itself an element with `aria-hidden` if it need a separator) Be aware, Meta component and its consumers can be visually broken, they should be refactored before using them in production.
Diffstat (limited to 'src/components/atoms/lists/description-list.stories.tsx')
-rw-r--r--src/components/atoms/lists/description-list.stories.tsx131
1 files changed, 0 insertions, 131 deletions
diff --git a/src/components/atoms/lists/description-list.stories.tsx b/src/components/atoms/lists/description-list.stories.tsx
deleted file mode 100644
index 0194817..0000000
--- a/src/components/atoms/lists/description-list.stories.tsx
+++ /dev/null
@@ -1,131 +0,0 @@
-import { ComponentMeta, ComponentStory } from '@storybook/react';
-import { DescriptionList, DescriptionListItem } from './description-list';
-
-/**
- * DescriptionList - Storybook Meta
- */
-export default {
- title: 'Atoms/Typography/Lists/DescriptionList',
- component: DescriptionList,
- args: {
- layout: 'column',
- withSeparator: false,
- },
- argTypes: {
- className: {
- control: {
- type: 'text',
- },
- description: 'Set additional classnames to the list wrapper',
- table: {
- category: 'Styles',
- },
- type: {
- name: 'string',
- required: false,
- },
- },
- groupClassName: {
- control: {
- type: 'text',
- },
- description: 'Set additional classnames to the item wrapper.',
- table: {
- category: 'Styles',
- },
- type: {
- name: 'string',
- required: false,
- },
- },
- items: {
- control: {
- type: null,
- },
- description: 'The list items.',
- type: {
- name: 'object',
- required: true,
- value: {},
- },
- },
- labelClassName: {
- control: {
- type: 'text',
- },
- description: 'Set additional classnames to the label wrapper.',
- table: {
- category: 'Styles',
- },
- type: {
- name: 'string',
- required: false,
- },
- },
- layout: {
- control: {
- type: 'select',
- },
- description: 'The list layout.',
- options: ['column', 'inline'],
- table: {
- category: 'Options',
- defaultValue: { summary: 'column' },
- },
- type: {
- name: 'string',
- required: false,
- },
- },
- valueClassName: {
- control: {
- type: 'text',
- },
- description: 'Set additional classnames to the value wrapper.',
- table: {
- category: 'Styles',
- },
- type: {
- name: 'string',
- required: false,
- },
- },
- withSeparator: {
- control: {
- type: 'boolean',
- },
- description: 'Add a slash as separator between multiple values.',
- table: {
- category: 'Options',
- defaultValue: { summary: false },
- },
- type: {
- name: 'boolean',
- required: false,
- },
- },
- },
-} as ComponentMeta<typeof DescriptionList>;
-
-const Template: ComponentStory<typeof DescriptionList> = (args) => (
- <DescriptionList {...args} />
-);
-
-const items: DescriptionListItem[] = [
- { id: 'term-1', label: 'Term 1:', value: ['Value for term 1'] },
- { id: 'term-2', label: 'Term 2:', value: ['Value for term 2'] },
- {
- id: 'term-3',
- label: 'Term 3:',
- value: ['Value 1 for term 3', 'Value 2 for term 3', 'Value 3 for term 3'],
- },
- { id: 'term-4', label: 'Term 4:', value: ['Value for term 4'] },
-];
-
-/**
- * List Stories - Description list
- */
-export const List = Template.bind({});
-List.args = {
- items,
-};