DSDS Events Document Block

2 definitions in this file:

eventEntry
events

The event name as used in code (e.g., 'onClick', 'onChange', 'onDismiss', 'ds-select'). For custom events, use the full event name including any namespace prefix.

When this event fires, what it communicates, and how consumers should respond. Include conditions under which the event does NOT fire (e.g., 'Does not fire when disabled').

Human-readable description of the event payload shape (e.g., '(event: MouseEvent) => void', '{ value: string, index: number }', 'CustomEvent<{ selectedId: string }>').

Machine-readable JSON Schema (Draft 2020-12) describing the event payload or detail object. Enables tooling to generate type definitions and validate event handlers.

Whether the event bubbles up through the DOM tree. Defaults to true. Set to false for events that only fire on the target element.
Default: true

Whether the event can be cancelled via preventDefault(). Defaults to false. When true, document what cancelling the event prevents.
Default: false

Whether the event crosses shadow DOM boundaries. Defaults to false. Relevant for web components using shadow DOM encapsulation.
Default: false

The version in which this event was introduced.

Whether this event is deprecated. Defaults to false.
Default: false

What to use instead when this event is deprecated. Required context when deprecated is true.

Usage examples showing how to listen for and handle this event.

References: richText, example

Identifies this document block as an events spec.

The events emitted by this component. Each item documents a single event with its name, description, payload, DOM behavior, and lifecycle metadata.
Min items: 1

Agent-optimized context for this document block. Provides structured information for AI/LLM consumption — constraints, disambiguation, anti-patterns, examples, and keywords.

References: eventEntry, agents