DSDS Extends Definitions

2 definitions in this file:

documentExtends
entityExtends

The name or identifier of the base design system being extended (e.g., 'Acme Core Design System', 'acme-core', '@acme/design-system'). A display name or a package name, not a URL. Tools use it to resolve the base system from a registry, file system, or package manager.

URL to the base DSDS document (e.g., 'https://design.acme.com/v2/core.dsds.json', './core.dsds.json'). When provided, tools MAY fetch and resolve the base document for merge, validation, or docs generation.

The version of the base system this document extends (e.g., '2.0.0', '>=2.0.0', '^3.1.0'). Follows semver. When omitted, tools SHOULD resolve to the latest available version.

Description of the relationship: what this extension adds, changes, or narrows relative to the base system.

References:

richText

{ "system": "acme-core", "url": "https://design.acme.com/v2/core.dsds.json", "version": "^2.0.0", "description": "Extends the Acme Core Design System with product-specific components, themes, and patterns used by the Acme Cloud Console." }

The identifier of the base entity being extended (e.g., 'button', 'color-text-primary', 'form-validation'). MUST match the identifier property of the base entity in the parent system.

The name or identifier of the system that owns the base entity (e.g., 'Acme Core Design System', 'acme-core'). When omitted, the base entity is resolved from the system declared in the root document's extends property. When provided, lets you extend from a system other than the document's default base.

Direct URL to the base entity's docs or DSDS definition. Useful for cross-linking in docs sites.

The version of the base entity or base system this entity extends (e.g., '2.0.0'). When omitted, the version comes from the document-level extends declaration.

What this entity adds or changes relative to the base: new variants, more props, overridden guidelines, and so on.

Summary of what this entity changes relative to the base. Each entry describes one change. Tools MAY use these for changelog generation, diff views, or migration guides. When omitted, consuming tools must diff the entities to find changes.

References:

richText

{ "identifier": "button", "system": "acme-core", "url": "https://design.acme.com/v2/components/button", "version": "2.0.0", "description": { "value": "Adds the **enterprise** variant for Acme Cloud Console workflows and tightens the minimum touch target for compliance with our internal accessibility audit.", "format": "markdown" }, "modifications": [ { "type": "added", "target": "variant:enterprise", "description": "New `enterprise` variant with a heavier visual weight, used inside the Cloud Console primary surface." }, { "type": "modified", "target": "prop:size", "description": "Default size is `medium` (was `small` in the base entity). The `small` size remains available." }, { "type": "modified", "target": "guideline:accessibility", "description": "Minimum touch target raised to 44px in all viewports (base requires 44px on mobile only)." }, { "type": "removed", "target": "variant:ghost", "description": "The `ghost` variant from the base entity is not exposed in this system. Use `tertiary` instead." }, { "type": "inherited", "target": "anatomy", "description": "Anatomy is inherited unchanged from the base Button." } ] }