8 definitions in this file:
The property name as used in code (e.g., 'variant', 'size', 'disabled', 'onClick').
A human-readable type description for display (e.g., "'primary' | 'secondary' | 'ghost'", 'boolean', 'IconComponent').
What this property controls, how it affects the component, and any constraints or side effects.
Whether the consumer must provide this property. Defaults to false.
Default: false
A JSON Schema (Draft 2020-12) object defining the property's type in machine-readable form. Follows the same conventions as OpenAPI parameter schemas.
The default value in its native JSON type. Accepts any JSON type: string, number, boolean, object, array, or null.
Example values for this property.
The version in which this property was introduced.
Whether this property is deprecated. Defaults to false.
Default: false
What to use instead, if deprecated.
References:
richText, example
The event name (e.g., 'onClick', 'onChange', 'onDismiss').
When this event fires, what it communicates, and how consumers should respond.
Description of the event payload shape (e.g., '(event: MouseEvent) => void', '{ value: string, index: number }').
The version in which this event was introduced.
References:
richText
The slot name. Use 'default' for the unnamed/default slot.
What content this slot accepts and any constraints on its children.
Allowed content (e.g., 'Plain text or a text node. Do not nest interactive elements.').
The version in which this slot was introduced.
References:
richText
The full property name including the -- prefix (e.g., '--button-background', '--button-border-radius').
Pattern: ^--
What visual attribute this property controls.
The default value (e.g., 'var(--color-action-primary)', '1rem', 'transparent').
The expected CSS value type (e.g., 'color', 'dimension', 'number').
The version in which this custom property was introduced.
References:
richText
The part name as used in ::part() selectors.
What element this part exposes and what styling it enables.
The version in which this part was introduced.
References:
richText
The full attribute name including the data- prefix (e.g., 'data-state', 'data-variant').
Pattern: ^data-
What this attribute reflects and how to use it for styling or testing.
The set of possible values (e.g., ['default', 'hover', 'active', 'disabled']).
The version in which this attribute was introduced.
References:
richText
The method name (e.g., 'focus', 'reset', 'scrollTo').
What this method does, when to call it, and any side effects.
The parameter signature (e.g., '(options?: { preventScroll: boolean }) => void').
The return value (e.g., 'void', 'Promise<void>', 'HTMLElement | null').
The version in which this method was introduced.
References:
richText
Identifies this guideline as an API spec.
The platform or framework this API describes (e.g., 'react', 'web-component', 'vue', 'angular', 'ios', 'android'). When omitted, the API is assumed to be the single/default platform.
Configurable properties (props, attributes, inputs) that consumers pass to the component.
Events emitted by the component that consumers can listen to.
Content insertion points where consumers can project child content.
CSS custom properties exposed for external styling.
CSS shadow parts exposed for external styling via ::part() selectors.
Data attributes that reflect component state or config into the DOM.
Public methods on the component instance.
Agent-optimized context for this document block. Provides structured information for AI/LLM consumption — constraints, disambiguation, anti-patterns, examples, and keywords.
References:
apiProperty, apiEvent, apiSlot, apiCssCustomProperty, apiCssPart, apiDataAttribute, apiMethod, agents
Design System Documentation Standard (DSDS) 0.1 — Draft Specification
GitHub