schema-components - v3.7.0
    Preparing search index...

    Class ScBoolean

    Lit Custom Element rendering a boolean-valued schema field.

    Tag: <sc-boolean> (registered by registerSchemaComponents).

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    properties tree value readOnly writeOnly path meta constraints examples? change renderChild

    Methods - Other

    emitChange

    Methods - rendering

    render

    Constructors

    Properties

    properties: {
        tree: { attribute: boolean };
        value: { attribute: boolean };
        readOnly: { attribute: boolean };
        writeOnly: { attribute: boolean };
        path: { attribute: boolean };
        meta: { attribute: boolean };
        constraints: { attribute: boolean };
        examples: { attribute: boolean };
        change: { attribute: boolean };
        renderChild: { attribute: boolean };
    } = ...

    Property declarations shared by every built-in Custom Element.

    Subclasses spread this in:

    static override properties = {
      ...BaseScElement.properties,
      ...
    };

    Every shared property uses attribute: false — none of the payloads (tree, value, meta, constraints) round-trip safely through HTML attribute strings.

    tree: WalkedField
    value: unknown
    readOnly: boolean
    writeOnly: boolean
    path: string
    meta: SchemaMeta
    constraints: AllConstraints
    examples?: unknown[]
    change: (value: unknown) => void
    renderChild: (
        tree: WalkedField,
        value: unknown,
        change: (next: unknown) => void,
        pathSuffix?: string,
    ) => TemplateResult

    Methods - Other

    • Dispatch the canonical sc-change event. Renderers call this inside DOM event handlers (@input, @change, @click on add/remove controls) — the orchestrating ancestor catches the event, propagates the structural update to the root value, and re-emits a top-level change event on its own host.

      Parameters

      • value: unknown

      Returns void

    Methods - rendering

    • Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

      Returns TemplateResult

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods - Other
    Methods - rendering