Interface VisibleDisplayOptions

interface VisibleDisplayOptions {
    description?: string;
    disabled?: string | boolean | ((config: UserConfiguration) => string | boolean);
    extraOptions?: Record<string, any>;
    hidden?: false | ((config: UserConfiguration) => string | boolean);
    name?: string;
    readOnly?: boolean;
    type:
        | "number"
        | "page"
        | "text"
        | "checkbox"
        | "select"
        | "radio"
        | "checkboxes"
        | "code"
        | "button"
        | "unimplemented";
}

Hierarchy (view full)

Properties

description? disabled? extraOptions? hidden? name? readOnly? type

Properties

Optionaldescription

description?: string

Overridden description. DO NOT USE unless there is good reason to.

By default, the description will be taken from internationalization strings. Its key follows the format "deputy.setting.user...description".

Optionaldisabled

disabled?: string | boolean | ((config: UserConfiguration) => string | boolean)

Whether an option should be disabled or not.

OptionalextraOptions

extraOptions?: Record<string, any>

Extra options to pass to the UI element.

Optionalhidden

hidden?: false | ((config: UserConfiguration) => string | boolean)

Whether an option should be hidden or not. If an option is hidden, it will not show up in the settings interface at all.

Optionalname

name?: string

Overridden name. DO NOT USE unless there is good reason to.

By default, the name will be taken from internationalization strings. Its key follows the format "deputy.setting.user...name".

OptionalreadOnly

readOnly?: boolean

Whether the value is read-only or not.

type

type:
    | "number"
    | "page"
    | "text"
    | "checkbox"
    | "select"
    | "radio"
    | "checkboxes"
    | "code"
    | "button"
    | "unimplemented"

The type of UI element to display.

Settings

Member Visibility

On This Page

Properties