♻️(react) fix Storybook source blocks

Due to the recent upgrade to Storybook 7, the source blocks of Canvases
were broken, they were only showing args. This was mainly due to the fact
that as of Storybook 7 the meta tags of the MDX files have changed, thus
causing the issue. These are now based on imports. We also needed to rename
index.stories.mdx files to index.mdx because Storybook was throwing errors,
maybe due to a conflicts with index.stories.tsx files and new imports.
Anyway this way of naming MDX files seems to be the recommend one based on
the official documentation.
This commit is contained in:
Nathan Vasse
2023-05-22 11:39:11 +02:00
committed by NathanVss
parent f264c29a4a
commit 8cda41772d
11 changed files with 37 additions and 37 deletions

View File

@@ -0,0 +1,110 @@
import { Canvas, Meta, Story, Source, ArgsTable } from '@storybook/addon-docs';
import * as Stories from './index.stories';
<Meta of={Stories}/>
# Checkbox
Cunningham provides a versatile Checkbox component that you can use in your forms.
<Canvas>
<Story id="components-forms-checkbox--group"/>
</Canvas>
## Label
The `label` props is optional, but you can use it to provide a description of the checkbox.
**Without label**
<Canvas sourceState="shown">
<Story id="components-forms-checkbox--default"/>
</Canvas>
**With label**
<Canvas sourceState="shown">
<Story id="components-forms-checkbox--with-label"/>
</Canvas>
## Value
You can set the value of the checkbox in 3 different ways.
<Canvas sourceState="shown">
<Story id="components-forms-checkbox--default"/>
<Story id="components-forms-checkbox--indeterminate"/>
<Story id="components-forms-checkbox--checked"/>
</Canvas>
## Texts
As the component uses [Field](?path=/story/components-forms-field-doc--page), you can use the `text` props to provide a description of the checkbox.
<Canvas sourceState="shown">
<Story id="components-forms-checkbox--with-texts"/>
</Canvas>
## Disabled
As a regular checkbox, you can disable it by using the `disabled` props.
<Canvas sourceState="shown">
<Story id="components-forms-checkbox--disabled"/>
</Canvas>
## States
You can use the following props to change the state of the Input component by using the `state` props.
<Canvas sourceState="shown">
<Story id="components-forms-checkbox--with-texts"/>
</Canvas>
<Canvas sourceState="shown">
<Story id="components-forms-checkbox--success"/>
</Canvas>
<Canvas sourceState="shown">
<Story id="components-forms-checkbox--error"/>
</Canvas>
## Group
It will happen often that you will need to use multiple grouped checkboxes. You can use the `CheckboxGroup` component to do so.
<Canvas sourceState="shown">
<Story id="components-forms-checkbox--group"/>
</Canvas>
You can also define `state`, `text` props on the group component
<Canvas sourceState="shown">
<Story id="components-forms-checkbox--group-error"/>
<Story id="components-forms-checkbox--group-success"/>
</Canvas>
## Design tokens
Here are available custom design tokens.
| Token | Description |
|--------------- |----------------------------- |
| font-size | Label font size ( shared with radio ) |
| font-weight | Label font weight ( shared with radio ) |
| color | Label color ( shared with radio ) |
| border-color | Border color of the checkbox |
| border-radius | Border radius of the checkbox |
| accent-color | Color of the checkmark and the indeterminate mark |
| width | Width of the checkbox |
| height | Height of the checkbox |
See also [Field](?path=/story/components-forms-field-doc--page)
##
<img src="components/Forms/Checkbox/resources/dd_1.svg"/>
##
<img src="components/Forms/Checkbox/resources/dd_2.svg"/>