govuk components

Komponen Gov.uk untuk Ruby on Rails

Permata ini menyediakan serangkaian komponen yang dapat digunakan kembali untuk sistem desain Gov.uk. Ini dimaksudkan untuk memberikan alternatif yang ringan untuk perpustakaan Komponen Penerbitan Gov.uk dan dibangun dengan kerangka kerja ViewComponent GitHub.

Ini bertujuan untuk mengimplementasikan fungsionalitas dari makro Nunjucks asli dengan cara yang akan terasa lebih akrab bagi pengembang Rails. Blok lebih disukai daripada string HTML, di bawah permukaan masing -masing komponen hanyalah objek ruby, semuanya warisan dan dapat ditimpa.

Dokumentasi

Permata hadir dengan panduan lengkap yang mencakup sebagian besar aspek penggunaan sehari-hari, bersama dengan contoh kode dan output. Contoh -contoh dalam panduan (dan panduan itu sendiri) dibangun menggunakan komponen, sehingga akan selalu up to date.

Apa yang termasuk?

Semua komponen non-bentuk dari sistem desain GOV.UK diimplementasikan oleh pustaka ini sebagai komponen view. Komponen formulir diimplementasikan oleh pembangun formulir GOV.UK.

Komponen yang disediakan adalah:

• Akordeon
• Tautan kembali
• Tepung roti
• Cookie Banner
• Detail
• Keluar dari halaman ini
• Footer
• Header
• Teks inset
• Banner Pemberitahuan
• Panel
• Pagination
• Banner fase
• Istirahat bagian
• Tombol Mulai
• Daftar Ringkasan
• Tab
• Tabel
• Tag
• Daftar tugas
• Teks peringatan

Perpustakaan ini juga menyediakan pembantu untuk membuat tautan, tombol, lompatan tautan, dan kembali ke tautan teratas.

Sintaks alternatif

Semua komponen dapat diterjemahkan dengan dua cara:

• Langsung Menggunakan Metode #render Rails:

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

• Melalui pembungkus helper:

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

  Konvensi penamaan untuk pembantu adalah govuk_ diikuti oleh nama komponen dalam kasing ular. Anda dapat melihat daftar lengkap di GovukComponentShelper.

Contoh Penggunaan

Perpustakaan ini memungkinkan komponen untuk diberikan dengan metode render Rails atau melalui pembantu yang disediakan. Di sini kita akan menggunakan govuk_tabs untuk membuat tiga bagian tab:

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

Berikut adalah tab yang diberikan:

Sebagai contoh tentang penggunaan, lihat halaman panduan.

Pengaturan

Tambahkan baris ini ke config/application.rb Anda:

 require "govuk/components" 

Layanan Menggunakan Perpustakaan Ini

• Melamar pelatihan guru
• Temukan pelatihan guru pascasarjana
• Dapatkan bantuan dengan teknologi
• Menerbitkan kursus pelatihan guru
• Daftar guru peserta pelatihan
• Mengajar lowongan

Garpu

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

Instalasi

Tambahkan baris ini ke gemfile aplikasi Anda:

 gem 'govuk-components'

Dan kemudian mengeksekusi:

bundle

Atau instal sendiri sebagai:

gem install govuk-components

Berkontribusi

Laporan bug dan permintaan fitur paling disambut, silakan angkat masalah atau kirimkan permintaan tarik.

Saat ini kami menggunakan Govuk Lint untuk memastikan kode memenuhi pedoman GOV.UK. Pastikan PR apa pun juga mematuhi standar ini.

Untuk membantu menjaga log tetap bersih dan rapi, harap konfigurasikan git untuk menggunakan nama lengkap Anda:

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

Lisensi

Permata tersedia sebagai open source di bawah ketentuan lisensi MIT.