Skip to content

betagouv/dsfr-view-components

Repository files navigation

Composants du DSFR

Tests Gem Version Gem GitHub license Rails Ruby

Design Système de lʼÉtat

Cette gem fournit des composants pour le Design Système de l'État (DSFR) en s'appuyant sur le framework ViewComponent.

C'est un fork de govuk-components qui propose l'équivalent pour le GOV.UK Design System.

Documentation

Un guide complet est disponible. Il contient des instructions pour l'installation et l'usage de cette gem. Les exemples présents éxecutent le code et seront donc toujours à jour.

Installation

Pour utiliser cette gem dans votre application Rails, il faut ajouter cette ligne dans config/application.rb:

require "dsfr/components"

Composants disponibles

Cette gem a pour but de supporter tous les composants proposés par le Design Système de l'État hormis ceux concernant les formulaires. Ceux-ci seront fournis dans une gem indépendante dans le futur.

La liste des composants implémentés ou restants est consultable grâce au label composant sur ce même dépôt.

Services utilisant cette gem

Contribuer

Nous conseillons d'utiliser rbenv pour gérer vos versions de ruby :

rbenv local 3.1.2
rbenv install

Lancer les tests :

bundle install
bundle exec rspec spec

Pour développer avec les tests en continu :

bundle exec guard

Lancer le guide de documentation :

make watch-guide

Utilisez le générateur pour créer un nouveau composant :

bin/rails g dsfr_component FancyButton --params title:String count:Integer

Lancer la dummy app pour itérer sur les composants :

cd spec/dummy
bundle install && npm install
bundle exec rails server

Déployer une nouvelle version de la gem :

VERSION=1.3.2 make deploy_gem

Licence

Le code source et la gem sont ouverts sous la licence MIT.