chore: update design system docs#4109
Open
marianayovcheva wants to merge 1 commit into
Open
Conversation
marianayovcheva
commented
May 14, 2026
| <%% end %> | ||
| ``` | ||
|
|
||
| The `:value_method` and `:text_method` parameters are methods to be called on each member of `collection`. The return values are used as the value attribute and contents of each checkbox. |
Contributor
Author
There was a problem hiding this comment.
I've removed this but happy to add some text if it's still useful to have a line about the id and the name.
marianayovcheva
force-pushed
the
chore/form-fields-docs-update
branch
from
570da2a to
8da6e52
Compare
This takes into account the updates in v9.1.0 named `additional_attributes` was deprecated. Other named parameters like `collection`, `text_method` and `value_method` have also been deprecated.
marianayovcheva
force-pushed
the
chore/form-fields-docs-update
branch
from
8da6e52 to
97f3e13
Compare
marianayovcheva
added
the
docs preview
Contributor
|
🚀 Netlify deployed citizens-advice-design-system as draft https://6a05ea2d2365eb00b484e72c--citizens-advice-design-system.netlify.app |
davidrapson
approved these changes
May 14, 2026
Contributor
davidrapson
left a comment
davidrapson
left a comment
There was a problem hiding this comment.
🙏 Thank you for picking this up. I'm keen to drop the view component parts of the docs for forms sooner rather than later but agree doesn't need to be in this PR
davidrapson
reviewed
May 14, 2026
Comment on lines
+213
to
+214
| :id, | ||
| :name, |
Contributor
There was a problem hiding this comment.
Oh just noticed these should be :last, :first as the collection is still an array in the examples. Just in case people copy and paste this as part of running through the guide
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
2 participants
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.
This takes into account the updates in v9.1.0 named
additional_attributeswas deprecated. Other named parameters likecollection,text_methodandvalue_methodhave also been deprecated.Having read https://github.com/citizensadvice/design-system/blob/main/contributing/adr/2025-11-28-deprecate-form-components.md I was also contemplating removing the "View component version" section of the docs for the form elements or adding a bit of text to discourage users from going for that option. However, I've decided not to do it as part of this PR so that this decision is kept separate. Also, it might be too early to do it and worth waiting until we officially deprecate the view components version of the form fields (or move them to Legacy as per the suggestion in #4049). In any case, opinions/ideas welcome!