Logo FS-Skia-UI

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

categories ()

Full Usage: categories ()

Parameters:
    () : unit

Returns: string list

The distinct `Category` values across the catalog, to group controls when presenting a discovery index.

() : unit
Returns: string list

knownControlKinds ()

Full Usage: knownControlKinds ()

Parameters:
    () : unit

Returns: StandardControlKind list

Every `StandardControlKind` the catalog knows about — the entry point for enumerating which controls can be authored and queried.

() : unit
Returns: StandardControlKind list

markdownSummary ()

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.

() : unit
Returns: string

requiredAttributes kind

Full Usage: requiredAttributes kind

Parameters:
Returns: StandardAttributeName list

The `StandardAttributeName`s a control of `kind` must carry to be valid — the mandatory subset of its authoring contract.

kind : StandardControlKind
Returns: StandardAttributeName list

standardSchema

Full Usage: standardSchema

Returns: ControlSchema list

The machine-readable `ControlSchema` per standard control, pairing each kind with its accepted attributes and events for validation.

Returns: ControlSchema list

supportedAttributes kind

Full Usage: supportedAttributes kind

Parameters:
Returns: StandardAttributeName list

Every `StandardAttributeName` a control of `kind` accepts (required plus optional), to discover the full attribute surface for that control.

kind : StandardControlKind
Returns: StandardAttributeName list

supportedControls

Full Usage: supportedControls

Returns: ControlDefinition list

The full list of `ControlDefinition` entries — one per supported control — to enumerate the whole authoring catalog.

Returns: ControlDefinition list

supportedCount ()

Full Usage: supportedCount ()

Parameters:
    () : unit

Returns: int

The number of entries in `supportedControls` — how many distinct controls the catalog documents.

() : unit
Returns: int

supportedEvents kind

Full Usage: supportedEvents kind

Parameters:
Returns: StandardEventKind list

The `StandardEventKind`s a control of `kind` can raise — the bindable events a consumer may wire handlers to.

kind : StandardControlKind
Returns: StandardEventKind list

validate ()

Full Usage: validate ()

Parameters:
    () : unit

Returns: ControlDiagnostic list

Self-checks the catalog itself, returning any `ControlDiagnostic` for internal inconsistencies between definitions and the schema.

() : unit
Returns: ControlDiagnostic list

validateStandardControl control

Full Usage: validateStandardControl control

Parameters:
Returns: ControlDiagnostic list
Type parameters: 'msg

Checks an authored `control` against the catalog schema, returning a `ControlDiagnostic` for each missing required or unsupported attribute.

control : Control<'msg>
Returns: ControlDiagnostic list

Type something to start searching.