lvgl.toggle¶

lvgl.toggle([parent, ]params)

Add a toggle switch using the EdgeTX style.

Parameters¶

Name Req Type Description

parent no object optional LVGL object to attach the new object to; if omitted the object is created in the top-level script window

params yes table

Field	Type	Description
`x`	`number`	position relative to the top-left of the parent
`y`	`number`	position relative to the top-left of the parent
`w`	`number`	width
`h`	`number`	height
`color`	`color or function`	primary color for the object
`pos`	`function`	dynamic position callback returning `x, y`
`size`	`function`	dynamic size callback returning `w, h`
`visible`	`function`	dynamic visibility callback
`floating`	`boolean`	keep the object fixed inside a scrollable container, added in 2.11.6, defaults to false
`get`	`function`	called to get the current state; must return a boolean or number (0/false = off, 1/true = on), defaults to nil
`set`	`function`	called when the user interacts with the switch; passed a single number, 0 = off, 1 = on, defaults to nil
`active`	`function`	sets the enabled/disabled state; must return a boolean, true to enable, defaults to nil

Name	Type	Description
`-`	`table`	LVGL object, or nil if not running as a One-Time script or fullscreen widget

Only available for One-Time scripts and widgets running in full screen mode -- returns nil otherwise.

radio/src/lua/api_colorlcd_lvgl.cpp