Clarify docs for radio and checkbox conditionals #3552
Merged
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
The documentation for the conditional Nunjucks macro option for checkboxes and radios is confusing. The checkboxes documentation lists `conditional` as a boolean, and the radios documentation lists it as a string. Neither are correct. The `conditional` option is an object with a single nested option, `html`. The nested `html` option is a string, used to specify the content that is revealed when the checkbox or radio is checked. Update the component YAML so that the documentation reflects this.
|
Thanks @36degrees You probably know I've written types for the YAML component data here: This is so we can get autocomplete (and checks) in tests using But the example data just has a generic Might reveal other places where we've got the object structure wrong |
querkmachine
approved these changes
Apr 26, 2023
This was referenced Jun 23, 2023
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 documentation for the conditional Nunjucks macro option for checkboxes and radios is confusing.
The checkboxes documentation lists
conditionalas a boolean, and the radios documentation lists it as a string.Neither are correct.
The
conditionaloption is an object with a single nested option,html. The nestedhtmloption is a string, used to specify the content that is revealed when the checkbox or radio is checked.Update the component YAML so that the documentation reflects this.
Checkboxes
Before
After
Radios
Before
After
Closes #1903