Components are packages of template, style, behaviour and documentation that live in your application or in static.
Components in applications are documented in component guides using the govuk_publishing_components gem. This mounts a component guide at the path
/component-guide in development, test and on Heroku review apps.
Find components in these guides:
- static component guide
- government-frontend component guide
- collections component guide
- finder-frontend component guide
A component must:
The govuk_publishing_components gem provides a generator to stub the files you’ll need in each component:
bundle exec rails generate govuk_publishing_components:component [component_name]
A lead paragraph component would be included in a template like this:
<%= render 'components/lead-paragraph', text: "A description is one or two leading sentences" %>