Skip to content

Component

The Component type is the root object of every spec. It contains the component’s structure, properties, default appearance, and variant overrides.

Properties

PropertyTypeRequiredDescription
titlestringYesComponent name
anatomyAnatomyYesMap of named elements that make up the component
propsPropsNoConfigurable input properties
defaultVariantYesDefault variant — the baseline appearance
variantsVariant[]NoLayered variant overrides
invalidVariantCombinationsPropConfigurations[]NoProp combinations that are not valid together
subcomponentsSubcomponentsNoEmbedded child component definitions
metadataMetadataNoGeneration metadata (author, schema version, config)
instanceExamplesInstanceExamplesNoPro. Documented whole-component usage examples (emitted only with a Pro license)
slotContentExamplesRecord<string, SlotContent>NoPro. Named slot-content fills, referenced by SlotContentRef from slot bindings and from Element.propConfigurations slot-prop entries

Examples and composed content

Several optional fields document configured and composed usages of a component. Each has its own page:

  • InstanceExamples — pre-configured whole-component usages.
  • SlotContent — the anatomy + elements + layout triplet used as a named slot fill, stored in slotContentExamples.
  • SlotContentRef — the $slotContent pointer that references a fill.
  • Composition — a named, authored unit of composed content (system-scoped, external composition files).
  • Children — an element’s children, including slot bindings that carry example fills.