Skip to content

Commit

Permalink
docs : add duration component
Browse files Browse the repository at this point in the history
  • Loading branch information
QRuhier committed Oct 7, 2024
1 parent 578a69e commit 77efa20
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
25 changes: 25 additions & 0 deletions docs/docs/components/fields/duration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Duration

Le composant **Duration** permet à l'utilisateur de renseigner une durée. Elle peut être définie en :

- années / mois (format : PnYnM)
- heures / minutes (format : PTnHnM)

Le composant présente deux champs de saisie, mais la donnée est enregistrée dans une variable commune.
Par exemple en renseignant respectivement dans les champs 10 et 7, la valeur de la donnée sera :

- année / mois : "PT10H7M"
- heures / minutes : "P10Y7M"

Si une seule des deux valeurs est renseignée, la seconde prend pour valeur 0 (ex : P0Y5M).

Il est impossible de renseigner une valeur supérieure à 59 minutes (resp. 11 mois).

import timeSource from '../../../../src/stories/duration/time.json';
import { FormExample } from '@site/src/components/FormExample/FormExample';

<FormExample source={timeSource} />

import dateSource from '../../../../src/stories/duration/mois.json';

<FormExample source={dateSource} />
1 change: 1 addition & 0 deletions docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ const sidebars: SidebarsConfig = {
'components/fields/input-number',
'components/fields/textarea',
'components/fields/datepicker',
'components/fields/duration',
'components/fields/dropdown',
'components/fields/suggester',
'components/fields/radio',
Expand Down
2 changes: 1 addition & 1 deletion src/stories/duration/mois.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"name": "DUREE",
"values": {
"PREVIOUS": null,
"COLLECTED": null,
"COLLECTED": "P4Y0M",
"FORCED": null,
"EDITED": null,
"INPUTTED": null
Expand Down

0 comments on commit 77efa20

Please sign in to comment.