Interface HiddenDisplayOptions

interface HiddenDisplayOptions {
    description?: string;
    disabled?: string | boolean | ((config: UserConfiguration) => string | boolean);
    hidden?: true;
    name?: string;
    readOnly?: boolean;
    type?: never;
}

Hierarchy (view full)

Properties

description? disabled? 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.

Optionalhidden

hidden?: true

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.

Optionaltype

type?: never

Settings

Member Visibility

On This Page

Properties