govuk components

Компоненты gov.uk для Ruby on Rails

Этот драгоценный камень предоставляет набор многоразовых компонентов для системы проектирования Gov.uk. Он предназначен для предоставления легкой альтернативы библиотеке компонентов Gov.uk и построена из фреймворта GitHub ViewComponent.

Он направлен на реализацию функциональности от оригинальных макросов Nunjucks таким образом, чтобы чувствовать себя более знакомым разработчикам Rails. Блоки предпочтительнее по струнам HTML, под поверхностью каждый компонент является просто рубиновым объектом, все наследует и переопределяется.

Документация

GEM поставляется с полным руководством, которое охватывает большинство аспектов повседневного использования, а также примеры кода и вывода. Примеры в руководстве (и сама руководство) создаются с использованием компонентов, поэтому он всегда будет в курсе.

Что включено?

Все компоненты, не являющиеся формой из системы проектирования Gov.uk, реализованы этой библиотекой в качестве ViewComponents. Компоненты формы реализованы с помощью строителя формы Gov.uk.

Предоставленные компоненты:

• Аккордеон
• Задняя ссылка
• Панировочные сухари
• Баннер для печенья
• Подробности
• Выйдите из этой страницы
• Нижний колонтитул
• Заголовок
• Вставка текста
• Уведомление Баннер
• Панель
• Страница
• Фазовый баннер
• Разрыв секции
• Кнопка начала
• Список резюме
• Вкладки
• Столы
• Теги
• Список задач
• Предупреждающий текст

Эта библиотека также предоставляет помощников для создания ссылок, кнопок, пропуска ссылок и обратно на верхние ссылки.

Альтернативный синтаксис

Все компоненты могут быть представлены двумя способами:

• непосредственно с использованием метода #render Rails:

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

• через вспомогательную обертку:

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

  Конвенция о именовании для помощников - govuk_ , за которым следует имя компонента в корпусе Snake. Вы можете увидеть полный список в Govukcomponentshelper.

Пример использования

Эта библиотека позволяет отображать компоненты с помощью метода render Rails или с помощью предоставленных помощников. Здесь мы будем использовать govuk_tabs , чтобы отобразить три раздела вкладок:

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

Вот отображенные вкладки:

Примеры при использовании см. Страницу руководства.

Настраивать

Добавьте эту строку в свой config/application.rb :

 require "govuk/components" 

Услуги с использованием этой библиотеки

• Подать заявку на обучение учителей
• Найдите обучение учителей аспирантов
• Получите помощь с технологиями
• Публикуйте курсы обучения учителей
• Зарегистрировать учителей -стажеров
• Преподавание вакансий

Форк

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

Установка

Добавьте эту строку в Gemfile вашего приложения:

 gem 'govuk-components'

А затем выполнить:

bundle

Или установите его самостоятельно как:

gem install govuk-components

Внося

Отчеты об ошибках и запросы на функции являются наиболее приветствующимися, пожалуйста, поднимите проблему или отправьте запрос на привлечение.

В настоящее время мы используем Govuk Lint для обеспечения соответствия коду. Пожалуйста, убедитесь, что любые PR также придерживаются этого стандарта.

Чтобы помочь сохранить журналы чистыми и аккуратными, пожалуйста, настройте GIT, чтобы использовать ваше полное имя:

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

Лицензия

Драгоценный камень доступен в качестве открытого исходного кода в соответствии с условиями лицензии MIT.