Interface SettingsUiItem<K>

interface SettingsUiItem<K = AnySettingKey> {
    clamp?: boolean;
    key: K;
    label: string;
    options: SettingUiItemOption[];
    requiresReload?: boolean;
    touchscreenOnly?: boolean;
}

Type Parameters

K = AnySettingKey

Index

Properties

clamp? key label options requiresReload? touchscreenOnly?

Properties

`Optional`clamp

clamp?: boolean

Specifies the behavior when navigating left/right at the boundaries of the option:

true: the cursor will stay on the boundary instead of moving
false: the cursor will wrap to the other end of the options list

Default Value

false

key

key: K

label

label: string

options

options: SettingUiItemOption[]

`Optional`requiresReload

requiresReload?: boolean

Indicates if a settings change requires a reload

`Optional`touchscreenOnly

touchscreenOnly?: boolean

Whether the setting is only available on devices supporting touchscreen.