govuk components

Ruby on Rails用のGov.ukコンポーネント

この宝石は、gov.uk設計システムに一連の再利用可能なコンポーネントを提供します。 Gov.uk Publishing Components Libraryの軽量な代替品を提供することを目的としており、GitHubのViewComponentフレームワークで構築されています。

これは、Rails開発者にとってより馴染みのある方法で、元のNunjucksマクロから機能を実装することを目的としています。ブロックはHTMLの文字列よりも優先され、表面の下には各コンポーネントはRubyオブジェクトであり、すべてが継承可能でオーバードライブです。

ドキュメント

宝石には、コードと出力の例とともに、日々の使用のほとんどの側面をカバーする完全なガイドが付属しています。ガイド（およびガイド自体）の例はコンポーネントを使用して構築されているため、常に最新の状態になります。

何が含まれていますか？

gov.uk設計システムの非型コンポーネントはすべて、このライブラリによってViewComponentsとして実装されています。フォームコンポーネントは、gov.ukフォームビルダーによって実装されます。

提供されたコンポーネントは次のとおりです。

• アコーディオン
• バックリンク
• パン粉
• クッキーバナー
• 詳細
• このページを終了します
• フッター
• ヘッダ
• 挿入テキスト
• 通知バナー
• パネル
• ページネーション
• フェーズバナー
• セクションブレイク
• スタートボタン
• 要約リスト
• タブ
• テーブル
• タグ
• タスクリスト
• 警告テキスト

このライブラリは、リンク、ボタン、スキップリンク、およびトップリンクを作成するためのヘルパーも提供します。

代替構文

すべてのコンポーネントは2つの方法でレンダリングできます。

• Railsの#renderメソッドを直接使用してください：

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

• ヘルパーラッパー経由：

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

  ヘルパーの命名規則は、 govuk_に続いて、ヘビの場合のコンポーネントの名前が続きます。 GovukComponentshelperの完全なリストを見ることができます。

使用します

このライブラリを使用すると、コンポーネントをRailsのrender方法で、または提供されたヘルパーを介してレンダリングできます。ここでは、 govuk_tabsを使用して、3つのタブ付きセクションをレンダリングします。

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

このライブラリを使用したサービス

• 教師のトレーニングに応募してください
• 大学院の教師トレーニングを見つけてください
• テクノロジーのヘルプを取得します
• 教師トレーニングコースを公開します
• 研修生の教師を登録します
• 欠員を教える

フォーク

• BetagouvSystèmedeDesign del'étatコンポーネント

インストール

この行をアプリケーションのGemfileに追加します。

 gem 'govuk-components'

そして実行してください：

bundle

または、自分でインストールします：

gem install govuk-components

貢献

バグレポートと機能リクエストは大歓迎です。問題を提起するか、プルリクエストを送信してください。

現在、Govuk Lintを使用して、コードがGov.ukのガイドラインを満たしていることを確認しています。 PRがこの標準にも付着していることを確認してください。

ログを清潔で整頓するのに役立つように、gitを構成してフルネームを使用してください。

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

ライセンス

宝石は、MITライセンスの条件の下でオープンソースとして利用できます。