| Class | SimpleForm::Wrappers::Builder |
| In: |
lib/simple_form/wrappers/builder.rb
|
| Parent: | Object |
Provides the builder syntax for components. The builder provides three methods `use`, `optional` and `wrapper` and they allow the following invocations:
config.wrappers do |b|
# Use a single component
b.use :html5
# Use the component, but do not automatically lookup. It will only be triggered when
# :placeholder is explicitly set.
b.optional :placeholder
# Use a component with specific wrapper options
b.use :error, wrap_with: { tag: "span", class: "error" }
# Use a set of components by wrapping them in a tag+class.
b.wrapper tag: "div", class: "another" do |ba|
ba.use :label
ba.use :input
end
# Use a set of components by wrapping them in a tag+class.
# This wrapper is identified by :label_input, which means it can
# be turned off on demand with `f.input :name, label_input: false`
b.wrapper :label_input, tag: "div", class: "another" do |ba|
ba.use :label
ba.use :input
end
end
The builder also accepts default options at the root level. This is usually used if you want a component to be disabled by default:
config.wrappers hint: false do |b|
b.use :hint
b.use :label_input
end
In the example above, hint defaults to false, which means it won‘t automatically do the lookup anymore. It will only be triggered when :hint is explicitly set.