There's a lot of open issues
A gem to document components in GOV.UK frontend applications
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies
 Project Readme

GOV.UK Publishing Components

status JavaScript Style Guide Stylelint Style Guide

A Ruby gem to document and distribute components for GOV.UK applications. It provides:

  • a shared library of components
  • helpers to generate component payloads
  • an application to preview components and provide guidance
  • GOV.UK Design System styles and components (via GOV.UK Frontend)

Components should be added to this gem if they are required in more than one application, otherwise they should be added to that application. All components should meet the same standards of browser and assistive technology support described in GOV.UK Frontend.

Technical documentation

You can use the GOV.UK Docker environment or the local startup.sh script to run the app. Read the guidance on local frontend development to find out more about each approach, before you get started.

If you are using GOV.UK Docker, remember to combine it with the commands that follow. See the GOV.UK Docker usage instructions for examples.

Running the test suite

bundle exec rake

To run JavaScript tests (only):

# run JS tests in browser
bin/rake app:jasmine

# run JS tests on command line
bin/rake app:jasmine:ci

Further documentation

Licence

MIT Licence