textual/docs/widgets/checkbox.md
Will McGugan b0f5c35782
tabs widget (#2020)
* tabs widget

* click underline

* color tweak

* docs

* docs update

* expose Tab

* added remove_tab and clear

* fix cycling

* add animation

* docs

* changelog

* remove recompose

* docstrings

* Update docs/guide/actions.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Rodrigoed the tabs

* Update docs/widgets/tabs.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Update docs/widgets/tabs.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* copy

* docstrings

* docstring

* docstring

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* stop click

* docstring

* auto assign consistent IDs

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Document bindings

* document bindings

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

---------

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-03-13 14:39:15 +00:00

1.2 KiB

Checkbox

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 directly 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

::: textual.widgets.Checkbox.Changed

See Also