mirror of https://github.com/Textualize/textual.git synced 2025-10-17 02:38:12 +03:00

Files

Will McGugan 2244b1161e api docs (#2240 )

* api docs

* more docstrings

* logs

* docs shakeup

* fix notes, added intro to all apis

* Remove defaults to

* add note to events

* note

* use fira code

2023-04-08 15:35:49 +01:00

1.2 KiB

Raw Blame History

Checkbox

!!! tip "Added in version 0.13.0"

A simple checkbox widget which stores a boolean value.

Focusable
Container

Example

The example below shows check boxes in various states.

=== "Output"

```{.textual path="docs/examples/widgets/checkbox.py"}
```

=== "checkbox.py"

```python
--8<-- "docs/examples/widgets/checkbox.py"
```

=== "checkbox.css"

```sass
--8<-- "docs/examples/widgets/checkbox.css"
```

Reactive Attributes

Name	Type	Default	Description
`value`	`bool`	`False`	The value of the checkbox.

Bindings

The checkbox widget defines the following bindings:

::: textual.widgets._toggle_button.ToggleButton.BINDINGS options: show_root_heading: false show_root_toc_entry: false

Component Classes

The checkbox widget provides the following component classes:

::: textual.widgets._toggle_button.ToggleButton.COMPONENT_CLASSES options: show_root_heading: false show_root_toc_entry: false

Messages

[Checkbox.Changed][textual.widgets.Checkbox.Changed]

::: textual.widgets.Checkbox options: heading_level: 2

1.2 KiB Raw Blame History