feat(toggle): Add clarity around when to use a toggle vs. other components
What does this MR do?
Discussing the proposed design solution for issue gitlab-org/gitlab#328553 (closed) with @mle, resulted in a conversation around the use of Toggle vs Checkbox on the Settings page setting. This MR is an opportunity for the team to take the discussion forward and document a conclusion as a section in the guidelines.
- Removed table comparing the different selection components because it was hard to use
- Add section on
When to use a toggle
- Add comment to consider using a toast for feedback.
- Add reference to solution validation insight
- Add section
When not to use a toggle
- Add cases beyond needing to submit to consider not using a toggle
- Add other components as a list instead of a table from before
Does this MR meet the acceptance criteria?
-
The MR title and commit message meet the Pajamas commit conventions -
Add a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what -
Include MR scope that reflects the purpose of the change in the description - For example, if this MR is focused on
usage guidelines
, addressingaccessibility challenges
could be added separately with a different MR
- For example, if this MR is focused on
-
If creating a new page on Pajamas from scratch, follow the page template structure -
Follow the Pajamas Voice & Tone Guidelines and GitLab Documentation Style Guide -
Link components to and from other related components and patterns on the .md
file, where helpful -
If embedding a Figma file, follow the Figma embed guide -
Assign it to a reviewer. All GitLab designers are reviewers, but you can also assign it directly to a maintainer or trainee maintainer -
Apply the correct component label(s) -
Select a milestone or due date
Links
Edited by Taurie Davis