README.md in katalyst-govuk-formbuilder-1.11.0 vs README.md in katalyst-govuk-formbuilder-1.12.0

- old
+ new

@@ -25,10 +25,16 @@ ```erb <%= stylesheet_link_tag "katalyst/govuk/formbuilder" %> ``` +You can also add it to your SASS build: + +```scss +@use "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: @@ -39,9 +45,33 @@ 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 +``` + +## Extensions + +We include some optional extensions for integrating with gems that we (Katalyst) commonly use. + +These require additional steps to use. + +### Hotwire Combobox + +[Hotwire Combobox](https://hotwirecombobox.com) is a promising option for adding asynchronous multi-select inputs to +Rails forms. We're assuming importmaps and Turbo if this option is used. + +There's no explicit dependency so if you want to use this input you'll need to add: + +``` +gem "hotwire_combobox" +``` + +JS is added by the gem automatically (via importmaps), but you'll need to explicitly add CSS: + +```scss +@use "katalyst/govuk/formbuilder"; +@use "katalyst/govuk/components/combobox"; ``` ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/katalyst/govuk-formbuilder.