Catalog Module
Discovery surface for the standard control library: enumerate every control's authoring contract (required/supported attributes, events) and validate authored `Control` values against the published schema.
Functions and values
| Function or value |
Description
|
Full Usage:
categories ()
Parameters:
unit
Returns: string list
|
The distinct `Category` values across the catalog, to group controls when presenting a discovery index.
|
|
Every `StandardControlKind` the catalog knows about — the entry point for enumerating which controls can be authored and queried.
|
Full Usage:
markdownSummary ()
Parameters:
unit
Returns: string
|
Renders the whole catalog as a Markdown reference table — a ready-to-read summary of every control's authoring contract.
|
Full Usage:
requiredAttributes kind
Parameters:
StandardControlKind
Returns: StandardAttributeName list
|
The `StandardAttributeName`s a control of `kind` must carry to be valid — the mandatory subset of its authoring contract.
|
|
The machine-readable `ControlSchema` per standard control, pairing each kind with its accepted attributes and events for validation.
|
Full Usage:
supportedAttributes kind
Parameters:
StandardControlKind
Returns: StandardAttributeName list
|
Every `StandardAttributeName` a control of `kind` accepts (required plus optional), to discover the full attribute surface for that control.
|
|
The full list of `ControlDefinition` entries — one per supported control — to enumerate the whole authoring catalog.
|
Full Usage:
supportedCount ()
Parameters:
unit
Returns: int
|
The number of entries in `supportedControls` — how many distinct controls the catalog documents.
|
Full Usage:
supportedEvents kind
Parameters:
StandardControlKind
Returns: StandardEventKind list
|
The `StandardEventKind`s a control of `kind` can raise — the bindable events a consumer may wire handlers to.
|
|
Self-checks the catalog itself, returning any `ControlDiagnostic` for internal inconsistencies between definitions and the schema.
|
Full Usage:
validateStandardControl control
Parameters:
Control<'msg>
Returns: ControlDiagnostic list
Type parameters: 'msg |
Checks an authored `control` against the catalog schema, returning a `ControlDiagnostic` for each missing required or unsupported attribute.
|