Simple Form aims to be as flexible as possible while helping you with powerful components to create your forms. The basic goal of Simple Form is to not touch your way of defining the layout, letting you find the better design for your eyes. Most of the DSL was inherited from Formtastic, which we are thankful for and should make you feel right at home. This README is also available in a friendly navigable format and refers to Simple Form 3.

For older releases, check the related branch for your version. Simple Form can be easily integrated to the Bootstrap. To do that you have to use the bootstrap option in the install generator, like this:.

You have to be sure that you added a copy of the Bootstrap assets on your application. For more information see the generator output, our example application code and the live example app. To generate wrappers that are compatible with Zurb Foundation 5 , pass the foundation option to the generator, like this:. Please note that the Foundation wrapper does not support the: You will need to provide your own CSS styles for hints. Please see the instructions on how to install Foundation in a Rails app.

Simple Form was designed to be customized as you need to. Basically it's a stack of components that are invoked to create a complete html input for you, which by default contains label, hints, errors and the input itself.

It does not aim to create a lot of different logic from the default Rails form helpers, as they do a great job by themselves. Instead, Simple Form acts as a DSL and just maps your input type retrieved from the column definition in the database to a specific helper method. This will generate an entire form with labels for user name and password as well, and render errors by default when you render the form with invalid data after submitting for example.

You can overwrite the default label by passing it to the input method. You can also add a hint, an error, or even a placeholder. For boolean inputs, you can add an inline label as well:. In some cases you may want to disable labels, hints or errors.

Or you may want to configure the html of any of them:. It is also possible to pass any html attribute straight to the input, by using the: If you want to pass the same options to all inputs in the form for example, a default class , you can use the: Specific options in input call will overwrite the defaults:.

Since Simple Form generates a wrapper div around your label and input by default, you can pass any html attribute to that wrapper as well using the: By default all inputs are required.

When the form object includes ActiveModel:: Validations which, for example, happens with Active Record models , fields are required only when there is presence validation. Otherwise, Simple Form will mark fields as optional.

For performance reasons, this detection is skipped on validations that make use of conditional options, such as: By default, Simple Form will look at the column type in the database and use an appropriate input for the column. For example, a column created with type: See the section Available input types and defaults for each column type for a complete list of defaults.

You can also render boolean attributes using as: It is also possible to give the: Simple Form inputs accept the same options as their corresponding input type helper in Rails:.

The easiest way to achieve this is to use f. To view the actual RDocs for this, check them out here - http: And what if you want to create a select containing the age from 18 to 60 in your form?

You can do it overriding the: Collections can be arrays or ranges, and when a: Other types of collection are: Those are added by Simple Form to Rails set of form helpers read Extra Helpers section below for more information.

Class: SimpleForm::Inputs::Base — Documentation for plataformatec/simple_form (master)

Those methods are useful to manipulate the given collection. All other options given are sent straight to the underlying helper. For example, you can give prompt as:. You may also find it useful to explicitly pass a value to the optional: It is also possible to create grouped collection selects, that will use the html optgroup tags, like this:. Grouped collection inputs accept the same: Besides that, you can give:.

Simple Form also supports: When using such helpers, you can give: Those values can also be configured with a default value to be used on the site through the SimpleForm. To deal with associations, Simple Form can generate select inputs, a series of radios buttons or checkboxes. Lets see how it works: The structure would be something like:. This is going to render a: You can, of course, change it to use radio buttons and checkboxes as well:.

The association helper just invokes input under the hood, so all options available to: Additionally, you can specify the collection by hand, all together with the prompt:. Please note that the association helper is currently only tested with Active Record. It currently does not work well with Mongoid and depending on the ORM you're using your mileage may vary.

ruby on rails - How to create a grouped select box using simple_form? - Stack Overflow

All web forms need buttons, right? Simple Form wraps them in the DSL, acting like a proxy:. The button method also accepts optional parameters, that are delegated to the underlying submit call:. Say you wanted to use a rails form helper but still wrap it in Simple Form goodness? You can, by calling input with a block like so:. In the above example, we're taking advantage of Rails 3's select method that allows us to pass in a hash of additional attributes for each option.

They are listed below.

Wrapper to use Simple Form inside a default rails form. The following table shows the html element you will get for each attribute according to its database definition. These defaults can be changed by specifying the helper method in the column Mapping as the as: It is very easy to add custom inputs to Simple Form. For instance, if you want to add a custom input that extends the string one, you just need to add this file:.

You can also redefine existing Simple Form inputs by creating a new class with the same name. If needed, you can namespace your custom inputs in a module and tell Simple Form to look for their definitions in this module. This can avoid conflicts with other form libraries like Formtastic that look up the global context to find inputs definition too.

