|
| 1 | +# This repository adheres to the publiccode.yml standard by including this |
| 2 | +# metadata file that makes public software easily discoverable. |
| 3 | +# More info at https://github.com/italia/publiccode.yml |
| 4 | + |
| 5 | +publiccodeYmlVersion: '0.2' |
| 6 | +name: '@codegouvfr/react-dsfr' |
| 7 | +url: 'https://github.com/codegouvfr/react-dsfr' |
| 8 | +landingURL: 'https://react-dsfr-components.etalab.studio/' |
| 9 | +releaseDate: '2022-10-05' |
| 10 | +developmentStatus: beta |
| 11 | +softwareVersion: 0.21.4 |
| 12 | +softwareType: library |
| 13 | +logo: |- |
| 14 | + https://user-images.githubusercontent.com/6702424/192099597-567442d1-e6e1-4c17-ae3d-cac1e3bac5a0.png |
| 15 | +categories: |
| 16 | + - website-builder |
| 17 | +maintenance: |
| 18 | + type: community |
| 19 | +intendedAudience: |
| 20 | + scope: |
| 21 | + - science-and-technology |
| 22 | + countries: |
| 23 | + - fr |
| 24 | +localisation: |
| 25 | + localisationReady: false |
| 26 | + availableLanguages: |
| 27 | + - fr |
| 28 | + - en |
| 29 | +it: |
| 30 | + conforme: |
| 31 | + gdpr: true |
| 32 | +description: |
| 33 | + en: |
| 34 | + documentation: 'https://react-dsfr.etalab.studio/' |
| 35 | + shortDescription: French State Design System React integration |
| 36 | + longDescription: | |
| 37 | + This module is a wrapper/compatibility layer for |
| 38 | + [@gouvfr/dsfr](https://github.com/GouvernementFR/dsfr), the vanilla JS/CSS |
| 39 | + implementation of the DSFR. |
| 40 | +
|
| 41 | + > For TypeScript and JavaScript projects. |
| 42 | +
|
| 43 | + - Fully TypeSafe, well documented API. |
| 44 | +
|
| 45 | + - Always in up to date with latest the DSFR evolutions. Code and Types |
| 46 | + generated from |
| 47 | + [`@gouvfr/dsfr`](https://www.npmjs.com/package/@gouvfr/dsfr)`/dist/dsfr.css`. |
| 48 | +
|
| 49 | + - Exactly the same look and feel than with |
| 50 | + [@gouvfr/dsfr](https://www.npmjs.com/package/@gouvfr/dsfr). |
| 51 | +
|
| 52 | + - No [white flash when reloading in SSR |
| 53 | + setup](https://github.com/codegouvfr/@codegouvfr/react-dsfr/issues/2#issuecomment-1257263480). |
| 54 | +
|
| 55 | + - Most components are server component ready. The others are labeled with |
| 56 | + `"use client";` |
| 57 | +
|
| 58 | + - [Perfect integration with all major React framework: Next.js (PagesDir |
| 59 | + and AppDir), Create React App, Vue](https://react-dsfr.etalab.studio/). |
| 60 | +
|
| 61 | + - All [the |
| 62 | + components](https://www.systeme-de-design.gouv.fr/elements-d-interface) |
| 63 | + are implemented (14/42, [see |
| 64 | + details](https://github.com/codegouvfr/react-dsfr/blob/main/COMPONENTS.md)) |
| 65 | +
|
| 66 | + - Three shakable distribution, cherry pick the components you import. |
| 67 | + (It's not all in a big .js bundle) |
| 68 | +
|
| 69 | + - Optional integration with [MUI](https://mui.com/). If you use MUI |
| 70 | + components they will be automatically adapted to look like [DSFR |
| 71 | + components](https://www.systeme-de-design.gouv.fr/elements-d-interface). |
| 72 | + See [documentation](https://react-dsfr.etalab.studio/mui-integration). |
| 73 | +
|
| 74 | + - Enable CSS in JS by providing a `useTheme()` hooks that exposes the |
| 75 | + correct colors options and decision for the currently enabled color |
| 76 | + scheme. |
| 77 | +
|
| 78 | + - Opt-in i18n, built in text can be displayed in multiple languages and |
| 79 | + user can provide extra translations. |
| 80 | +
|
| 81 | + - [Support routing libraries](https://react-dsfr.etalab.studio/routing) |
| 82 | + like react-router. |
| 83 | +
|
| 84 | +
|
| 85 | + This module is a product of [Etalab's Free and open source software |
| 86 | + pole](https://communs.numerique.gouv.fr/a-propos/). I'm working full time |
| 87 | + on this project. You can expect rapid development. |
| 88 | +
|
| 89 | +
|
| 90 | + |
| 91 | + screenshots: |
| 92 | + - |- |
| 93 | + https://user-images.githubusercontent.com/6702424/210700050-b5e273b6-067d-4864-a27a-3433e2b316a7.jpeg |
| 94 | + videos: |
| 95 | + - 'https://www.youtube.com/watch?v=5q88JgXUAY4' |
| 96 | + genericName: react-dsfr |
0 commit comments