#Interface: IBoolPropertyItemOptions experimental

Beta

Optional properties for Bool property item

#Extends

• IPropertyItemOptionsBase

#Properties

#checkboxIcon?

optional checkboxIcon?: string

Beta

#Remarks

Changes checkbox variant to use a custom icon

---

#enable?

optional enable?: boolean

Beta

#Remarks

Initial enabled state of property item. If undefined, it will default to true.

#Inherited from

IPropertyItemOptionsBase.enable

---

#hiddenLabel?

optional hiddenLabel?: boolean

Beta

#Remarks

If true label text will be hidden. It will be visible by default.

---

#onChange?

optional onChange?: (newValue, oldValue) => void

Beta

#Parameters

#newValue

boolean

#oldValue

boolean

#Returns

void

#Remarks

This callback is called when UI control value is changed.

---

#style?

optional style?: PaneItemStyle

Beta

#Remarks

Optional styling overrides for the item.

#Inherited from

IPropertyItemOptionsBase.style

---

#title?

optional title?: LocalizedString

Beta

#Remarks

Localized title of the text item.

---

#tooltip?

optional tooltip?: BasicTooltipContent

Beta

#Remarks

Tooltip description of the property item

---

#variant?

optional variant?: BoolPropertyItemVariant

Beta

#Remarks

Determines how we display bool as a UI element. If undefined, it will default to Checkbox.

---

#visible?

optional visible?: boolean

Beta

#Remarks

Initial visibility state of property item. If undefined, it will default to true.

#Inherited from

IPropertyItemOptionsBase.visible