🇫🇷 French State Design System React toolkit 🇫🇷

Components documentation - Guides - Playground

👉 Version française du README ici.

WARNING: This Design System is only meant to be used for official French's public service websites.
Its main purpose is to make it easy to identify governmental websites for citizens. See terms.

This module is an advanced toolkit that leverages @gouvfr/dsfr, the vanilla JS/CSS implementation of the DSFR.

While this module is written in TypeScript, using TypeScript in your application is optional (but recommended as it comes with outstanding benefits to both you and your codebase).

[x] Fully TypeSafe, well documented API.
[x] Always in up to date with latest the DSFR evolutions. Code and Types generated from @gouvfr/dsfr/dist/dsfr.css.
[x] Exactly the same look and feel than with @gouvfr/dsfr.
[x] No white flash when reloading in SSR setup.
[x] Most components are server component ready. The others are labeled with "use client";
[x] Perfect integration with all major React framework: Next.js (PagesDir and AppDir), Create React App, Vite.
[x] (Almost) All the components are implemented
[x] Three shakable distribution, cherry pick the components you import. (It's not all in a big .js bundle)
[x] Optional integration with MUI. If you use MUI components they will be automatically adapted to look like DSFR components. See documentation.
[x] Enable the usage of CSS in JS solutions. Doc.
[x] Opt-in i18n, built in text can be displayed in multiple languages and user can provide extra translations.
[x] Support routing libraries like react-router.

💡 Need ready to use, DSFR compliant login and register pages? Checkout keycloak-theme-dsfr.

🚀 Get started 🚀

Governance

This module is a product of Etalab's Free and open source software pole.

This project is co-maintained by public servants from various French administrations:

Joseph Garrone - Insee
Julien Bouquillon - DNUM des ministères sociaux
Dylan DECRULLE - Insee
Enguerran Weiss - Plateforme de l'Inclusion

Development

git clone https://github.com/codegouvfr/react-dsfr
cd react-dsfr
yarn

# Starting storybook
yarn storybook

# Starting test apps
yarn start-cra  # For testing in a Create React App setup
yarn start-vite # For testing in a Vite setup
yarn start-next-pagesdir # For testing in a Next.js 13 PagesDir setup (the default setup)
yarn start-next-appdir # For testing in a Next.js 13 AppDir setup

# Run all unit test (test/runtime):
yarn test
# Run only test/runtime/cssVariable.test.ts (for example)
npx vitest -t "Resolution of CSS variables"

Want to contribute?

Thank you! See the contribution guide.

How to publish a new version on NPM, how to release a beta version

This repo was bootstrapped form garronej/ts-ci have a look at the documentation of this starter for understanding the lifecycle of this repo.

Use-cases

A few projects that use @codegouvfr/react-dsfr.

codegouvfr / react-dsfr

readme

Governance

Development

Want to contribute?

How to publish a new version on NPM, how to release a beta version

Use-cases