aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/atoms/lists/description-list/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/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/description-list.stories.tsx')
-rw-r--r--src/components/atoms/lists/description-list/description-list.stories.tsx150
1 files changed, 150 insertions, 0 deletions
diff --git a/src/components/atoms/lists/description-list/description-list.stories.tsx b/src/components/atoms/lists/description-list/description-list.stories.tsx
new file mode 100644
index 0000000..d051fcd
--- /dev/null
+++ b/src/components/atoms/lists/description-list/description-list.stories.tsx
@@ -0,0 +1,150 @@
+import type { ComponentMeta, ComponentStory } from '@storybook/react';
+import { Description } from './description';
+import { DescriptionList } from './description-list';
+import { Group } from './group';
+import { Term } from './term';
+
+/**
+ * DescriptionList - Storybook Meta
+ */
+export default {
+ title: 'Atoms/Lists/DescriptionList',
+ component: DescriptionList,
+ args: {
+ isInline: false,
+ },
+ argTypes: {
+ className: {
+ control: {
+ type: 'text',
+ },
+ description: 'Set additional classnames to the list wrapper',
+ table: {
+ category: 'Styles',
+ },
+ type: {
+ name: 'string',
+ required: false,
+ },
+ },
+ },
+} as ComponentMeta<typeof DescriptionList>;
+
+const Template: ComponentStory<typeof DescriptionList> = (args) => (
+ <DescriptionList {...args} />
+);
+
+/**
+ * Description List Stories - Single term, single description
+ */
+export const SingleTermSingleDescription = Template.bind({});
+SingleTermSingleDescription.args = {
+ children: (
+ <>
+ <Term>A term</Term>
+ <Description>A description of the term.</Description>
+ </>
+ ),
+};
+
+/**
+ * Description List Stories - Multiple terms, single description
+ */
+export const MultipleTermsSingleDescription = Template.bind({});
+MultipleTermsSingleDescription.args = {
+ children: (
+ <>
+ <Term>A first term</Term>
+ <Term>A second term</Term>
+ <Term>A third term</Term>
+ <Description>A description of the term.</Description>
+ </>
+ ),
+};
+
+/**
+ * Description List Stories - Single term, multiple descriptions
+ */
+export const SingleTermMultipleDescriptions = Template.bind({});
+SingleTermMultipleDescriptions.args = {
+ children: (
+ <>
+ <Term>A term</Term>
+ <Description>A first description of the term.</Description>
+ <Description>A second description of the term.</Description>
+ <Description>A third description of the term.</Description>
+ </>
+ ),
+};
+
+/**
+ * Description List Stories - Multiple terms, multiple descriptions
+ */
+export const MultipleTermsMultipleDescriptions = Template.bind({});
+MultipleTermsMultipleDescriptions.args = {
+ children: (
+ <>
+ <Term>A first term</Term>
+ <Term>A second term</Term>
+ <Term>A third term</Term>
+ <Description>A first description of the term.</Description>
+ <Description>A second description of the term.</Description>
+ <Description>A third description of the term.</Description>
+ </>
+ ),
+};
+
+/**
+ * Description List Stories - Group of terms & descriptions
+ */
+export const GroupOfTermsDescriptions = Template.bind({});
+GroupOfTermsDescriptions.args = {
+ children: (
+ <>
+ <Group>
+ <Term>A term</Term>
+ <Description>A description of the term.</Description>
+ </Group>
+ <Group>
+ <Term>Another term</Term>
+ <Description>A description of the other term.</Description>
+ </Group>
+ </>
+ ),
+};
+
+/**
+ * Description List Stories - Inlined list of term and descriptions
+ */
+export const InlinedList = Template.bind({});
+InlinedList.args = {
+ children: (
+ <>
+ <Term>A term:</Term>
+ <Description>A first description of the term.</Description>
+ <Description>A second description of the term.</Description>
+ <Description>A third description of the term.</Description>
+ </>
+ ),
+ isInline: true,
+ spacing: 'xs',
+};
+
+/**
+ * Description List Stories - Inlined group of terms & descriptions
+ */
+export const InlinedGroupOfTermsDescriptions = Template.bind({});
+InlinedGroupOfTermsDescriptions.args = {
+ children: (
+ <>
+ <Group isInline spacing="2xs">
+ <Term>A term:</Term>
+ <Description>A description of the term.</Description>
+ </Group>
+ <Group isInline spacing="2xs">
+ <Term>Another term:</Term>
+ <Description>A description of the other term.</Description>
+ </Group>
+ </>
+ ),
+};