govuk components

Gov.uk -Komponenten für Ruby on Rails

Dieses Juwel bietet eine Reihe wiederverwendbarer Komponenten für das GOV.UK -Designsystem. Es ist beabsichtigt, eine leichte Alternative zur Bibliothek der Gov.uk Publishing Components zu liefern, und ist mit Githubs ViewComponent -Framework erstellt.

Ziel ist es, die Funktionalität aus den ursprünglichen Nunjucks -Makros auf eine Weise zu implementieren, die Rails -Entwicklern eher vertraut anfühlt. Blöcke werden gegenüber HTML -Saiten bevorzugt. Unter der Oberfläche ist jede Komponente nur ein Rubinobjekt, alles ist vererbt und überschrieben.

Dokumentation

Das Edelstein verfügt über einen vollständigen Leitfaden, der die meisten Aspekte der täglichen Verwendung sowie Cod- und Ausgabebeispiele abdeckt. Die Beispiele in der Anleitung (und im Handbuch selbst) werden mit den Komponenten erstellt, sodass es immer auf dem neuesten Stand ist.

Was ist enthalten?

Alle Nichtformkomponenten des GOV.UK-Designsystems werden von dieser Bibliothek als ViewComponents implementiert. Formularkomponenten werden vom Gov.uk Form Builder implementiert.

Die bereitgestellten Komponenten sind:

• Akkordeon
• Rückverbindung
• Paniermehl
• Keksbanner
• Details
• Beenden Sie diese Seite
• Fußzeile
• Kopfball
• Eingelassener Text
• Benachrichtigungsbanner
• Panel
• Pagination
• Phasenbanner
• Abschnitt Break
• Startknopf
• Zusammenfassungsliste
• Registerkarten
• Tische
• Tags
• Aufgabenliste
• Warntext

Diese Bibliothek bietet außerdem Helfer zum Erstellen von Links, Schaltflächen, Überspringen von Links und zurück zu Top -Links.

Alternative Syntax

Alle Komponenten können auf zwei Arten gerendert werden:

• Direkt mit Rails ' #render -Methode:

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

• über die Helfer -Wrapper:

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

  Die Namenskonvention für Helfer ist govuk_ gefolgt vom Namen der Komponente im Schlangenfall. Sie können die vollständige Liste in GovukComponentShelper sehen.

Beispiel Verwendung

Mit dieser Bibliothek können Komponenten mit der render von Rails oder über die bereitgestellten Helfer gerendert werden. Hier verwenden wir die govuk_tabs , um drei Registerkartenabschnitte zu rendern:

 <%= 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 %>

Hier sind die gerenderten Registerkarten:

Beispiele zur Nutzung finden Sie auf der Handbuchseite.

Aufstellen

Fügen Sie diese Zeile Ihrer config/application.rb hinzu:

 require "govuk/components" 

Dienste mit dieser Bibliothek

• Bewerben Sie sich für die Lehrerausbildung
• Finden Sie postgraduale Lehrerausbildung
• Holen Sie sich Hilfe bei der Technologie
• Veröffentlichen Sie Lehrerausbildungskurse
• Registrieren Sie die Lehrer der Auszubildenden
• Leerstellen unterrichten

Gabeln

• Betagouv Système de Design de l'état View -Komponenten

Installation

Fügen Sie diese Zeile der GemFile Ihrer Anwendung hinzu:

 gem 'govuk-components'

Und dann ausführen:

bundle

Oder installieren Sie es selbst als:

gem install govuk-components

Beitragen

Fehlerberichte und Feature -Anfragen sind am meisten willkommen. Bitte stellen Sie ein Problem auf oder senden Sie eine Pull -Anfrage.

Derzeit verwenden wir Govuk Lint, um sicherzustellen, dass Code die GOV.UK -Richtlinien erfüllt. Bitte stellen Sie sicher, dass alle PRs auch diesen Standard halten.

Um die Protokolle sauber und ordentlich zu halten, konfigurieren Sie bitte Git so, dass Sie Ihren vollständigen Namen verwenden:

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

Lizenz

Das Edelstein ist unter den Bedingungen der MIT -Lizenz als Open Source erhältlich.