V5 DocsAthenaClient.rmlui.menu.menuInterfaces.Toggle ​
client/rmlui/menu/menuInterfaces.Toggle
Hierarchy ​
MenuOptionBase<(value:boolean) =>void>↳
Toggle
Properties ​
callback ​
• callback: Function | (...args: any[]) => void | (value: boolean) => void
A callback when this menu option is changed.
Inherited from ​
Defined in ​
client/rmlui/menu/menuInterfaces.ts:26
description ​
• description: string
A description of this menu option.
Inherited from ​
Defined in ​
client/rmlui/menu/menuInterfaces.ts:18
onlyUpdateOnEnter ​
• Optional onlyUpdateOnEnter: boolean
Only for Range & Selection Types
Inherited from ​
MenuOptionBase.onlyUpdateOnEnter
Defined in ​
client/rmlui/menu/menuInterfaces.ts:34
title ​
• title: string
The title of this menu option.
Inherited from ​
Defined in ​
client/rmlui/menu/menuInterfaces.ts:10
type ​
• type: "Toggle"
Defined in ​
client/rmlui/menu/menuInterfaces.ts:66
value ​
• value: boolean
The default value for this menu.