Toggle doc updates #4214

alina-jacob · 2024-08-23T18:32:27Z

Closes #3065 and #4227

New

[Usage Tab]

Added Overview image.
Added content and image for Anatomy section.
Added content and image supporting small toggle with action text.
Added general additional content referring to the Usage tab docs.

[Style Tab]

Added Page description, Anchorlinks and Feedback section

Changed

[Usage Tab]

Replaced the Interactive states image with a table.
Updated the variant image (label to component spacing)
Clarified guidance around optional elements across Toggle variants.

[Style Tab]

Updated the component color and interactive color image.
Updated the toggle spec and toggle sizes images (label to component spacing)

Removed

[Usage Tab]

Removed the interactive states image and replaced it with a table.

General

Updated all existing and new images to have the correct label to component spacing.

vercel · 2024-08-23T18:32:31Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
carbondesignsystem	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 29, 2024 2:43pm

thyhmdo

Looks great! In general, default and small variants don't need to be capitalized within the sentence

src/pages/components/toggle/images/toggle-style-states.png

src/pages/components/toggle/usage.mdx

Co-authored-by: thyhmdo <77697351+thyhmdo@users.noreply.github.com>

src/pages/components/toggle/style.mdx

laurenmrice

Hey Alina! Looking good, ⭐️ just some grammatical things to fix. I also have left some comments about images in your Figma file.

src/pages/components/toggle/usage.mdx

src/pages/components/toggle/style.mdx

Kritvi-bhatia17

Hi Alina! Great work, just a few minor typos and fixes.

src/pages/components/toggle/style.mdx

src/pages/components/toggle/usage.mdx

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

guidari

LGTM!

laurenmrice

Looking good @alina-jacob ✨ Just a couple more things! Some of these were reviewed previously and were not fixed, so I added them again! I think they might have gotten lost in the collapsible buckets.

src/pages/components/toggle/usage.mdx

laurenmrice · 2024-08-28T21:44:06Z

First style structure image
For your first style structure image, I would just extend the teal padding container/lines to the right more to hit where the text ends (like in your second structure image) so they are consistent. I added a red line here to show to extend it to that.

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

laurenmrice

Looks good, Alina!

Kritvi-bhatia17

Looks good to me Alina! Great work ✨🔥
(Just one last very minor typo)

Kritvi-bhatia17 · 2024-08-29T16:07:35Z

src/pages/components/toggle/style.mdx

@@ -57,7 +77,7 @@ tabs: ['Usage', 'Style', 'Code', 'Accessibility']
 </Column>
 </Row>

-<Caption>Interactive toggle states</Caption>
+<Caption>Interactive toggle states.</Caption>


Suggested change

<Caption>Interactive toggle states.</Caption>

<Caption>Interactive toggle states</Caption>

Kritvi-bhatia17 · 2024-09-02T08:38:36Z

Hi @alina-jacob! I just noticed that the "Variants" heading should be H3 instead of H2. For more information, you can refer to the Pagination Usage doc, which is the most recent update. I just noticed this and thought of mentioning it. If you could fix this minor issue in your Menu button PR, that would be great, but if not, we can fix it later. Thank you!

toggle_us

38b3274

alina-jacob requested review from a team as code owners August 23, 2024 18:32

alina-jacob requested review from kennylam, guidari and oliviaflory August 23, 2024 18:32

alina-jacob requested a review from laurenmrice August 23, 2024 18:32

vercel bot deployed to Preview August 23, 2024 18:36 View deployment

Merge branch 'main' into toggle_us

8d68817

laurenmrice added the status: ready for review 👀 label Aug 26, 2024

vercel bot deployed to Preview August 26, 2024 14:31 View deployment

thyhmdo reviewed Aug 26, 2024

View reviewed changes

alina-jacob and others added 5 commits August 26, 2024 20:44

Update src/pages/components/toggle/usage.mdx

17b0098

Co-authored-by: thyhmdo <77697351+thyhmdo@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

3a53cbd

Co-authored-by: thyhmdo <77697351+thyhmdo@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

a7827c9

Co-authored-by: thyhmdo <77697351+thyhmdo@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

40db1a9

Co-authored-by: thyhmdo <77697351+thyhmdo@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

eda1bab

Co-authored-by: thyhmdo <77697351+thyhmdo@users.noreply.github.com>

