govuk components

Composants Gov.uk pour Ruby on Rails

Ce joyau fournit une suite de composants réutilisables pour le système de conception Gov.uk. Il est destiné à fournir une alternative légère à la bibliothèque de composants de publication Gov.uk et est construite avec le framework ViewComponent de GitHub.

Il vise à mettre en œuvre les fonctionnalités des macros nunjucks d'origine d'une manière qui sera plus familière aux développeurs Rails. Les blocs sont préférés aux chaînes de HTML, sous la surface, chaque composant est juste un objet Ruby, tout est héritable et trop ampliable.

Documentation

Le Gem est livré avec un guide complet qui couvre la plupart des aspects de l'utilisation quotidienne, ainsi que des exemples de code et de sortie. Les exemples du guide (et le guide lui-même) sont construits à l'aide des composants, donc il sera toujours à jour.

Qu'est-ce qui est inclus?

Tous les composants non formels du système de conception Gov.uk sont implémentés par cette bibliothèque en tant que ViewComponents. Les composants de formulaire sont implémentés par le générateur de formulaire Gov.uk.

Les composants fournis sont:

• Accordéon
• Lien de dos
• Chapelure
• Bannière cookie
• Détails
• Quitter cette page
• Pied de page
• Tête
• Texte en encart
• Bannière de notification
• Panneau
• Pagination
• Bannière de phase
• Break de la section
• Bouton de démarrage
• Liste de résumé
• Onglets
• Tables
• Balises
• Liste de tâches
• Texte d'avertissement

Cette bibliothèque fournit également des aides pour créer des liens, des boutons, des liens de sauts et des liens de retour aux meilleurs.

Syntaxe alternative

Tous les composants peuvent être rendus de deux manières:

• Utilisation directement de la méthode #render de Rails:

    <%= render GovukComponent::WarningTextComponent.new do %>
      A serious warning
    <% end %>

• via l'emballage d'assistance:

    <%= govuk_warning_text do %>
      A serious warning
    <% end %> 

  La convention de dénomination pour les aides est govuk_ suivie du nom du composant dans Case Snake. Vous pouvez voir la liste complète dans GovukComponentShelper.

Exemple d'utilisation

Cette bibliothèque permet de rendre des composants avec la méthode render de Rails ou via les aides fournies. Ici, nous utiliserons le govuk_tabs pour rendre trois sections à onglets:

 <%= govuk_tabs(title: 'Days of the week') do |component| %>
  <% component.with_tab(label: 'Monday') do %>
    < p > Monday’s child is fair of face </ p >
  <% end %>

  <% component . with_tab ( label : 'Tuesday' ) do %>
    < p > Tuesday’s child is full of grace </ p >
  <% end %>

  <% component . with_tab ( label : 'Wednesday' ) do %>
    < p > Wednesday’s child is full of woe </ p >
  <% end %>
<% end %>

Voici les onglets rendus:

Pour des exemples sur l'utilisation, consultez la page Guide.

Installation

Ajoutez cette ligne à votre config/application.rb :

 require "govuk/components" 

Services utilisant cette bibliothèque

• Demander une formation des enseignants
• Trouver la formation des enseignants de troisième cycle
• Obtenez de l'aide avec la technologie
• Publier des cours de formation des enseignants
• Enregistrer les enseignants des stagiaires
• Enseigner les postes vacants

Fourchettes

• Betagouv Système de Design de L'ÉTAT View Components

Installation

Ajoutez cette ligne à Gemfile de votre application:

 gem 'govuk-components'

Puis exécuter:

bundle

Ou installez-le vous-même comme:

gem install govuk-components

Contributif

Les rapports de bogues et les demandes de fonctionnalités sont les bienvenus, veuillez soulever un problème ou soumettre une demande de traction.

Actuellement, nous utilisons Govuk Lint pour s'assurer que le code répond aux directives Gov.uk. Veuillez vous assurer que tout PRS adhère également à cette norme.

Pour aider à garder les journaux propres et bien rangés, veuillez configurer Git pour utiliser votre nom complet:

git config --global user.name " Julius Hibbert " 

Licence

Le GEM est disponible en open source en vertu des termes de la licence du MIT.