Docs: Updated Status docs to include design guidelines #1940
Conversation
|
✔️ Deploy Preview for gestalt ready! 🔨 Explore the source changes: f154783 🔍 Inspect the deploy log: https://app.netlify.com/sites/gestalt/deploys/620d7e183db60e0009f4d736 😎 Browse the preview: https://deploy-preview-1940--gestalt.netlify.app |
docs/pages/status.js
Outdated
| <MainSection.Card | ||
| cardSize="md" | ||
| type="do" | ||
| description="Place Status close to the status subject in question to provide context and reference. It can be placed as an inline element or paired side by side as needed. " |
There was a problem hiding this comment.
kinda wordy…instead of "to the status subject in question", how about "to its subject"?
docs/pages/status.js
Outdated
| <MainSection.Card | ||
| cardSize="md" | ||
| type="do" | ||
| description="Use a title when the status it represents is unique, specific and critical for the user to know." |
There was a problem hiding this comment.
props should be denoted with backticks and don't need an article, so
Use
titlewhen the status it represents…
There was a problem hiding this comment.
There was some initial feedback that utilizing prop names may not necessarily be as clear to designers, so we decided to pull is back to something less technical.
docs/pages/status.js
Outdated
| <MainSection.Card | ||
| cardSize="md" | ||
| type="don't" | ||
| description="Use Status' sub text to display extraneous messaging." |
There was a problem hiding this comment.
ditto here: subtext refers to the prop, so needs backticks and should match the prop name exactly
There was a problem hiding this comment.
Same comment for this one. I think there's solid arguments on both sides here and I don't know if I have an informed opinion of how much friction this would cause designers.
Summary
What changed?
Added Best Practices and Related section and updated Accessibility section of Status docs.