@dialstack/sdk-dev / js/src / DeviceSettingDefinition

Interface: DeviceSettingDefinition

Defined in: sdk/js/src/utils/device-settings-catalog.ts:16

What a UI needs to render one device setting. The API decides which settings a level may write (settable); this says how to show them. Labels are keys, so each surface supplies its own translations.

Properties

confirmOn?

TypeScript

confirmOn?: readonly string[];

Defined in: sdk/js/src/utils/device-settings-catalog.ts:25

Values that need the user to confirm before they are saved.

---

kind

TypeScript

kind: DeviceSettingKind;

Defined in: sdk/js/src/utils/device-settings-catalog.ts:19

---

labelKey

TypeScript

labelKey: string;

Defined in: sdk/js/src/utils/device-settings-catalog.ts:23

Translation key for the setting's label and help.

---

options?

TypeScript

options?: readonly string[];

Defined in: sdk/js/src/utils/device-settings-catalog.ts:21

The values an enum setting accepts, in display order.

---

path

TypeScript

path: string;

Defined in: sdk/js/src/utils/device-settings-catalog.ts:18

Dotted path into DeviceSettings, as the API's settable lists it.