weasel API - v0.8.0
    Preparing search index...

    Interface ToolPrefCustom

    Open leaf: any node with a kind outside the built-ins. Schema-driven UIs (weasel-ui PrefsForm / SelectionPanel) dispatch it to an app-supplied renderer. Deliberately NOT index-signatured so concrete app interfaces stay assignable. Mirrors weasel-ui's PrefCustom.

    interface ToolPrefCustom {
        block?: boolean;
        default: unknown;
        description: string;
        hidden?: boolean;
        kind: string;
        name: string;
        pair?: string;
    }

    Hierarchy

    • ToolPrefBase<string, unknown>
      • ToolPrefCustom
    Index

    Properties

    block? default description hidden? kind name pair?

    Properties

    block?: boolean

    Render full-width with no label row in schema-driven settings UIs (weasel-ui PrefsForm honors this for leaves whose control brings its own chrome).

    default: unknown

    Fallback when nothing is persisted.

    description: string

    Longer help text — shown in tooltips / a settings pane.

    hidden?: boolean

    Hide from a host app's settings UI by default.

    kind: string
    name: string

    Human-readable label.

    pair?: string

    Row-pairing hint for compact property UIs (weasel-ui SelectionPanel): leaves sharing a pair id render side-by-side on one row labeled with the pair string (e.g. 'Position' for pose.x / pose.y). Purely presentational.

    Settings

    Member Visibility

    On This Page

    Properties