3 definitions in this file:
References:
relationship
[
[
{
"relation": "composes",
"target": "button",
"role": "Renders the confirm and cancel actions",
"required": true
},
{
"relation": "depends-on",
"target": "color-critical",
"role": "Tones the destructive confirm action"
},
{
"relation": "alternative-to",
"target": "link"
}
]
]
The identifier of the entity this edge points at. MUST match a documented entity's identifier. A target that resolves to nothing is a defect in the document.
What the target does in this relationship (e.g., 'Provides semantic text color', 'Renders the confirm action'). When omitted, the edge is a general association of the given relation type.
Whether the target is required for the source entity to function. Meaningful for 'depends-on' and 'composes' edges; ignored for symmetric or advisory relations like 'alternative-to'. Defaults to false.
Default: false
An optional version range that the target must satisfy for this relationship to hold, expressed as a semver range (e.g., '>=2.0.0', '^3'). Use it when a dependency is tied to a specific version of the target. Tools treat it as advisory metadata, not a hard validation rule.
References:
relationType, entityIdentifier, entityRole
{
"relation": "depends-on",
"target": "color-action-primary",
"role": "Provides the resting background color",
"required": true,
"versionConstraint": ">=2.0.0"
}
Constraints: at least one of:
Design System Documentation Spec (DSDS) 0.14.0 — Draft Specification
GitHub