Checkbox

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

A boolean checkbox.

Example.

checkbox = mo.ui.checkbox()

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, bordered, loading, ...])

Create a submittable form out of this UIElement.

send_message(message, buffers)

Send a message to the element rendered on the frontend from the backend.

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.

style([style])

Wrap an object in a styled container.

Public Data Attributes:

Inherited from UIElement

value

The element’s current value.

Inherited from Html

text

A string of HTML representing this element.