govuk components

Componentes de Gov.uk para Ruby on Rails

Esta gema proporciona un conjunto de componentes reutilizables para el sistema de diseño Gov.uk. Está destinado a proporcionar una alternativa liviana a la biblioteca de componentes de publicación Gov.uk y está construida con el marco ViewComponent de GitHub.

Su objetivo es implementar la funcionalidad de las macros originales de Nunjucks de una manera que se sentirá más familiar para los desarrolladores de Rails. Se prefieren bloques sobre cadenas de HTML, debajo de la superficie, cada componente es solo un objeto rubí, todo es heredable y inalcanzable.

Documentación

La gema viene con una guía completa que cubre la mayoría de los aspectos del uso diario, junto con los ejemplos de código y salida. Los ejemplos de la guía (y la guía en sí) se construyen utilizando los componentes, por lo que siempre estará actualizado.

¿Qué está incluido?

Esta biblioteca implementa todos los componentes que no son de forma del sistema de diseño Gov.uk como ViewComponents. Los componentes del formulario son implementados por el Gobinador de formulario GOV.UK.

Los componentes proporcionados son:

• Acordeón
• Enlace posterior
• Pan rallado
• Banner de galletas
• Detalles
• Salga de esta página
• Pie de página
• Encabezamiento
• Texto insertado
• Banner de notificación
• Panel
• Paginación
• Banner de fase
• Ruptura de la sección
• Botón de inicio
• Lista de resumen
• Cortina a la italiana
• Mesas
• Etiquetas
• Lista de tareas
• Texto de advertencia

Esta biblioteca también proporciona ayudantes para crear enlaces, botones, omitir enlaces y regresar a los enlaces superiores.

Sintaxis alternativa

Todos los componentes se pueden representar de dos maneras:

• Utilizando directamente el método #render de Rails:

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

• a través del envoltorio de ayuda:

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

  La convención de nombres para ayudantes es govuk_ seguido del nombre del componente en el caso de serpiente. Puede ver la lista completa en GovukComponentShelper.

Ejemplo de uso

Esta biblioteca permite que los componentes se rendericen con el método render de Rails o a través de los ayudantes proporcionados. Aquí usaremos los govuk_tabs para representar tres secciones con pestañas:

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

Aquí están las pestañas renderizadas:

Para ver ejemplos sobre el uso, consulte la página Guía.

Configuración

Agregue esta línea a su config/application.rb :

 require "govuk/components" 

Servicios utilizando esta biblioteca

• Solicitar la capacitación del maestro
• Encuentra capacitación de maestros de posgrado
• Obtenga ayuda con la tecnología
• Publicar cursos de capacitación para maestros
• Registre a los maestros en prácticas
• Enseñanza de vacantes

Horquilla

• Betagouv Système de Design de L'Etat View Components

Instalación

Agregue esta línea al archivo gem de su aplicación:

 gem 'govuk-components'

Y luego ejecutar:

bundle

O instálelo usted mismo como:

gem install govuk-components

Que contribuye

Los informes de errores y las solicitudes de funciones son bienvenidas, plantean un problema o envíe una solicitud de extracción.

Actualmente estamos usando la pelusa de Govuk para garantizar que el código cumpla con las pautas de Gov.uk. Asegúrese de que cualquier PRS también se adhiera a este estándar.

Para ayudar a mantener los registros limpios y ordenados, configure Git para usar su nombre completo:

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

Licencia

La gema está disponible como código abierto bajo los términos de la licencia MIT.