textual/docs/widgets/switch.md
Dave Pearson 6738c5686c
Correct the wording of the description of Switch.value
It's not just the default value, it's the ongoing value too and can be used
to change the switch.
2023-02-23 14:28:25 +00:00

1.2 KiB

Switch

A simple switch widget which stores a boolean value.

  • Focusable
  • Container

Example

The example below shows switches in various states.

=== "Output"

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

=== "switch.py"

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

=== "switch.css"

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

Reactive Attributes

Name Type Default Description
value bool False The value of the switch.

Bindings

The switch widget defines directly the following bindings:

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

Component Classes

The switch widget provides the following component classes:

::: textual.widgets.Switch.COMPONENT_CLASSES options: show_root_heading: false show_root_toc_entry: false

Messages

::: textual.widgets.Switch.Changed

Additional Notes

  • To remove the spacing around a Switch, set border: none; and padding: 0;.

See Also