kotovalexarian-likes-github/heartcombo--simple_form
1
0
Fork 0
mirror of https://github.com/heartcombo/simple_form.git synced 2022-11-09 12:19:26 -05:00
Code Releases Activity

Clarify how extra options are sent down to the Rails collection helpers

Browse source 
Simple Form passes down all unrecognized options directly to the Rails
helpers so you can customize how they're used, but that wasn't super
clear in the Readme, this improves it a bit.

Related to #1728. [ci skip]
This commit is contained in:
Carlos Antonio da Silva 2021-02-25 18:10:21 -03:00
parent 886713cb07
commit 2fa860e5f6
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -326,14 +326,13 @@ If you want to change this behavior you must make it explicit, like this:
<% end %>
```
All other options given are sent straight to the underlying helper. For example, you can give prompt as:
All other options given are sent straight to the underlying Rails helper(s): [`collection_select`](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_select), [`collection_check_boxes`](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_check_boxes), [`collection_radio_buttons`](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_radio_buttons). For example, you can pass `prompt` and `selected` as:
```ruby
f.input :age, collection: 18..60, prompt: "Select your age", selected: 21
```
Extra options are passed into helper [`collection_select`](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_select).
You may also find it useful to explicitly pass a value to the optional `:selected`, especially if passing a collection of nested objects.
It may also be useful to explicitly pass a value to the optional `:selected` like above, especially if passing a collection of nested objects.
It is also possible to create grouped collection selects, that will use the html *optgroup* tags, like this: