Module
Components
Component definitions and instances, anatomy, variants, behavior and existing design-system mappings.
Raw schema: /schema/1.0/modules/components.schema.json
mapping
type: object
| Property | Type | Required | Constraints |
|---|---|---|---|
component | string | no | minLength 1 |
package | string | no | minLength 1 |
version | string | no | minLength 1 |
variant | string | no | minLength 1 |
primitive | string | no | minLength 1 |
pattern | string | no | minLength 1 |
props | object | no | — |
behavior
type: object
| Property | Type | Required | Constraints |
|---|---|---|---|
overlay | boolean | no | — |
modal | boolean | no | — |
modality | "modal" | "non-modal" | no | — |
placement | string | no | minLength 1 |
dismiss | array<"escape" | "backdrop" | "swipe" | "outside-press" | "close-button"> | object | no | — |
focus | focus | no | — |
anchor | object | no | — |
selection | "none" | "single" | "multiple" | no | — |
orientation | "horizontal" | "vertical" | no | — |
activation | "automatic" | "manual" | no | — |
scrollLock | boolean | no | — |
loop | boolean | no | — |
slot
type: object
| Property | Type | Required | Constraints |
|---|---|---|---|
description | string | no | minLength 1 |
semanticRole | taxonomy | no | — |
required | boolean | no | — |
multiple | boolean | no | — |
allowedKinds | array<taxonomy> | no | — |
componentRef | id | no | — |
states | array<string> | no | minLength 1 |
accessibility | accessibility | no | — |
composition
type: object · required: slot
component
type: object · required: id
| Property | Type | Required | Constraints |
|---|---|---|---|
id | id | yes | — |
kind | taxonomy | no | — |
componentRef | id | no | — |
name | string | no | minLength 1 |
description | string | no | minLength 1 |
family | string | no | minLength 1 |
variant | string | no | minLength 1 |
variants | object | no | — |
anatomy | object | no | — |
properties | object | no | — |
children | array<composition> | no | — |
states | array<string> | no | minLength 1 |
behavior | behavior | no | — |
layout | layout | no | — |
appearance | appearance | no | — |
accessibility | accessibility | no | — |
responsive | responsive | no | — |
motion | object | no | — |
eventRefs | array<id> | no | — |
stateRefs | array<id> | no | — |
actionRefs | array<id> | no | — |
references | array<id> | no | — |
implementationMapping | mapping | no | — |
platformMappings | object | no | — |
extensions | extensions | no | — |