Code Monkey home page Code Monkey logo

dsfr-view-components's Introduction

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.

11/36 composants sont disponibles :

  • Accordéon - Accordion
  • Alertes - Alert
  • Badge
  • Bandeau d'information importante
  • Barre de recherche - Search bar
  • Boutons - Buttons
  • Groupe de bouton
  • Bouton FranceConnect
  • Cartes - Cards
  • Citation - Quote
  • Contenu médias - Responsive médias
  • En-tête - Header
  • Fil d'Ariane - Breadcrumb
  • Gestionnaire de consentement - Consent banner
  • Icônes de favoris - Favicons
  • Indicateur d'étape - Stepper
  • Interrupteur - Toggle switch
  • Lettre d'information et réseaux sociaux - Newsletter & Follow us
  • Liens - Links
  • Liens d'évitement - Skiplinks
  • Menu latéral - Side menu
  • Mise en avant - Call out
  • Mise en exergue - Highlight
  • Modale - Modal
  • Navigation principale - Main navigation
  • Onglets - Tabs
  • Pagination
  • Paramètres d'affichage - Display
  • Partage - Share
  • Pied de page - Footer
  • Sélecteur de langue
  • Sommaire - Summary
  • Tableau - Table
  • Tag
  • Téléchargement de fichier
  • Tuile - Tile

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.

dsfr-view-components's People

Contributors

adipasquale avatar alexbowen avatar aliuk2012 avatar asmega avatar benilovj avatar broisatse avatar cesidio avatar cpjmcquillan avatar dependabot-preview[bot] avatar dependabot[bot] avatar despo avatar elliotcm avatar frankieroberto avatar freesteph avatar gpeng avatar josephhull676 avatar paulrobertlloyd avatar peteryates avatar rjlynch avatar robyoung91 avatar spone avatar stevehook avatar thomasleese avatar tijmenb avatar tvararu avatar yonif1 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.