Skip to content

Commit

Permalink
docs: 📝 met à jour la doc
Browse files Browse the repository at this point in the history
  • Loading branch information
laruiss committed Nov 10, 2023
1 parent 55e8b91 commit bcf800e
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 7 deletions.
6 changes: 3 additions & 3 deletions src/components/DsfrNavigation/DsfrNavigation.stories.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ export default {
control: 'object',
description: `Tableau d'objets. Chacun de ces objets contiendra :
- soit les props d’un lien direct <a href="/?path=/story/composants-navigation-principale-2-lien-de-menu-sous-menu-ou-mega-menu-dsfrnavigationmenulink--navigation-lien-menu">DsfrNavigationMenuLink</a> de navigation (\`to\` et \`text\`)
- soit les props d’un sous-menu <a href="/?path=/docs/composants-navigation-principale-3-sous-menu-dsfrnavigationmenu--navigation-sous-menu">DsfrNavigationMenu</a> de navigation (\`title\` et \`links\`)
- soit les props d’un mega-menu <a href="/?path=/story/composants-navigation-principale-4-mega-menu-dsfrnavigationmegamenu--navigation-mega-menu">DsfrNavigationMegaMenu</a> de navigation (\`title\`, \`link\` et \`menus\`)
- soit les props d’un lien direct <a href="/?path=/docs/composants-dsfrnavigationmenulink--docs">DsfrNavigationMenuLink</a> de navigation (\`to\` et \`text\`)
- soit les props d’un sous-menu <a href="/?path=/docs/composants-dsfrnavigationmenu--docs">DsfrNavigationMenu</a> de navigation (\`title\`, \`links\` et \`active\`)
- soit les props d’un mega-menu <a href="/?path=/docs/composants-dsfrnavigationmegamenu--docs">DsfrNavigationMegaMenu</a> de navigation (\`title\`, \`link\`, \`active\` et \`menus\`)
`,
},
label: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ export default {
},
link: {
control: 'object',
description: 'Permet de définir un lien vers une page associée. C’est un objet qui contiendra les props attendues par <a href="/?path=/story/composants-navigation-principale-2-lien-de-menu-sous-menu-ou-mega-menu-dsfrnavigationmenulink--navigation-lien-menu">DsfrNavigationMenuLink</a>',
description: 'Permet de définir un lien vers une page associée. C’est un objet qui contiendra les props attendues par <a href="/?path=/docs/composants-dsfrnavigationmenulink--docs">DsfrNavigationMenuLink</a>',
},
menus: {
control: 'object',
description: 'Liste des catégories au sein du méga menu via un tableau. Chaque objet de ce tableau contiendra les props attendues par <a href="/?path=/docs/composants-navigation-principale-5-catégorie-de-mega-menu-dsfrnavigationmegamenucategory--navigation-mega-menu-categorie">DsfrNavigationMegaMenuCategory</a>',
description: 'Liste des catégories au sein du méga menu via un tableau. Chaque objet de ce tableau contiendra les props attendues par <a href="/?path=/docs/composants-dsfrnavigationmegamenucategory--docs">DsfrNavigationMegaMenuCategory</a>',
},
expandedId: {
control: 'text',
Expand All @@ -30,6 +30,10 @@ export default {
control: 'text',
description: '(Optionnel) Valeur de l’attribut `id` de ce sous-menu. *N.B. : Il est recommandé de ne pas le donner, la bibliothèque lui en donnera un pseudo-aléatoire*.',
},
active: {
control: 'boolean',
description: '(Optionnel) Est-ce que le menu doit être actif ou non (met l’attribut `aria-current` à la valeur `true`). Par défaut, il est inactif.',
},
'toggle-id': {
description: 'Événement émis lors du click sur le lien, avec en argument l’id de l’élément cliqué',
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export default {
},
links: {
control: 'object',
description: 'Liste d’objets contenant les props de lien direct <a href="/?path=/story/composants-navigation-principale-2-lien-de-menu-sous-menu-ou-mega-menu-dsfrnavigationmenulink--navigation-lien-menu">DsfrNavigationMenuLink</a> de navigation (`to` et `text`)',
description: 'Liste d’objets contenant les props de lien direct <a href="/?path=/docs/composants-dsfrnavigationmenulink--docs">DsfrNavigationMenuLink</a> de navigation (`to` et `text`)',
},
},
}
Expand Down
6 changes: 5 additions & 1 deletion src/components/DsfrNavigation/DsfrNavigationMenu.stories.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@ export default {
},
links: {
control: 'object',
description: 'Tableau contenant les liens du menu de navigation. Chaque objet de ce tableau contiendra les props d’un lien direct <a href="/?path=/story/composants-navigation-principale-2-lien-de-menu-sous-menu-ou-mega-menu-dsfrnavigationmenulink--navigation-lien-menu">DsfrNavigationMenuLink</a> de navigation (`to` et `text`)',
description: 'Tableau contenant les liens du menu de navigation. Chaque objet de ce tableau contiendra les props d’un lien direct <a href="/?path=/docs/composants-dsfrnavigationmenulink--docs">DsfrNavigationMenuLink</a> de navigation (`to` et `text`)',
},
title: {
control: 'text',
description: 'Intitulé du menu',
},
active: {
control: 'boolean',
description: '(Optionnel) Est-ce que le menu doit être actif ou non (met l’attribut `aria-current` à la valeur `true`). Par défaut, il est inactif.',
},
expandedId: {
control: 'text',
description: 'Indique l’id de l’élément "ouvert" ou "déplié" dans le menu. Permet au composant de savoir s’il doit être déplié (si `expandedId` est identique à son `id`) ou non (si `expandedId` est différent de son `id`)',
Expand Down

0 comments on commit bcf800e

Please sign in to comment.