Clarify that browser_validations default differs between gem and generator#1871
Open
vitor-de-castro wants to merge 1 commit into
Open
Clarify that browser_validations default differs between gem and generator#1871vitor-de-castro wants to merge 1 commit into
vitor-de-castro wants to merge 1 commit into
Conversation
…rator The README states SimpleForm.browser_validations defaults to true, but the install generator explicitly sets it to false in the generated initializer. This is intentional (documented in the generator template's inline comment) due to inconsistent native HTML5 validation behavior across browsers, but this distinction was not mentioned anywhere in the README, leading to confusion. Adds a note clarifying the difference and how to restore the gem-level default if desired. Fixes heartcombo#1746
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
The README states
SimpleForm.browser_validationsdefaults totrue,but the install generator explicitly sets it to
falsein thegenerated initializer.
Why
This is intentional behaviour, documented in an inline comment in the
generator template, due to inconsistent native HTML5 validation
across browsers. However this distinction was not mentioned anywhere
in the README, leading users to reasonably expect
trueafterrunning
rails generate simple_form:install, when in fact they getfalse.Changes
Adds a short note in the README clarifying the difference between
the gem-level default and what the generator sets, and how to
restore the gem-level default if desired.
Fixes #1746