Simple Form uses all power of I18n API to lookup labels, hints, prompts and placeholders. To customize your forms you can create a locale file like this:. Simple Form also lets you be more specific, separating lookups through actions. Let's say you want a different label for new and edit actions, the locale file would be something like:. This way Simple Form will figure out the right translation for you, based on the action being rendered.

And to be a little bit DRYer with your locale file, you can specify defaults for all models under the 'defaults' key:. Simple Form will always look for a default attribute translation under the "defaults" key if no specific is found inside the model key. Finally, you can also overwrite any label, hint or placeholder inside your view, just by passing the option manually. This way the I18n lookup will be skipped.

Simple Form also has support for translating options in collection helpers. For instance, given a User with a: With Simple Form you could create an input like this:. And Simple Form will try a lookup like this in your locale file, to find the right labels to show:. You can also use the defaults key as you would do with labels, hints and placeholders. It is important to notice that Simple Form will only do the lookup for options if you give a collection composed of symbols only.

This is to avoid constant lookups to I18n. There are other options that can be configured through I18n API, such as required text and boolean. It should be noted that translations for labels, hints and placeholders for a namespaced model, e.

This is different from how translations for namespaced model and attribute names are defined:. Thus, similarly, if a form for an Admin:: Simple Form has several configuration options. You can read and change them in the initializer created by Simple Form , so if you haven't executed the command below yet, please do:. With Simple Form you can configure how your components will be rendered using the wrappers API.

The syntax looks like this:. The Form components will generate the form tags like labels, inputs, hints or errors contents. The available components are:. The Form extensions are used to generate some attributes or perform some lookups on the model to add extra information to your components.

If you want to customize the custom Form components on demand you can give it a name like this:. You can also define more than one wrapper and pick one to render in a specific form or input.

To define another wrapper you have to give it a name, as the follow:. Simple Form also allows you to use optional elements. For instance, let's suppose you want to use hints or placeholders, but you don't want them to be generated automatically. You can set their default values to false or use the optional method.

Is preferable to use the optional syntax:. By setting it as optional , a hint will only be generated when hint: The same for placeholder. It is also possible to give the option: By default, Simple Form will generate input field types and attributes that are supported in HTML5, but are considered invalid HTML for older document types such as HTML4 or XHTML1. The HTML5 extensions include the new field types such as email, number, search, url, tel, and the new attributes such as required, autofocus, maxlength, min, max, step.

Depending on the design of the application this may or may not be desired. In many cases it can break existing UI's. It is possible to disable all HTML 5 extensions in Simple Form by removing the html5 component from the wrapper used to render the inputs.

If you want to have all other HTML 5 features, such as the new field types, you can disable only the browser validation:. This option adds a new novalidate property to the form, instructing it to skip all HTML 5 validation. The inputs will still be generated with the required and other attributes, that might help you to use some generic javascript validation.

You can also add novalidate to a specific form by setting the option on the form itself:. Please notice that none of the configurations above will disable the placeholder component, which is an HTML 5 feature.

We believe most of the newest browsers are handling this attribute just fine, and if they aren't, any plugin you use would take care of applying the placeholder. In any case, you can disable it if you really want to, by removing the placeholder component from the components list in the Simple Form configuration file.

We believe browsers are not totally ready for these yet, but you can easily opt-in on a per-input basis by passing the html5 option:. If you have any questions, comments, or concerns please use the Google Group instead of the GitHub Issues tracker:. If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as possible to help us in fixing the potential bug. We also encourage you to help even more by forking and sending us a pull request. You are not granted rights or licenses to the trademarks of the Plataformatec, including without limitation the Simple Form name or logo.

Code Issues 66 Pull requests 22 Projects 0 Wiki Insights Pulse Graphs.

Forms made easy for Rails! It's tied to a simple DSL, with no opinion on markup. Clone or download Clone with HTTPS Use Git or checkout with SVN using the web URL. Open in Desktop Download ZIP.

Permalink Failed to load latest commit information. May 17, test Split test into single-behavior parts May 17, Wooo - wish I could pu… Aug 21, Jan 29, Gemfile Add support Rails 5. Jul 5, Gemfile. May 17, MIT-LICENSE Update copyright notices to [ci skip] Jan 3, README. Rails forms made easy. Installation Add it to your Gemfile: Completely turns off the custom wrapper f.

Terms Privacy Security Status Help. You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Remove ActiveRecord dependence; manually use as: Split test into single-behavior parts. Added a minlength validation on first attempt? Wooo - wish I could pu….

ruby on rails 3 - Add extra data to a simple_form input - Stack Overflow

Add support Rails 5. Update copyright notices to [ci skip]. Update Gemfiles to allow Rubinius and JRuby to run. Add those VMs to ….