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

[Status indicator] Update Status indicator pattern guidance #4309

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

thyhmdo
Copy link
Member

@thyhmdo thyhmdo commented Oct 3, 2024

Closes ##4272 and #4050


Figma file review: https://www.figma.com/design/EqKmxlJmBiEB4yPBKpGlrZ/Status-Indicator-(Pattern)?node-id=1-1365

New

  • Variant table
  • Icon vs Shape indicator

Changelog

  • Structure in general
  • Icon indicator table in its variant
  • Removed a few icon indicators in the table
  • Removed one shape indicator in the table
  • Other general guidance on labeling, type pairing, and accessibility

Copy link

vercel bot commented Oct 3, 2024

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 Jan 21, 2025 9:48pm

@alisonjoseph
Copy link
Member

The not started light image isn't displaying, I think the file might be missing.

Screenshot 2024-10-04 at 9 14 29 AM

Copy link
Member

@aagonzales aagonzales left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, awesome work Thy! I left a few formatting suggestions here in the PR and also some other general comments and questions over in Figma.

src/pages/patterns/status-indicator-pattern/index.mdx Outdated Show resolved Hide resolved
src/pages/patterns/status-indicator-pattern/index.mdx Outdated Show resolved Hide resolved
src/pages/patterns/status-indicator-pattern/index.mdx Outdated Show resolved Hide resolved
src/pages/patterns/status-indicator-pattern/index.mdx Outdated Show resolved Hide resolved
src/pages/patterns/status-indicator-pattern/index.mdx Outdated Show resolved Hide resolved
Copy link
Member

@alisonjoseph alisonjoseph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM other than one comment around using px instead of pt when referring to font sizes.

Copy link
Member

@aagonzales aagonzales left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some small things still


<StatusIndicatorTable attention="high" />
If your product needs an icon that’s not currently included, please reach out to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we say open an issue instead here and link them to the correct repo?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was going to say the same thing! Just so people know where to go if they need to contact us or to submit an icon

@thyhmdo
Copy link
Member Author

thyhmdo commented Oct 17, 2024

Alina's feedback:

An image will help improve this context

image


Taylor's feedback

  • Adding a fill behind some icons would work (like how other Warning and Failed states are being implemented right now)
.#{$prefix}--text-input__invalid-icon--warning {
    fill: $support-warning;
  }

Slight difference there is for the inputs we always set background-color: $field; whereas with standalone status icons we won't know/control what background they're placed on.
We could scope the selectors to set specific fill on each layer though, in addition to the $background

Copy link
Member

@laurenmrice laurenmrice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really great, @thyhmdo ! Just a couple of minor things. Great work! ⭐️

  • The square border around the icons/symbols should be Magenta 60 to match the line that connects to it.
Screenshot 2024-10-18 at 8 35 33 AM
  • This image under the Shape indicator section needs to be updated to show the correct colors for the indicators in the data table. Right now they all look orange.
    • Note: This has been corrected, the correct image asset is in here, its just not updating in the preview.
Screenshot 2024-10-18 at 8 55 44 AM
  • I noticed that in the Shape indicator table you use slashes to separate different tokens per shape, but in the Icon indicator table you use commas. I would just pick one approach for consistency, maybe just use the comma?

src/pages/patterns/status-indicator-pattern/index.mdx Outdated Show resolved Hide resolved
src/pages/patterns/status-indicator-pattern/index.mdx Outdated Show resolved Hide resolved
src/pages/patterns/status-indicator-pattern/index.mdx Outdated Show resolved Hide resolved

<StatusIndicatorTable attention="high" />
If your product needs an icon that’s not currently included, please reach out to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was going to say the same thing! Just so people know where to go if they need to contact us or to submit an icon

src/pages/patterns/status-indicator-pattern/index.mdx Outdated Show resolved Hide resolved
src/pages/patterns/status-indicator-pattern/index.mdx Outdated Show resolved Hide resolved
to the user. This dot badge is more subtle than the numbered badge but still
effectively draws the user’s attention to the icon button.

The badge without number is commonly seen in toolbars' icon buttons.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The badge without number is commonly seen in toolbars' icon buttons.
The badge without a number is commonly seen in toolbars' icon buttons.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thyhmdo this might just be something weird with the preview because I don't see it like this in the markdown but there's something weird happening with the text this section.
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thyhmdo I also still see what Anna is saying above.

src/pages/patterns/status-indicator-pattern/index.mdx Outdated Show resolved Hide resolved
src/pages/patterns/status-indicator-pattern/index.mdx Outdated Show resolved Hide resolved

#### Users should be able to manage or limit non-critical notifications.
<Caption>
Example shows the icon indicators do not need outlines while icon indicators
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Example shows the icon indicators do not need outlines while icon indicators
Example shows the icon indicators do not need outlines, while icon indicators

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thyhmdo I actually think this caption means to say the following:

"Example shows icon indicators do not need outlines, while shape indicators do due to the lack of symbols."

@thyhmdo thyhmdo self-assigned this Dec 4, 2024
@laurenmrice laurenmrice added this to the 2024 Q4 milestone Dec 4, 2024
@laurenmrice laurenmrice requested review from laurenmrice and removed request for jeanservaas January 10, 2025 19:14
red and green means that products cannot simply rely on color to show status. As
a result, the status system relies on three key elements; color, shape, and
symbol.
### Elements
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a result, status indicators should rely on at least two elements: color, shape, or symbol.

I think this means to say: "As a result, status indicators should rely on at least two of the following elements: color, shape, or symbol."

*Differential indicators must have either a ‘+’ or ‘-’ sign, a caret, or an
arrow icon to indicate positive or negative values.
</Caption>
<StatusIndicatorTable attention="high" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we are showing color tokens now instead of color values, I think we should make them inline code snippets like we do on the style tabs. This should also be done in the Shape indicator statuses table.

attention to the icon button.

### Shape indicators
### Shape indicator statuses
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use a comma in this table instead of a slash when separating multiple color tokens like you do in the Icon indicator statuses table for consistency.

@sstrubberg sstrubberg removed this from the 2024 Q4 milestone Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🚦 In Review
Development

Successfully merging this pull request may close these issues.

6 participants