AwesomeForm is yet another form helper for
Rails, but, contrary to
SimpleForm it relies on partial views instead of html helpers.
Each input type is a partial in its theme directory, and wrappers are made using the
layout option of the
For instance, a boolean field will be rendered using a partial named
_boolean in the
app/views/awesome_form directory (See below for further explanation on partials lookup).
The same principles apply with form actions, each action is mapped to a partial file and eventually wrapped using a layout file.
AwesomeForm doesn't differ much of using
= awesome_form_for resource, url: resource_path(resource) do |form| = form.inputs :attribute, :another_attribute = form.input :some_attribute, as: :boolean = form.actions :submit, :cancel
Model Attributes Discovery
When using the
inputs method without any symbols as arguments (an options hash can be passed), the form builder will attempt to discover attributes of the model. By default it'll generate an input for every column of the model as well as for each association (both
Columns can be excluded by adding them to the
AwesomeForm.excluded_columns array. By default, only timestamps columns are ignored.
AwesomeForm.setup do |config| config.excluded_columns << %w(column_to_ignore another_column_to_ignore) end
By default, both
has_many associations appears in discovered model's attributes. The default associations are configurable using
AwesomeForm.setup do |config| config.default_associations = [:belongs_to] end
The lookup process for a form input takes place as follow:
First, we look for a partial for the given model attribute, either at the top level or in the selected theme:
If a partial cannot be found for the model attribute, we look for a partial for the attribute's type:
And if there's no partial for the attribute's type, we look for the default input partial.
The same kind of lookup is used for fields wrappers, but instead of looking into the
inputs view directory, it'll look into the
Fields wrappers are just layouts, and as every layout, the content of the view is injected where the
yield keyword is found in the layout.
Action Views Lookup
A similar lookup is performed to find actions's views and wrappers:
For the action itself:
And for the wrapper:
As you may notice, the action wrapper lookup doesn't fallback on any default.
When rendering a view for an input, both the layout and the input partial receive many locals that contains data about the field.
A basic input will receive:
attribute_name: The name of the attribute as passed to the
model_name: The name of the model in
resource_name: The pluraized name of the model in
object_name: The name of the field prior to the call to
input. For instance, when in a
object: A reference to the target object of the form.
builder: A reference to the builder object of the form.
type: The type of input to generate for the attribute.
And according to the model attribute type, the locals object will also contains more specialized properties:
column_type: For a simple column (not an association), it will contains the type of the database column such as defined in the schema (
association_type: If the attribute is an association, the
association_typeis set with the name of the association (
association, an array containing the possible values for the field.
association, an array containing the selected values for the field.
And of course all the options passed to the
input method are available as locals in the view.
Actions locals only differs in that
attribute_name are replaced with