Merge branch 'main' of https://github.com/codegouvfr/react-dsfr

garronej · garronej · commit f19c34873821 · 2022-12-16T15:10:40.000+01:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@codegouvfr/react-dsfr",
-    "version": "0.5.2-rc.0",
+    "version": "0.5.3-rc.0",
     "description": "French State Design System React integration library",
     "repository": {
         "type": "git",
@@ -126,6 +126,7 @@
         "./Tabs": "./dist/Tabs.js",
         "./Stepper": "./dist/Stepper.js",
         "./SkipLinks": "./dist/SkipLinks.js",
+        "./Quote": "./dist/Quote.js",
         "./Notice": "./dist/Notice.js",
         "./Highlight": "./dist/Highlight.js",
         "./Header": "./dist/Header/index.js",
diff --git a/src/Breadcrumb.tsx b/src/Breadcrumb.tsx
@@ -1,73 +1,71 @@
-import React, { memo, forwardRef, useId } from "react";
+import React, { memo, forwardRef, useId, ReactNode } from "react";
 import { symToStr } from "tsafe/symToStr";
+import { assert } from "tsafe/assert";
+import type { Equals } from "tsafe";
+
 import { RegisteredLinkProps, useLink } from "./lib/routing";
+import { createComponentI18nApi } from "./lib/i18n";
 import { fr } from "./lib";
 import { cx } from "./lib/tools/cx";
 
-// We make users import dsfr.css, so we don't need to import the scoped CSS
-// but in the future if we have a complete component coverage it
-// we could stop requiring users to import the hole CSS and only import on a
-// per component basis.
 import "./dsfr/component/breadcrumb/breadcrumb.css";
 
 export type BreadcrumbProps = {
     className?: string;
     links: BreadcrumbProps.Link[];
+    classes?: Partial<Record<"root" | "button" | "collapse" | "list" | "link" | "text", string>>;
 };
 
 export namespace BreadcrumbProps {
     export type Link = {
-        text: string;
+        text: ReactNode;
         linkProps: RegisteredLinkProps;
         isActive?: boolean;
     };
 }
 
-//Longueur et lisibilité : Afin qu’il reste lisible, évitez que le fil d’Ariane soit trop long et passe sur plusieurs lignes.
-// Si les titres de page de votre site sont longs, nous conseillons de n’afficher que les 4 premiers mots du nom de la page courante et d’indiquer que l’élément est tronqué par l’affichage de “…”
-const trimText = (label: string) => {
-    if (label && label.split(" ").length > 4) {
-        return label.split(" ").slice(0, 4).join(" ") + "...";
-    }
-    return label;
-};
-
 /** @see <https://react-dsfr-components.etalab.studio/?path=/docs/components-breadcrumb> */
 export const Breadcrumb = memo(
     forwardRef<HTMLDivElement, BreadcrumbProps>((props, ref) => {
-        const { links, className, ...rest } = props;
+        const { links, className, classes = {}, ...rest } = props;
+
+        assert<Equals<keyof typeof rest, never>>();
+
+        const { t } = useTranslation();
 
         const { Link } = useLink();
         const breadcrumbId = useId();
+
         return (
             <nav
                 ref={ref}
                 role="navigation"
-                className={cx(fr.cx("fr-breadcrumb"), className)}
-                aria-label="vous êtes ici :"
+                className={cx(fr.cx("fr-breadcrumb"), classes.root, className)}
+                aria-label={`${t("navigation label")} :`}
                 {...rest}
             >
                 <button
-                    className="fr-breadcrumb__button"
+                    className={cx(fr.cx("fr-breadcrumb__button"), classes.button)}
                     aria-expanded="false"
                     aria-controls={breadcrumbId}
                 >
-                    Voir le fil d’Ariane
+                    {t("show breadcrumb")}
                 </button>
-                <div className="fr-collapse" id={breadcrumbId}>
-                    <ol className="fr-breadcrumb__list">
+                <div className={cx(fr.cx("fr-collapse"), classes.collapse)} id={breadcrumbId}>
+                    <ol className={cx(fr.cx("fr-breadcrumb__list"), classes.list)}>
                         <>
                             {links.map(link => (
                                 <li key={link.linkProps.href}>
                                     <Link
                                         {...link.linkProps}
                                         className={cx(
                                             fr.cx("fr-breadcrumb__link"),
+                                            classes.link,
                                             link.linkProps.className
                                         )}
                                         aria-current={link.isActive ? "page" : undefined}
                                     >
-                                        {trimText(link.text)}
+                                        {link.text}
                                     </Link>
                                 </li>
                             ))}
@@ -81,4 +79,22 @@ export const Breadcrumb = memo(
 
 Breadcrumb.displayName = symToStr({ Breadcrumb });
 
+const { useTranslation, addBreadcrumbTranslations } = createComponentI18nApi({
+    "componentName": symToStr({ Breadcrumb }),
+    "frMessages": {
+        "show breadcrumb": "Voir le fil d’Ariane",
+        "navigation label": "vous êtes ici"
+    }
+});
+
+addBreadcrumbTranslations({
+    "lang": "en",
+    "messages": {
+        "show breadcrumb": "Show navigation",
+        "navigation label": "you are here"
+    }
+});
+
+export { addBreadcrumbTranslations };
+
 export default Breadcrumb;
diff --git a/src/Quote.tsx b/src/Quote.tsx
@@ -0,0 +1,96 @@
+import React, { memo, forwardRef, ReactNode } from "react";
+import { symToStr } from "tsafe/symToStr";
+import { assert } from "tsafe/assert";
+import type { Equals } from "tsafe";
+
+import { FrClassName } from "./lib/generatedFromCss/classNames";
+import { cx } from "./lib/tools/cx";
+import { fr } from "./lib";
+
+import "./dsfr/component/quote/quote.css";
+
+export type QuoteProps = {
+    className?: string;
+    text: ReactNode;
+    author?: ReactNode;
+    source?: ReactNode;
+    sourceUrl?: string;
+    imageUrl?: string;
+    size?: "medium" | "large" | "xlarge";
+    accentColor?: QuoteProps.AccentColor;
+    classes?: Partial<Record<"root" | "author" | "source" | "image" | "imageTag" | "text", string>>;
+};
+
+export namespace QuoteProps {
+    type ExtractAccentColor<FrClassName> = FrClassName extends `fr-quote--${infer AccentColor}`
+        ? AccentColor
+        : never;
+
+    export type AccentColor = ExtractAccentColor<FrClassName>;
+}
+
+/** @see <https://react-dsfr-components.etalab.studio/?path=/docs/components-quote> */
+export const Quote = memo(
+    forwardRef<HTMLDivElement, QuoteProps>((props, ref) => {
+        const {
+            className,
+            text,
+            author,
+            source,
+            sourceUrl,
+            imageUrl,
+            size = "xlarge",
+            accentColor,
+            classes = {},
+            ...rest
+        } = props;
+
+        assert<Equals<keyof typeof rest, never>>();
+
+        return (
+            <figure
+                className={cx(
+                    fr.cx("fr-quote"),
+                    imageUrl && fr.cx("fr-quote--column"),
+                    accentColor && `fr-quote--${accentColor}`,
+                    classes.root,
+                    className
+                )}
+                ref={ref}
+            >
+                <blockquote cite={sourceUrl}>
+                    <p
+                        className={cx(
+                            size === "large" && fr.cx("fr-text--lg"),
+                            size === "medium" && fr.cx("fr-text--md"),
+                            classes.text
+                        )}
+                    >
+                        « {text} »
+                    </p>
+                </blockquote>
+                <figcaption>
+                    {author !== undefined && (
+                        <p className={cx(fr.cx("fr-quote__author"), classes.author)}>{author}</p>
+                    )}
+                    {source !== undefined && (
+                        <ul className={cx(fr.cx("fr-quote__source"), classes.source)}>{source}</ul>
+                    )}
+                    {imageUrl !== undefined && (
+                        <div className={cx("fr-quote__image", classes.image)}>
+                            <img
+                                src={imageUrl}
+                                className={cx(fr.cx("fr-responsive-img"), classes.imageTag)}
+                                alt=""
+                            />
+                        </div>
+                    )}
+                </figcaption>
+            </figure>
+        );
+    })
+);
+
+Quote.displayName = symToStr({ Quote });
+
+export default Quote;
diff --git a/stories/Breadcrumb.stories.tsx b/stories/Breadcrumb.stories.tsx
@@ -39,11 +39,3 @@ export const LongBreadcrumb = getStory({
         { text: "Page de démo 7", linkProps: { href: "/page7" }, isActive: true }
     ]
 });
-
-export const LongLabelBreadcrumb = getStory({
-    links: [
-        { text: "Accueil", linkProps: { href: "/" } },
-        { text: "Page 1", linkProps: { href: "/page1" } },
-        { text: "Un article très très long", linkProps: { href: "/article1" }, isActive: true }
-    ]
-});
diff --git a/stories/Quote.stories.tsx b/stories/Quote.stories.tsx
@@ -0,0 +1,108 @@
+import React from "react";
+import { Quote } from "../dist/Quote";
+import { sectionName } from "./sectionName";
+import { getStoryFactory } from "./getStory";
+
+const { meta, getStory } = getStoryFactory({
+    sectionName,
+    "wrappedComponent": { Quote },
+    "description": `
+- [See DSFR documentation](//www.systeme-de-design.gouv.fr/elements-d-interface/composants/citation)
+- [See source code](//github.com/codegouvfr/react-dsfr/blob/main/src/Quote.tsx)`,
+    "disabledProps": ["lang"]
+});
+
+export default meta;
+
+export const Default = getStory({
+    text: "Lorem [...] elit ut. ",
+    author: "Auteur",
+    source: (
+        <>
+            <li>
+                <cite>Ouvrage</cite>
+            </li>
+            <li>Détail 1</li>
+            <li>Détail 2</li>
+            <li>Détail 3</li>
+            <li>
+                <a
+                    target="_blank"
+                    href="[À MODIFIER | Lien vers la sources ou des infos complémentaires]"
+                >
+                    Détail 4
+                </a>
+            </li>
+        </>
+    ),
+    imageUrl: "//www.systeme-de-design.gouv.fr/img/placeholder.1x1.png",
+    size: "xlarge",
+    className: ""
+});
+
+export const QuoteMediumAndAccent = getStory({
+    text: "Lorem [...] elit ut. ",
+    author: "Auteur",
+    source: (
+        <>
+            <li>
+                <cite>Ouvrage</cite>
+            </li>
+            <li>Détail 1</li>
+            <li>Détail 2</li>
+            <li>Détail 3</li>
+            <li>
+                <a
+                    target="_blank"
+                    href="[À MODIFIER | Lien vers la sources ou des infos complémentaires]"
+                >
+                    Détail 4
+                </a>
+            </li>
+        </>
+    ),
+    imageUrl: "//www.systeme-de-design.gouv.fr/img/placeholder.1x1.png",
+    size: "medium",
+    accentColor: "pink-macaron"
+});
+
+export const QuoteWithoutDetails = getStory({
+    text: "Lorem [...] elit ut. ",
+    author: "Auteur",
+    imageUrl: "//www.systeme-de-design.gouv.fr/img/placeholder.1x1.png"
+});
+
+export const QuoteWithoutSource = getStory({
+    text: "Lorem [...] elit ut. ",
+    imageUrl: "//www.systeme-de-design.gouv.fr/img/placeholder.1x1.png"
+});
+
+export const QuoteWithoutIllustration = getStory({
+    text: "Lorem [...] elit ut. ",
+    author: "Auteur",
+    source: (
+        <>
+            <li>
+                <cite>Ouvrage</cite>
+            </li>
+            <li>Détail 1</li>
+            <li>Détail 2</li>
+            <li>Détail 3</li>
+            <li>
+                <a
+                    target="_blank"
+                    href="[À MODIFIER | Lien vers la sources ou des infos complémentaires]"
+                >
+                    Détail 4
+                </a>
+            </li>
+        </>
+    )
+});
+
+export const QuoteWithAccent = getStory({
+    text: "Lorem [...] elit ut. ",
+    imageUrl: "//www.systeme-de-design.gouv.fr/img/placeholder.1x1.png",
+    accentColor: "yellow-moutarde",
+    author: "Someone"
+});
