Socket
Socket
Sign inDemoInstall

@gouvfr/dsfr

Package Overview
Dependencies
Maintainers
3
Versions
43
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@gouvfr/dsfr

Design System de l'Etat


Version published
Weekly downloads
15K
increased by7.68%
Maintainers
3
Weekly downloads
 
Created
Source

Design System

Le Design System de l'Etat est un ensemble de composants html / css / js ayant pour but de faciliter la vie des développeurs et intégrateurs pour bâtir leurs interfaces.

Installation

Vous pouvez utiliser npm ou yarn afin d'installer la librairie.

npm install @gouvfr/dsfr

ou

yarn add @gouvfr/dsfr

Configuration de votre projet Lors de la création de votre projet, il est préférable d’adopter l’arborescence prévue par celui-ci, à savoir les fichiers HTML à la racine de projets, et les différentes sources dans des dossiers spécifiques :

/ Racine du projet
└── fonts
└── css
└── js
└── favicons
└── index.html

Le HTML Le point de départ de l’utilisation du DS est la création de fichiers HTML, afin de pouvoir utiliser les différents composants. Ces fichiers sont à mettre à la racine de votre projet. L’exemple ci dessous est le code minimal afin de pouvoir utiliser le design System.

L’ajout de l’attribut data-rf-theme sur la balise html permet d’activer la gestion des thèmes clair et sombre. Les valeurs possibles sont vide, light ou dark.

L’attribut data-rf-reset est déprécié , le ‘reset’ est désomais activé d’office.

<!doctype html>
<html lang="fr" data-rf-theme>
  <head>
    <title>Titre de la page - Nom du site</title>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <link rel="stylesheet" href="css/dsfr.min.css">
    <link rel="apple-touch-icon" href="favicons/apple-touch-icon.png"><!-- 180×180 -->
    <link rel="icon" href="favicons/favicon.svg" type="image/svg+xml">
    <link rel="shortcut icon" href="favicons/favicon.ico" type="image/x-icon"><!-- 32×32 -->
    <link rel="manifest" href="favicons/manifest.webmanifest" crossorigin="use-credentials">
    <!-- Modifier les chemins relatifs des favicons en fonction de la structure du projet -->
    <!-- Dans le fichier manifest.webmanifest aussi, modifier les chemins vers les images -->
  </head>
  <body>

    <!-- 
      
      code de la page


     -->

    <!-- Script en version es6 module et nomodule pour les navigateurs le ne supportant pas -->
    <script type="module" src="js/dsfr.module.min.js"></script>
    <script type="text/javascript" nomodule src="js/dsfr.nomodule.min.js"></script>
  </body>
</html>

Les CSS

Afin d’inclure la totalité des composants et des styles du DS, il est nécessaire d’inclure la feuille de style dsfr.min.css.

Le Javascript

L’ensemble du code javascript nécessaire au bon fonctionnement du DS se trouve dans deux fichiers dsfr.module.min.js et dsfr.nomodule.min.js. Le fichier dsfr.module.min.js utilise les modules javascript natifs. Le fichier dsfr.nomodule.min.js est utilisé par les anciens navigateurs ne supportant pas les modules javascript. Il est donc impératif d’appeler les deux fichiers javascript afin que le code s’exécute correctement sur l’ensemble des navigateurs supportés.

Contribution

La contribution n'est pas encore possible en dehors de la core team, mais nous allons très prochainement ouvrir le repository git !

🙌 Vous êtes maintenant prêt(e) à utiliser le Design System de l'État.

FAQs

Package last updated on 24 Mar 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc