From 82c7b16539f6de47726affa013d061103c647d08 Mon Sep 17 00:00:00 2001 From: Antoine Girard Date: Wed, 19 Feb 2025 23:45:59 +0100 Subject: [PATCH 1/2] Ajout des liens vers le storybook --- guide/content/components/accordion.haml | 2 +- guide/content/components/alert.haml | 2 +- guide/content/components/badge.haml | 2 +- guide/content/components/breadcrumbs.haml | 2 +- guide/content/components/button.haml | 2 +- guide/content/components/callout.haml | 2 +- guide/content/components/header.haml | 2 +- guide/content/components/highlight.haml | 2 +- guide/content/components/modal.haml | 2 +- guide/content/components/skiplink.haml | 2 +- guide/content/components/stepper.haml | 2 +- guide/content/components/tabs.haml | 2 +- guide/content/components/tag.haml | 2 +- guide/content/components/tile.haml | 2 +- guide/lib/helpers/content_helpers.rb | 12 ++++++------ 15 files changed, 20 insertions(+), 20 deletions(-) diff --git a/guide/content/components/accordion.haml b/guide/content/components/accordion.haml index b05bbccd..a8f0cc20 100644 --- a/guide/content/components/accordion.haml +++ b/guide/content/components/accordion.haml @@ -28,4 +28,4 @@ title: Accordéon - Accordion Si le niveau de titre par défaut (`H3`) ne vous convient pas, vous pouvez le surcharger en passant l'option `starting_header_level`. -= render('/partials/related-info.haml', links: dsfr_component_doc_link("Accordéons", "accordeon")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("accordeon", "accordion")) diff --git a/guide/content/components/alert.haml b/guide/content/components/alert.haml index 6b6d296b..af36a406 100644 --- a/guide/content/components/alert.haml +++ b/guide/content/components/alert.haml @@ -34,4 +34,4 @@ title: Alerte - Alert caption: "Alerte avec un bouton pour fermer", code: alert_md_with_close_button) -= render('/partials/related-info.haml', links: dsfr_component_doc_link("Alerte")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("alerte", "alert")) diff --git a/guide/content/components/badge.haml b/guide/content/components/badge.haml index 3ba8ef19..b0baea41 100644 --- a/guide/content/components/badge.haml +++ b/guide/content/components/badge.haml @@ -18,4 +18,4 @@ title: Badge - Badge = render('/partials/example.haml', caption: "Vue d'ensemble", code: badge_default) -= render('/partials/related-info.haml', links: dsfr_component_doc_link("Badge")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("badge", "badge")) diff --git a/guide/content/components/breadcrumbs.haml b/guide/content/components/breadcrumbs.haml index 7919ba2b..a23ae6e5 100644 --- a/guide/content/components/breadcrumbs.haml +++ b/guide/content/components/breadcrumbs.haml @@ -10,4 +10,4 @@ title: Fil d'Ariane – Breadcrumbs = render('/partials/example.haml', caption: "Vue d'ensemble", code: breadcrumbs) -= render('/partials/related-info.haml', links: dsfr_component_doc_link("Fil d'Ariane", "fil-d-ariane")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("fil-d-ariane", "breadcrumb")) diff --git a/guide/content/components/button.haml b/guide/content/components/button.haml index 145c47e7..ddf8b299 100644 --- a/guide/content/components/button.haml +++ b/guide/content/components/button.haml @@ -35,4 +35,4 @@ title: Bouton - Button La taille `:sm` pourra être utilisé pour créer certains composants, évitez de l’utiliser en mobile car la zone de “touch” sur écran tactile n’est pas suffisante. -= render('/partials/related-info.haml', links: dsfr_component_doc_link("Bouton")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("bouton", "button")) diff --git a/guide/content/components/callout.haml b/guide/content/components/callout.haml index 432661d2..bbbc33a6 100644 --- a/guide/content/components/callout.haml +++ b/guide/content/components/callout.haml @@ -21,4 +21,4 @@ title: Mise en avant - Callout Si votre hiérarchie de titre requiert un autre niveau de titre que H3 vous pouvez le spécifier en passant `starting_header_level` au composant. -= render('/partials/related-info.haml', links: dsfr_component_doc_link("Mise en avant", "mise-en-avant")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("mise-en-avant", "callout")) diff --git a/guide/content/components/header.haml b/guide/content/components/header.haml index 0dbd16d6..17276c09 100644 --- a/guide/content/components/header.haml +++ b/guide/content/components/header.haml @@ -50,4 +50,4 @@ title: En-tête - Header :markdown Cet exemple regroupe toutes les fonctionnalités d’un header. -= render '/partials/related-info.haml', links: dsfr_component_doc_link("Header", "en-tete") += render '/partials/related-info.haml', links: dsfr_component_doc_links("en-tete", "header") diff --git a/guide/content/components/highlight.haml b/guide/content/components/highlight.haml index 1468724a..7d31bd1a 100644 --- a/guide/content/components/highlight.haml +++ b/guide/content/components/highlight.haml @@ -19,4 +19,4 @@ title: Mise en exergue - Highlight :markdown Rendu avec une taille de texte élargie -= render('/partials/related-info.haml', links: dsfr_component_doc_link("Le composant Mise en exergue/Highlight", "mise-en-exergue")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("mise-en-exergue", "highlight")) diff --git a/guide/content/components/modal.haml b/guide/content/components/modal.haml index c6924c18..597c9520 100644 --- a/guide/content/components/modal.haml +++ b/guide/content/components/modal.haml @@ -32,7 +32,7 @@ title: Modale - Modal On peut donc par exemple utiliser des liens de navigation `dsfr_link_to` plutôt que des boutons. De la même manière, il faut aussi bien penser à modifier le bouton du header par un lien en utilisant le slot `header`. -= render('/partials/related-info.haml', links: dsfr_component_doc_link("Modale")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("modale", "modal")) :css .fr-tabs__panel { diff --git a/guide/content/components/skiplink.haml b/guide/content/components/skiplink.haml index b1082e04..cb04edb5 100644 --- a/guide/content/components/skiplink.haml +++ b/guide/content/components/skiplink.haml @@ -10,4 +10,4 @@ title: Lien d’évitement - Skiplink :markdown Le rendu de base du SkiplinkComponent. Pour voir le rendu appuyez sur la touche `Tab` de votre clavier. -= render('/partials/related-info.haml', links: dsfr_component_doc_link("lien-d-evitement")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("lien-d-evitement", "skiplink")) diff --git a/guide/content/components/stepper.haml b/guide/content/components/stepper.haml index e2f9b0f4..db688c82 100644 --- a/guide/content/components/stepper.haml +++ b/guide/content/components/stepper.haml @@ -19,4 +19,4 @@ title: Indicateur d'étape - Stepper Le titre de l’étape suivante est obligatoire pour toutes les étapes sauf la dernière. -= render('/partials/related-info.haml', links: dsfr_component_doc_link("Indicateur d'étape - Stepper", "indicateur-d-etapes")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("indicateur-d-etapes", "stepper")) diff --git a/guide/content/components/tabs.haml b/guide/content/components/tabs.haml index bd430c65..ec48be17 100644 --- a/guide/content/components/tabs.haml +++ b/guide/content/components/tabs.haml @@ -25,4 +25,4 @@ title: Onglet - Tab Chaque page affiche uniquement un onglet actif avec son contenu et les liens vers les autres onglets. L’onglet actif n’a pas besoin d’avoir de lien, il peut rester un bouton. -= render('/partials/related-info.haml', links: dsfr_component_doc_link("Tabs", "onglet")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("onglet", "tabs")) diff --git a/guide/content/components/tag.haml b/guide/content/components/tag.haml index 4e41fe6a..0335fb50 100644 --- a/guide/content/components/tag.haml +++ b/guide/content/components/tag.haml @@ -24,4 +24,4 @@ title: Tag - Tag Le handler JS `onclick` donné en exemple est indicatif, à vous de l’implémenter dans votre environnement. -= render('/partials/related-info.haml', links: dsfr_component_doc_link("Tag")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("tag", "tag")) diff --git a/guide/content/components/tile.haml b/guide/content/components/tile.haml index d4a5bf25..a5cf80da 100644 --- a/guide/content/components/tile.haml +++ b/guide/content/components/tile.haml @@ -29,4 +29,4 @@ title: Tuile - Tile Le niveau par défaut est `4`, vous pouvez l’augmenter ou le baisser selon votre contexte. -= render('/partials/related-info.haml', links: dsfr_component_doc_link("Tuile")) += render('/partials/related-info.haml', links: dsfr_component_doc_links("tuile", "tile")) diff --git a/guide/lib/helpers/content_helpers.rb b/guide/lib/helpers/content_helpers.rb index cbb377fa..2df03bee 100644 --- a/guide/lib/helpers/content_helpers.rb +++ b/guide/lib/helpers/content_helpers.rb @@ -1,6 +1,7 @@ module Helpers module ContentHelpers DSFR_COMPONENT_DOC_HREF = "https://www.systeme-de-design.gouv.fr/composants-et-modeles/composants".freeze + DSFR_COMPONENT_STORYBOOK_HREF = "https://storybook.systeme-de-design.gouv.fr".freeze def site_title "Composants Rails ViewComponent pour le Système de Design de lʼÉtat" @@ -8,12 +9,11 @@ def site_title private - def dsfr_component_doc_link(name, id = nil) - label = "#{name} sur la documentation du Système de Design de l'État" - - id ||= name.downcase - - { label => "#{DSFR_COMPONENT_DOC_HREF}/#{id}/" } + def dsfr_component_doc_links(doc_id = nil, storybook_id = nil) + { + "Voir dans la documentation officielle" => "#{DSFR_COMPONENT_DOC_HREF}/#{doc_id}/", + "Voir sur le Storybook officiel" => "#{DSFR_COMPONENT_STORYBOOK_HREF}/?path=/docs/#{storybook_id}--docs" + } end end end From efbaf6447d975c0b51d6a43bc29a0376652726f3 Mon Sep 17 00:00:00 2001 From: Antoine Girard Date: Tue, 25 Feb 2025 11:15:08 +0100 Subject: [PATCH 2/2] Review --- guide/lib/helpers/content_helpers.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/guide/lib/helpers/content_helpers.rb b/guide/lib/helpers/content_helpers.rb index 2df03bee..de0110c2 100644 --- a/guide/lib/helpers/content_helpers.rb +++ b/guide/lib/helpers/content_helpers.rb @@ -11,8 +11,8 @@ def site_title def dsfr_component_doc_links(doc_id = nil, storybook_id = nil) { - "Voir dans la documentation officielle" => "#{DSFR_COMPONENT_DOC_HREF}/#{doc_id}/", - "Voir sur le Storybook officiel" => "#{DSFR_COMPONENT_STORYBOOK_HREF}/?path=/docs/#{storybook_id}--docs" + "Voir #{@item[:title]} dans la documentation officielle" => "#{DSFR_COMPONENT_DOC_HREF}/#{doc_id}/", + "Voir #{@item[:title]} sur le Storybook officiel" => "#{DSFR_COMPONENT_STORYBOOK_HREF}/?path=/docs/#{storybook_id}--docs" } end end