Prefer form builder methods in Form Helpers guide [ci skip] #39344
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vipulnsward
reviewed
May 24, 2020
guides/source/form_helpers.md
Outdated
| value entered by the user for that field. For example, if the form contains | ||
| `<%= text_field_tag(:query) %>`, then you would be able to get the value of this | ||
| field in the controller with `params[:query]`. | ||
| The form builder object yielded by `form_with` provides numerous helper methods for generating form elements such as text fields, checkboxes, and radio buttons. The first parameter to these methods is always the name of the input. When the form is submitted, the name will be passed along with the form data, and will make its way to the `params` in the controller with the value entered by the user for that field. For example, if the form contains `<%= form.text_field :query %>`, then you would be able to get the value of this field in the controller with `params[:query]`. |
There was a problem hiding this comment.
Let's retain the multi-line if possible(unless this was visually affecting something).
It's easier to read/change in future than a single line + better for diffs.
jonathanhefner
force-pushed
the
guide-form_helpers
branch
from
edb1461
to
c0c6d1d
Compare
The Form Helpers guide should encourage users to use `form_with` and associated builder methods. The lower-level `*_tag` methods are covered by the API docs. These changes also fix some discrepancies between code examples and their descriptions.
jonathanhefner
force-pushed
the
guide-form_helpers
branch
from
c0c6d1d
to
612eb35
Compare
vipulnsward
reviewed
May 28, 2020
| <%= time_field(:task, :started_at) %> | ||
| <%= number_field(:product, :price, in: 1.0..20.0, step: 0.5) %> | ||
| <%= range_field(:product, :discount, in: 1..100) %> | ||
| <%= form.hidden_field :parent_id, value: "foo" %> |
There was a problem hiding this comment.
I forgot to post review comments. This one is missing one tag.
vipulnsward
reviewed
May 28, 2020
|
|
||
| WARNING: When `:include_blank` or `:prompt` are not present, `:include_blank` is forced true if the select attribute `required` is true, display `size` is one, and `multiple` is not true. | ||
|
|
||
| ### Option Tags from a Collection of Arbitrary Objects |
There was a problem hiding this comment.
Don't think we should remove this, there is no easy way to get to these. I have ended up on these docs quite a lot.
|
@jonathanhefner Although we migrated to form model usage, I don't think the guide warrants to remove all tag related docs that are not support by form_with, we should partially revert this. |
jonathanhefner
added a commit
to jonathanhefner/rails
that referenced
this pull request
Jun 4, 2020
Follow-up to rails#39344. Adds back mention of `text_area` helper.
jonathanhefner
added a commit
to jonathanhefner/rails
that referenced
this pull request
Jun 4, 2020
Follow-up to rails#39344. This adds back coverage of `collection_select`, adds new coverage of `collection_radio_buttons`, revises existing coverage of `collection_check_boxes`, and unifies these sections.
ghiculescu
reviewed
Aug 4, 2022
| <% end %> | ||
| ``` | ||
|
|
||
| WARNING: If you are using `select` or similar helpers to set a `belongs_to` association you must pass the name of the foreign key (in the example above `city_id`), not the name of association itself. |
There was a problem hiding this comment.
I think this was worth retaining - the new docs don't talk about associations at all, which is a common use case for f.select.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Form Helpers guide should encourage users to use
form_withand associated builder methods. The lower-level*_tagmethods are covered by the API docs.These changes also fix some discrepancies between code examples and their descriptions.
There are still several sections here that could use improvement. But this diff is already much longer than I'd hoped, and this felt like an OK checkpoint for this rabbit hole. 馃槄