govuk components

Componentes Gov.uk para Ruby on Rails

Esta jóia fornece um conjunto de componentes reutilizáveis para o sistema de design Gov.uk. Destina -se a fornecer uma alternativa leve à biblioteca de componentes do Gov.uk de publicação e é criada com a estrutura ViewComponent do Github.

Ele pretende implementar a funcionalidade das macros originais de Nunjucks de uma maneira que parecerá mais familiar aos desenvolvedores da Rails. Os blocos são preferidos a cordas de HTML, abaixo da superfície Cada componente é apenas um objeto Ruby, tudo é herdável e superestável.

Documentação

A GEM vem com um guia completo que abrange a maioria dos aspectos do uso diário, juntamente com exemplos de código e saída. Os exemplos no guia (e o próprio guia) são construídos usando os componentes, por isso estará sempre atualizado.

O que está incluído?

Todos os componentes que não são de forma do sistema de design do Gov.uk são implementados por esta biblioteca como viewConents. Os componentes do formulário são implementados pelo Gov.uk Form Builder.

Os componentes fornecidos são:

• Acordeão
• Link para trás
• Farinha de rosca
• Banner de biscoitos
• Detalhes
• Saia desta página
• Rodapé
• Cabeçalho
• Texto inserido
• Banner de notificação
• Painel
• Paginação
• Banner de fase
• Quebra de seção
• Botão Iniciar
• Lista de resumo
• Guias
• Mesas
• Tags
• Lista de tarefas
• Texto de advertência

Esta biblioteca também fornece ajudantes para criar links, botões, links de pular e voltar aos principais links.

Sintaxe alternativa

Todos os componentes podem ser renderizados de duas maneiras:

• Usando diretamente o método #render do Rails:

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

• através do invólucro auxiliar:

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

  A convenção de nomenclatura para ajudantes é govuk_ seguida pelo nome do componente no caso de cobra. Você pode ver a lista completa no GovukComponentshelper.

Exemplo de uso

Esta biblioteca permite que os componentes sejam renderizados com o método render do Rails ou através dos ajudantes fornecidos. Aqui usaremos o govuk_tabs para renderizar três seções com guias:

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

Aqui estão as guias renderizadas:

Para exemplos de uso, consulte a página do guia.

Configurar

Adicione esta linha à sua config/application.rb :

 require "govuk/components" 

Serviços usando esta biblioteca

• Inscreva -se para o treinamento de professores
• Encontre treinamento de professores de pós -graduação
• Obtenha ajuda com a tecnologia
• Publicar cursos de treinamento de professores
• Registre professores de estagiários
• Ensino de vagas

Garfos

• BetaGouv Système de Design de l'état View Components

Instalação

Adicione esta linha ao GemFile do seu aplicativo:

 gem 'govuk-components'

E depois execute:

bundle

Ou instale você mesmo como:

gem install govuk-components

Contribuindo

Relatórios de bugs e solicitações de recursos são bem -vindos, por favor, levante um problema ou envie uma solicitação de tração.

Atualmente, estamos usando fiapos do Govuk para garantir que o código atenda às diretrizes do Gov.uk. Certifique -se de que qualquer PRS também siga este padrão.

Para ajudar a manter os troncos limpos e arrumados, configure o Git para usar seu nome completo:

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

Licença

A GEM está disponível como código aberto nos termos da licença do MIT.