Add the widget reference for Checkbox

This commit is contained in:
Dave Pearson
2023-02-23 14:26:11 +00:00
parent 66af586d0e
commit 3fd3d272ce
4 changed files with 97 additions and 0 deletions

View File

@@ -0,0 +1,11 @@
Screen {
align: center middle;
}
Vertical {
width: auto;
height: auto;
border: solid $boost;
background: $panel;
padding: 2;
}

View File

@@ -0,0 +1,26 @@
from textual.app import App, ComposeResult
from textual.containers import Vertical
from textual.widgets import Checkbox
class CheckboxApp(App[None]):
CSS_PATH = "checkbox.css"
def compose(self) -> ComposeResult:
yield Vertical(
Checkbox("Arrakis :sweat:"),
Checkbox("Caladan"),
Checkbox("Chusuk"),
Checkbox("[b]Giedi Prime[/b]"),
Checkbox("[magenta]Ginaz[/]"),
Checkbox("Grumman", True),
Checkbox("Kaitain", id="initial_focus"),
Checkbox("Novebruns", True),
)
def on_mount(self):
self.query_one("#initial_focus", Checkbox).focus()
if __name__ == "__main__":
CheckboxApp().run()

59
docs/widgets/checkbox.md Normal file
View File

@@ -0,0 +1,59 @@
# Checkbox
A simple checkbox width which stores a boolean value.
- [x] Focusable
- [ ] Container
## Example
The example below shows switches 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
- [Checkbox](../api/checkbox.md) code reference

View File

@@ -121,6 +121,7 @@ nav:
- "styles/width.md" - "styles/width.md"
- Widgets: - Widgets:
- "widgets/button.md" - "widgets/button.md"
- "widgets/checkbox.md"
- "widgets/data_table.md" - "widgets/data_table.md"
- "widgets/directory_tree.md" - "widgets/directory_tree.md"
- "widgets/footer.md" - "widgets/footer.md"