vercel bot deployed to Preview August 26, 2024 15:22 View deployment

Kritvi-bhatia17 reviewed Aug 26, 2024

View reviewed changes

src/pages/components/toggle/style.mdx Outdated Show resolved Hide resolved

laurenmrice requested changes Aug 26, 2024

View reviewed changes

Kritvi-bhatia17 requested changes Aug 26, 2024

View reviewed changes

Merge branch 'main' into toggle_us

7120e96

vercel bot deployed to Preview August 26, 2024 17:00 View deployment

alina-jacob and others added 6 commits August 26, 2024 23:56

Update src/pages/components/toggle/style.mdx

9061d7c

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

5470c4a

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

675ae85

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

f8142dc

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

cd90fab

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

Update src/pages/components/toggle/style.mdx

bd67942

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

alina-jacob and others added 3 commits August 28, 2024 14:40

Update src/pages/components/toggle/usage.mdx

b86b481

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

2670e70

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

33f996e

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

alina-jacob requested a review from laurenmrice August 28, 2024 09:11

vercel bot deployed to Preview August 28, 2024 09:30 View deployment

guidari approved these changes Aug 28, 2024

View reviewed changes

laurenmrice requested changes Aug 28, 2024

View reviewed changes

alina-jacob and others added 4 commits August 29, 2024 11:54

Update src/pages/components/toggle/usage.mdx

2d9dbcb

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

b4c99c8

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

e9fa1d4

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

Update src/pages/components/toggle/usage.mdx

63fb4e7

Co-authored-by: Lauren Rice <43969356+laurenmrice@users.noreply.github.com>

vercel bot deployed to Preview August 29, 2024 06:32 View deployment

update_#

27cd680

alina-jacob added the status: one more review 👀 label Aug 29, 2024

vercel bot deployed to Preview August 29, 2024 07:27 View deployment

update_4

98800b6

alina-jacob requested a review from laurenmrice August 29, 2024 10:52

vercel bot deployed to Preview August 29, 2024 11:03 View deployment

update_5

e11c68b

vercel bot deployed to Preview August 29, 2024 14:43 View deployment

laurenmrice approved these changes Aug 29, 2024

View reviewed changes

alina-jacob added status: ready to merge 🎉 and removed status: one more review 👀 status: ready for review 👀 labels Aug 29, 2024

alina-jacob requested a review from Kritvi-bhatia17 August 29, 2024 14:49

Kritvi-bhatia17 approved these changes Aug 29, 2024

View reviewed changes

kodiakhq bot merged commit e71ad45 into carbon-design-system:main Aug 29, 2024
7 checks passed

alina-jacob mentioned this pull request Sep 5, 2024

Menu buttons accessibility tab doc update #4240

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Toggle doc updates #4214

Toggle doc updates #4214

alina-jacob commented Aug 23, 2024 •

edited

Loading

vercel bot commented Aug 23, 2024 •

edited

Loading

thyhmdo left a comment

laurenmrice left a comment

Kritvi-bhatia17 left a comment

guidari left a comment

laurenmrice left a comment

laurenmrice commented Aug 28, 2024

laurenmrice left a comment

Kritvi-bhatia17 left a comment

Kritvi-bhatia17 Aug 29, 2024

Kritvi-bhatia17 commented Sep 2, 2024

	<Caption>Interactive toggle states.</Caption>
	<Caption>Interactive toggle states</Caption>

Toggle doc updates #4214

Toggle doc updates #4214

Conversation

alina-jacob commented Aug 23, 2024 • edited Loading

vercel bot commented Aug 23, 2024 • edited Loading

thyhmdo left a comment

Choose a reason for hiding this comment

laurenmrice left a comment

Choose a reason for hiding this comment

Kritvi-bhatia17 left a comment

Choose a reason for hiding this comment

guidari left a comment

Choose a reason for hiding this comment

laurenmrice left a comment

Choose a reason for hiding this comment

laurenmrice commented Aug 28, 2024

laurenmrice left a comment

Choose a reason for hiding this comment

Kritvi-bhatia17 left a comment

Choose a reason for hiding this comment

Kritvi-bhatia17 Aug 29, 2024

Choose a reason for hiding this comment

Kritvi-bhatia17 commented Sep 2, 2024

alina-jacob commented Aug 23, 2024 •

edited

Loading

vercel bot commented Aug 23, 2024 •

edited

Loading