publiccode.yml

# This repository adheres to the publiccode.yml standard by including this
# metadata file that makes public software easily discoverable.
# More info at https://github.com/publiccodeyml/publiccode.yml

publiccodeYmlVersion: "0"
name: "react-dsfr"
url: "https://github.com/codegouvfr/react-dsfr"
landingURL: "https://components.react-dsfr.codegouv.studio"
releaseDate: "2022-10-05"
platforms:
  - web
developmentStatus: beta
softwareType: library
logo: |-
  https://user-images.githubusercontent.com/6702424/192099597-567442d1-e6e1-4c17-ae3d-cac1e3bac5a0.png
categories:
  - website-builder
legal:
  license: MIT
maintenance:
  type: community
  contacts:
    - name: Joseph Garrone
      email: Joseph.garrone@protonmail.com
    - name: Julien Bouquillon
      affiliation: DNUM des ministères sociaux
    - name: Dylan DECRULLE
      affiliation: Insee
    - name: Enguerran Weiss
      affiliation: Plat
intendedAudience:
  scope:
    - science-and-technology
  countries:
    - FR
localisation:
  localisationReady: true
  availableLanguages:
    - fr
    - en
description:
  en:
    documentation: "https://react-dsfr.codegouv.studio/"
    shortDescription: French State Design System React integration
    features:
      - Always up to date with the latest DSFR evolutions
      - Integration with Next.js, Create React App and Vite
      - All DSFR components implemented
    longDescription: |
      This module is a wrapper/compatibility layer for [@gouvfr/dsfr](https://github.com/GouvernementFR/dsfr), the vanilla JS/CSS
      implementation of the DSFR.  

       > For TypeScript and JavaScript projects.

      - Fully TypeSafe, well documented API.

      - Always in up to date with latest the DSFR evolutions. Code and Types generated from [@gouvfr/dsfr](https://www.npmjs.com/package/@gouvfr/dsfr).

      - Exactly the same look and feel than with [@gouvfr/dsfr](https://www.npmjs.com/package/@gouvfr/dsfr).

      - No [white flash when reloading in SSR setup](https://github.com/codegouvfr/@codegouvfr/react-dsfr/issues/2#issuecomment-1257263480).

      - Most components are server component ready. The others are labeled with `"use client";`

      - Perfect integration with all major React framework: Next.js (PagesDir and AppDir), Create React App, Vue.

      - All [the components](https://www.systeme-de-design.gouv.fr/elements-d-interface) are implemented.

      - Three shakable distribution, cherry pick the components you import.

      - Optional integration with [MUI](https://mui.com/). If you use MUI components they will be automatically adapted to look like [DSFR components](https://www.systeme-de-design.gouv.fr/elements-d-interface). See [documentation](https://react-dsfr.codegouv.studio/mui-integration).

      - Enable CSS in JS by providing a `useTheme()` hooks that exposes the correct colors options and decision for the currently enabled color scheme.

      - Opt-in i18n, built in text can be displayed in multiple languages and user can provide extra translations.

      - [Support routing libraries](https://react-dsfr.codegouv.studio/routing) like react-router.

    videos:
      - "https://www.youtube.com/watch?v=5q88JgXUAY4"