Skip to content

[WIP] docs: standardize docs class table #2185

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.

Sign up for GitHub

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

Draft
dancormier wants to merge 12 commits into
base: beta
Choose a base branch
from
Draft

[WIP] docs: standardize docs class table #2185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ceb73fe
docs: standardize docs class table
dancormier Feb 9, 2026
f0b3fb7
Merge branch 'beta' into dcormier/2026-feb-docs-table
dancormier Feb 13, 2026
9591266
Unify component json/html file names (with exceptions); improve docs …
dancormier Feb 13, 2026
50e2348
More component page updates
dancormier Feb 13, 2026
94b6074
A couple more docs tweaks; logical naming
dancormier Feb 13, 2026
36511d5
make that table better
dancormier Feb 14, 2026
a2ecb3c
Update docs table keys
dancormier Feb 17, 2026
2b6a254
Update user card tables
dancormier Feb 17, 2026
a72a518
Update form element docs pages
dancormier Feb 17, 2026
d009d61
Convert modal docs to use docs tables
dancormier Feb 17, 2026
ba46146
Update banner docs
dancormier Feb 17, 2026
1d37802
Add toggle switch table
dancormier Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions packages/stacks-docs/_data/components/activity-indicator.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
{
"indicator": [
"classes": [
{
"class": ".s-activity-indicator",
"applies": "N/A",
"code": ".s-activity-indicator",
"description": "Base activity indicator element with theme-aware coloring"
},
{
"class": ".s-activity-indicator__success",
"code": ".s-activity-indicator__success",
"applies": ".s-activity-indicator",
"description": "Styles the activity indicator in a success state"
},
{
"class": ".s-activity-indicator__warning",
"code": ".s-activity-indicator__warning",
"applies": ".s-activity-indicator",
"description": "Styles the activity indicator in a warning state"
},
{
"class": ".s-activity-indicator__danger",
"code": ".s-activity-indicator__danger",
"applies": ".s-activity-indicator",
"description": "Styles the activity indicator in a danger state"
},
{
"class": ".s-activity-indicator__sm",
"code": ".s-activity-indicator__sm",
"applies": ".s-activity-indicator",
"description": "Styles the activity indicator in a small size"
}
]
],
"examples": ["", "3", "12", "370", "new"],
"variants": ["success", "warning", "danger"]
}
35 changes: 18 additions & 17 deletions ...s/_data/components/avatars-component.json → ...stacks-docs/_data/components/avatars.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,59 +1,60 @@
{
"classes": [
{
"class": ".s-avatar",
"applies": "N/A",
"code": ".s-avatar",
"description": "The base avatar at 16px."
},
{
"class": ".s-avatar--image",
"applies": "N/A",
"code": ".s-avatar--image",
"parent": ".s-avatar",
"description": "A child element for displaying a user’s profile image."
},
{
"class": ".s-avatar--letter",
"applies": "N/A",
"code": ".s-avatar--letter",
"parent": ".s-avatar",
"description": "A child element for displaying an abbreviated Team name."
},
{
"class": ".s-avatar--badge",
"applies": "N/A",
"code": ".s-avatar--badge",
"parent": ".s-avatar",
"description": "A child element that provides positioning to the shield on Team avatars."
},
{
"class": ".s-avatar--indicator",
"applies": "N/A",
"code": ".s-avatar--indicator",
"parent": ".s-avatar",
"description": "A child element that provides positioning to the activity indicator on user's avatars."
},
{
"class": ".s-avatar__24",
"code": ".s-avatar__24",
"applies": ".s-avatar",
"description": "Adds the proper border radius and scaling at 24px."
},
{
"class": ".s-avatar__32",
"code": ".s-avatar__32",
"applies": ".s-avatar",
"description": "Adds the proper border radius and scaling at 32px."
},
{
"class": ".s-avatar__48",
"code": ".s-avatar__48",
"applies": ".s-avatar",
"description": "Adds the proper border radius and scaling at 48px."
},
{
"class": ".s-avatar__64",
"code": ".s-avatar__64",
"applies": ".s-avatar",
"description": "Adds the proper border radius and scaling at 64px."
},
{
"class": ".s-avatar__96",
"code": ".s-avatar__96",
"applies": ".s-avatar",
"description": "Adds the proper border radius and scaling at 96px."
},
{
"class": ".s-avatar__128",
"code": ".s-avatar__128",
"applies": ".s-avatar",
"description": "Adds the proper border radius and scaling at 128px."
}
]
],
"examples": [16, 24, 32, 48, 64, 96, 128],
"teamBgs": ["blue-400", "theme-primary", "png"]
}
Loading