Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Small breadcrumb] Website docs #4432

Open
12 tasks
laurenmrice opened this issue Jan 15, 2025 · 1 comment
Open
12 tasks

[Small breadcrumb] Website docs #4432

laurenmrice opened this issue Jan 15, 2025 · 1 comment

Comments

@laurenmrice
Copy link
Member

laurenmrice commented Jan 15, 2025

Acceptance criteria

Update the Breadcrumb component website documentation to include small breadcrumb.


Usage tab

Formatting

Sizing

  • Add this section heading.
  • Add both the Medium and Small sizes of breadcrumb, with medium being the default size.
  • Add written guidance and imagery to show when to use one size versus the other. Which size should be the default size and why.

Content

Main elements

Truncation

  • Add this section heading.
  • Write guidance to cover the following points:
    • For most use cases at larger breakpoints, keep the first home breadcrumb link for as long as possible in breakpoints, even when an overflow might be present.
    • For mobile or small viewpoints, start with the overflow first, following by one breadcrumb.

Overflow content

  • Ensure that the image is showing the correct design spec for the overflow dots color and spacing. Right now it is different between React, Figma, and the website. The dots should be close together and be the $link-primary color.
  • Link out to the overflow menu pattern with a brief description of that we recommend showing an overflow either at the beginning middle or end depending on what makes more sens for the use case.

Style tab

Size

  • Add this section heading.
  • Add both the Medium and Small sizes of breadcrumb.
  • Add table and image

Structure

  • Ensure that the image is showing the correct design spec for the overflow dots color and spacing. Right now it is different between React, Figma, and the website. The dots should be close together and be the $link-primary color.
  • Add an image and update the table with spacing for the Small breadcrumb size because it will be different.
Copy link
Contributor

Thank you for submitting a feature request. Your proposal is open and will soon be triaged by the Carbon team.

If your proposal is accepted and the Carbon team has bandwidth they will take on the issue, or else request you or other volunteers from the community to work on this issue.

@laurenmrice laurenmrice transferred this issue from carbon-design-system/carbon Jan 15, 2025
@laurenmrice laurenmrice moved this to 🪆 Needs Refined in Design System Jan 15, 2025
@laurenmrice laurenmrice added this to the 2025 Q1 milestone Jan 15, 2025
@sstrubberg sstrubberg modified the milestones: 2025 Q1, 2025 H1 Jan 22, 2025
@sstrubberg sstrubberg removed this from Roadmap Jan 22, 2025
@laurenmrice laurenmrice changed the title [Compact breadcrumb] Website docs [Small breadcrumb] Website docs Jan 24, 2025
@laurenmrice laurenmrice moved this from 🪆 Needs Refined to ⏱ Backlog in Design System Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: ⏱ Backlog
Development

No branches or pull requests

2 participants