Requirements: Updates to <gcds-fieldset>, <gcds-radio-group> and <gcds-checkbox>

daine commented 1 month ago

📇 User story

As a GCDS team member, I want to have an updated requirements document for the Fieldset, Radio Group and Checkbox components, to ensure alignment between design and development.

As a GCDS team member, I want the requirements document to contain the proposed changes for the new property legend that is used as a label for both the Radio Group and Checkbox components, to ensure alignment between design and development.

As a GCDS team member, I want the requirements document to contain the proposed changes for grouping the checkboxes into a plural component, so that a fieldset can wrap it and provide a legend for it.

As a GCDS team member, I want the requirements document to contain the decision to rename the Radio Group and Checkbox components, to ensure consistency between the two components that behave similarly.

✅ Definition of Done / Outcomes

[x] The requirements documentation for both components is updated
[ ] Done when requirement doc is reviewed by a fellow developer (optional)
[ ] Done when requirement doc is reviewed by a designer (optional)
[ ] Done when requirement doc has final review by tech lead (optional)
[ ] Done when requirement doc has final review by design lead (optional)

📜 Acceptance criteria

[x] Contains the data model and new properties
[x] Fieldset is updated to show removed properties
[x] Radio Group is updated to contain the new property legend, along with code section
[x] Checkbox is updated to contain the new property legend, along with code section
[x] Checkbox is updated to contain the code changes to accommodate a group of checkboxes
[ ] A decision is made on the new name for the Radio Group
[ ] A decision is made on the new name for the Checkboxes

📝 More info

We have originally been recommending to use to wrap radio buttons () and checkboxes (checkbox). Unfortunately, this same HTML element provides multiple purposes such as grouping multiple form components, as well as being the primary label for a group of form choices in radio buttons or checkboxes.

. 🚫 Out of scope Other parts of the fieldset alignment work have tickets for them and is not within the scope of this ticket.

ClementineHahn commented 4 weeks ago

@ethanWallace progressing on this on this doc (to be added)

ethanWallace commented 4 weeks ago

Requirements documents:

ethanWallace commented 2 weeks ago

Will review this version with the devs and then get opinions from other team members about the changes,

cds-snc / design-gc-conception