4 definitions in this file:
Lifecycle status of the artifact on this platform. Uses the same vocabulary as the top-level status: 'draft', 'experimental', 'stable', 'deprecated'. Custom values are allowed.
The version in which this artifact became available on this platform.
Required when status is 'deprecated'. Says what to use instead on this platform.
Notes about the artifact's status on this platform (e.g., 'Available as a Web Component wrapper; native implementation planned for v4').
Conditional: When status is "deprecated", then deprecationNotice is required.
References:
statusValue
[
{
"status": "stable",
"since": "1.0.0"
},
{
"status": "experimental",
"since": "3.2.0",
"description": "Available as a Web Component wrapper. Native shadow DOM implementation planned for v4."
},
{
"status": "draft",
"description": "Compose implementation in progress. Expected in v4.0."
},
{
"status": "deprecated",
"since": "1.5.0",
"deprecationNotice": "The Vue wrapper is deprecated. Use the Web Component directly in Vue applications."
}
]
Overall lifecycle status of the artifact. An editorial judgment of maturity; it need not match the most or least advanced platform status. Tools SHOULD display this as the primary status indicator.
Per-platform readiness. Keys are platform identifiers (freeform strings; common values include 'react', 'web-component', 'ios', 'android', 'flutter', 'figma', 'sketch', 'compose'). Values describe the artifact's status on that platform. An artifact MAY be 'stable' overall while individual platforms are still 'experimental' or 'draft'.
Required when status is 'deprecated'. MUST say what to use instead and give a migration path. Tools SHOULD display this prominently next to the status indicator.
Conditional: When overall is "deprecated", then deprecationNotice is required.
References:
statusValue, platformStatus
[
{
"overall": "stable",
"platforms": {
"react": {
"status": "stable",
"since": "1.0.0"
},
"web-component": {
"status": "experimental",
"since": "3.2.0",
"description": "Available as a Web Component wrapper. Native shadow DOM implementation planned for v4."
},
"ios": {
"status": "stable",
"since": "2.1.0"
},
"android": {
"status": "draft",
"description": "Compose implementation in progress. Expected in v4.0."
},
"figma": {
"status": "stable",
"since": "1.0.0"
},
"vue": {
"status": "deprecated",
"since": "1.5.0",
"deprecationNotice": "The Vue wrapper is deprecated. Use the Web Component directly in Vue applications."
}
}
},
{
"overall": "deprecated",
"platforms": {
"react": {
"status": "deprecated",
"since": "3.0.0",
"deprecationNotice": "Use NewComponent from @acme/components instead."
},
"figma": {
"status": "deprecated",
"since": "3.0.0",
"deprecationNotice": "Removed from the Figma library. Use the NewComponent frame."
}
},
"deprecationNotice": "This component is deprecated. Use NewComponent instead. See the migration guide at https://design.acme.com/migrations/old-to-new."
},
{
"overall": "experimental",
"platforms": {
"react": {
"status": "experimental",
"since": "4.0.0-beta.1"
},
"figma": {
"status": "draft",
"description": "Figma component is in design review. Not yet available in the library."
},
"a11y-keyboard": {
"status": "stable",
"description": "Passes all automated keyboard navigation tests."
},
"a11y-screen-reader": {
"status": "stable",
"description": "Manually tested with JAWS, VoiceOver, and NVDA."
}
}
}
]
Accepts one of:
References:
statusValue, statusObject
[
{
"overall": "stable",
"platforms": {
"react": {
"status": "stable",
"since": "1.0.0"
},
"ios": {
"status": "experimental",
"since": "3.0.0"
}
}
}
]
Design System Documentation Spec (DSDS) 0.2.1 — Draft Specification
GitHub