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(select): documente les composants et un nouveau cas d'usage #3517

Merged
merged 3 commits into from
Dec 17, 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import * as stories from './SelectMultiple.stories';
import { Canvas, Controls, Meta, Primary } from "@storybook/blocks";

<Meta of={stories} />

# Select Multiple

## Definition

Le composant permet de sélectionner un sous-ensemble d'éléments parmi une liste fixe. Cette implémentation vise à reproduire le comportement d'un `select` natif combiné avec son attribut `multiple`, avec une interface plus proche du select simple. On pourra aussi se référer au pattern ARIA [select-only combobox](https://www.w3.org/WAI/ARIA/apg/patterns/combobox/examples/combobox-select-only/).

Ce composant expose un sous-composant `SelectMultiple.Option` pour définir la liste des choix.

<Primary/>

À la différence du [Combobox](/docs/components-form-combobox--docs), l'utilisateur est contraint de choisir une option dans la liste et ne peut pas renseigner un champ à la main.

## Props

Le composant accepte les props ci-dessous ainsi tous [les attributs d'un `button` HTML natif](https://developer.mozilla.org/fr/docs/Web/HTML/Element/button):

<Controls />

## Exemples

### Disabled

Renseigner la prop `disabled` permet de désactiver la sélection d'option.

<Canvas of={stories.disabled}/>

### Validation

Lorsque la prop `required` est fournie, le composant entre en erreur si l'on tente de valider le formulaire sans option sélectionnée.

<Canvas of={stories.validation}/>

### Default Value

Un `Array<string>` peut être donné à la prop `defaultValue` pour présélectionner certaines options.

<Canvas of={stories.defaultValue}/>
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export default meta;
type SelectProps = React.ComponentPropsWithRef<typeof SelectMultiple>;
type Controls = Omit<SelectProps, 'children'> & { children: string[] };
type Story = StoryObj<Controls>;

export const exemple: Story = {
args: {},
render: ({ children, ...args }) => (
Expand All @@ -33,6 +34,7 @@ export const exemple: Story = {
</>
),
};

export const disabled: Story = {
args: {
disabled: true,
Expand All @@ -46,6 +48,7 @@ export const disabled: Story = {
</>
),
};

export const validation: Story = {
args: {
name: 'pays',
Expand All @@ -67,3 +70,17 @@ export const validation: Story = {
</form>
),
};

export const defaultValue: Story = {
args: {
defaultValue: ['France', 'Japon'],
},
render: ({ children, ...args }) => (
<>
<label htmlFor="pays">Pays</label>
<SelectMultiple id="pays" {...args}>
{children.map((child) => <SelectMultiple.Option value={child} key={child}>{child}</SelectMultiple.Option>)}
</SelectMultiple>
</>
),
};
42 changes: 42 additions & 0 deletions src/client/components/ui/Form/Select/SelectSimple/SelectSimple.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import * as stories from './SelectSimple.stories';
import { Canvas, Controls, Meta, Primary } from "@storybook/blocks";

<Meta of={stories} />

# Select Simple

## Definition

Le composant permet de sélectionner un unique élément parmi une liste fixe. Cette implémentation vise à reproduire le comportement d'un `select` natif sans son attribut `multiple`. On pourra aussi se référer au pattern ARIA [select-only combobox](https://www.w3.org/WAI/ARIA/apg/patterns/combobox/examples/combobox-select-only/).

Ce composant expose un sous-composant `SelectSimple.Option` pour définir la liste des choix.

<Primary/>

À la différence du [Combobox](/docs/components-form-combobox--docs), l'utilisateur est contraint de choisir une option dans la liste et ne peut pas renseigner un champ à la main.

## Props

Le composant accepte les props ci-dessous ainsi tous [les attributs d'un `button` HTML natif](https://developer.mozilla.org/fr/docs/Web/HTML/Element/button):

<Controls />

## Exemples

### Disabled

Renseigner la prop `disabled` permet de désactiver la sélection d'option.

<Canvas of={stories.disabled}/>

### Validation

Lorsque la prop `required` est fournie, le composant entre en erreur si l'on tente de valider le formulaire sans option sélectionnée.

<Canvas of={stories.validation}/>

### Default Value

Une `string` peut être donné à la prop `defaultValue` pour présélectionner une option.

<Canvas of={stories.defaultValue}/>
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,17 @@ export const validation: Story = {
</form>
),
};

export const defaultValue: Story = {
args: {
defaultValue: 'France',
},
render: ({ children, ...args }) => (
<>
<label htmlFor="pays">Pays</label>
<SelectSimple id="pays" {...args}>
{children.map((child) => <SelectSimple.Option value={child} key={child}>{child}</SelectSimple.Option>)}
</SelectSimple>
</>
),
};
Loading