Switch#

class marimo.ui.switch(value: bool = False, *, label: str = '', on_change: Callable[[bool], None] | None = None)#

A boolean switch.

Example.

switch = mo.ui.switch()

Attributes.

  • value: A boolean, True if checked.

Initialization Args.

  • value: default value, True or False

  • label: text label for the element

  • on_change: optional callback to run when this element’s value changes

Public methods

Inherited from UIElement

form([label])

Create a submittable form out of this UIElement.
Inherited from Html

batch(**elements)

Convert an HTML object with templated text into a UI element.

center()

Center an item.

right()

Right-justify.

left()

Left-justify.

callout([kind])

Create a callout containing this HTML element.

Public Data Attributes:

Inherited from UIElement

value

The element’s current value.
Inherited from Html

text

A string of HTML representing this element.