textual/docs/widgets/_template.md

Widget

!!! tip "Added in version x.y.z"

Widget description.

• Focusable
• Container

Example

Example app showing the widget:

=== "Output"

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

=== "checkbox.py"

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

=== "checkbox.tcss"

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

Reactive Attributes

Messages

Bindings

The WIDGET widget defines the following bindings:

::: textual.widgets.WIDGET.BINDINGS options: show_root_heading: false show_root_toc_entry: false

Component classes

The WIDGET widget provides the following component classes:

::: textual.widget.WIDGET.COMPONENT_CLASSES options: show_root_heading: false show_root_toc_entry: false

Additional notes

• Did you know this?
• Another pro tip.

See also

• Another related API.
• Something else useful.

---

::: textual.widgets.WIDGET options: heading_level: 2