Interface IBoolPropertyItemOptions

Optional properties for Bool property item

Hierarchy

Properties

enable? hiddenLabel? onChange? title? tooltip? variant? visible?

Properties

Optional enable

enable?: boolean

Remarks

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

Optional hiddenLabel

hiddenLabel?: boolean

Remarks

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

Optional onChange

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

Type declaration

    • (newValue, oldValue): void

    • Parameters

      • newValue: boolean
      • oldValue: boolean

      Returns void

      Remarks

      This callback is called when UI control value is changed.

Optional title

title?: LocalizedString

Remarks

Localized title of the text item.

Optional tooltip

tooltip?: LocalizedString

Remarks

Tooltip description of the property item

Optional variant

variant?: BoolPropertyItemVariant

Remarks

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

Optional visible

visible?: boolean

Remarks

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

Settings

Member Visibility

Theme

On This Page