Sha256: 2401b23173dec4729fa7e064c281da7776be8c8f9efbe1492fb5e97e04edabce
Contents?: true
Size: 1.4 KB
Versions: 12
Compression:
Stored size: 1.4 KB
Contents
# Katalyst::GOVUK::Formbuilder
Repacking of [GOV.UK Frontend](https://frontend.design-system.service.gov.uk) and
[GOV.UK form components](https://govuk-form-builder.netlify.app) for use in Katalyst projects.
## Installation
Add this line to your application's Gemfile:
```ruby
gem "katalyst-govuk-formbuilder"
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install katalyst-govuk-formbuilder
## Usage
Add the stylesheet to your default layout:
```erbruby
<%= stylesheet_link_tag "katalyst/govuk/formbuilder" %>
```
Some GOVUK components require javascript enhancements
(see [GOVUK docs](https://frontend.design-system.service.gov.uk/get-started/#5-get-the-javascript-working)).
You can use the provided helper to load the formbuilder esm from importmaps and enhance your form:
```erbruby
<%= form_with ... %>
<%= govuk_formbuilder_init %>
```
You'll need to include the helper to make this method available, which you can add to your `ApplicationController`:
```ruby
helper Katalyst::GOVUK::Formbuilder::Frontend
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/katalyst/govuk-formbuilder.
## Release
Update the version number in `lib/katalyst/govuk/formbuilder/version.rb` and run:
```bash
bundle exec rake release
```
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
Version data entries
12 entries across 12 versions & 1 rubygems