Interface: ThemeSettingField

Defined in: packages/sdk/src/types/generated/site.ts:273

One configurable value a theme declares.

Properties

createDefaults?

optional createDefaults: ThemeSettingFieldCreateDefaults

Defined in: packages/sdk/src/types/generated/site.ts:291

For reference fields (e.g. data_type): a payload matching the entity's create API (DataTypeFormData), used by the field's Create button to scaffold a new entity pre-populated with the theme's defaults.

---

default?

optional default: unknown

Defined in: packages/sdk/src/types/generated/site.ts:285

Default value used when none is saved

---

description?

optional description: string | null

Defined in: packages/sdk/src/types/generated/site.ts:281

Help text shown under the field

---

group?

optional group: string | null

Defined in: packages/sdk/src/types/generated/site.ts:289

Optional section header to group fields under

---

key

key: string

Defined in: packages/sdk/src/types/generated/site.ts:275

Machine name; the key under Site.theme_settings

---

label

label: string

Defined in: packages/sdk/src/types/generated/site.ts:277

Display label shown in the Theme Settings form

---

options?

optional options: EnumOption[] | null

Defined in: packages/sdk/src/types/generated/site.ts:287

Choices for a 'select' field

---

required?

optional required: boolean

Defined in: packages/sdk/src/types/generated/site.ts:283

Whether a value must be set

---

type

type: ThemeSettingFieldType

Defined in: packages/sdk/src/types/generated/site.ts:279

Field/value type