mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
2244b1161e
* 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
67 lines
1.2 KiB
Markdown
67 lines
1.2 KiB
Markdown
# Switch
|
|
|
|
A simple switch widget which stores a boolean value.
|
|
|
|
- [x] 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 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
|
|
|
|
- [Switch.Changed][textual.widgets.Switch.Changed]
|
|
|
|
## Additional Notes
|
|
|
|
- To remove the spacing around a `Switch`, set `border: none;` and `padding: 0;`.
|
|
|
|
---
|
|
|
|
|
|
::: textual.widgets.Switch
|
|
options:
|
|
heading_level: 2
|