Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ministryofjustice/govuk_elements_form_builder
Form builder helper methods to develop GOV.UK elements styled applications in Ruby on Rails
https://github.com/ministryofjustice/govuk_elements_form_builder
Last synced: 3 months ago
JSON representation
Form builder helper methods to develop GOV.UK elements styled applications in Ruby on Rails
- Host: GitHub
- URL: https://github.com/ministryofjustice/govuk_elements_form_builder
- Owner: ministryofjustice
- License: mit
- Archived: true
- Created: 2016-03-18T14:07:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-05T12:58:30.000Z (about 5 years ago)
- Last Synced: 2024-07-25T21:56:15.182Z (4 months ago)
- Language: Ruby
- Homepage: https://govuk-elements-rails-guide.herokuapp.com/
- Size: 222 KB
- Stars: 6
- Watchers: 16
- Forks: 14
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
Build Status:
[](https://travis-ci.org/ministryofjustice/govuk_elements_form_builder)
Code Climate: 
# This gem is out of date
For new projects built with the [GOV.UK Design System](https://design-system.service.gov.uk/)
it is recommended that you use the [GOV.UK Design System FormBuilder](https://github.com/DFE-Digital/govuk_design_system_formbuilder)
instead.
If you're working on an older project where upgrading to the GOV.UK Design
System isn't a viable option, don't worry. This gem will continue to receive
bug fixes and accessibility improvements.
# GovukElementsFormBuilder
To build GOV.UK based services you need to use
[govuk_elements](https://github.com/alphagov/govuk_elements) for presentation
and [govuk_frontend_toolkit](https://github.com/alphagov/govuk_frontend_toolkit)
for the interaction aspects.
This gem serves a form builder and other various helper methods to produces the
markup required to leverage presentation and interaction without having to
recreate the markup yourself.
## Documentation
Guidance and documentation for how to use this library can be found [here](https://govuk-elements-rails-guide.herokuapp.com/).
Any updates to the guidance should be submitted as pull requests to [this github repository](https://github.com/ministryofjustice/govuk_elements_rails_guide).
## Installation
Add these lines to your application's Gemfile, form builder is the last gem in list:
Version 0
```ruby
gem 'govuk_frontend_toolkit', '~> 6.0.0'
gem 'govuk_elements_rails', '~> 3.0.0'
gem 'govuk_elements_form_builder', '~>0.0.0'
```
Version 1+
```ruby
gem 'govuk_frontend_toolkit', '~> 6.0.0'
gem 'govuk_elements_rails', '~> 3.0.0'
gem 'govuk_elements_form_builder', '~>1.0.0'
```
And then execute:
```sh
bundle
```
## Usage
In your application's `config/application.rb` file, configure the form builder
to be the default like this:
```rb
class Application < Rails::Application
# ...
ActionView::Base.default_form_builder = GovukElementsFormBuilder::FormBuilder
end
```
You can see a visual guide to
[using the form builder](https://govuk-elements-rails-guide.herokuapp.com/)
here: https://govuk-elements-rails-guide.herokuapp.com/
## Versions - Which version should you used?
We encourage developers to use the latest version but understand that sometimes
it is not possible to do so. Seeing as there was quite a significant change
to the markup needed with the release of GOVUK Elements 3.0. We have decided to
create two supporting versions of the form builder for those services that use
the older GOVUK Elements and Frontend toolkit or who would like to use the
latest GOVUK assets.
Since version 1, GOVUK Elements and Frontend versions have now become a dependency
to help ensure that developers use the correct GOVUK Form builder version.
For the time being the only differences between the two versions is the markup
that this gem produces. We will try and keep the methods identical between versions
but if you decide to upgrade to version 1 you should check any pages that use
Radio buttons or Checkboxes and any js/css that rely on the markup these two
elements use. Another thing you should check is if you rely on the
css class name used for errors as this has also been renamed.
## Development
After checking out the repo, run `bundle install` to install dependencies.
Then, run `bundle exec rspec` to run the tests.
To install this gem onto your local machine, run `bundle exec rake install`.
To release a new version, update the version number in `version.rb`, and then
run `bundle exec rake release`, which will create a git tag for the version,
push git commits and tags, and push the `.gem` file to
[rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at
https://github.com/[USERNAME]/govuk_elements_form_builder. This project is
intended to be a safe, welcoming space for collaboration, and contributors are
expected to adhere to the [Contributor Covenant](contributor-covenant.org)
code of conduct.
## License
The gem is available as open source under the terms of
the [MIT License](http://opensource.org/licenses/MIT).