mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
Add width reference documentation for radio buttons
A large part of the code to go with this is to show off a radio set; I feel it makes sense to use the same code for both bits of documentation given that a radio button only really makes sense inside a radio set.
This commit is contained in:
12
docs/examples/widgets/radio_set.css
Normal file
12
docs/examples/widgets/radio_set.css
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
Screen {
|
||||||
|
align: center middle;
|
||||||
|
}
|
||||||
|
|
||||||
|
Horizontal {
|
||||||
|
align: center middle;
|
||||||
|
height: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
RadioSet {
|
||||||
|
width: 45%;
|
||||||
|
}
|
||||||
43
docs/examples/widgets/radio_set.py
Normal file
43
docs/examples/widgets/radio_set.py
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
from textual.app import App, ComposeResult
|
||||||
|
from textual.containers import Horizontal
|
||||||
|
from textual.widgets import RadioButton, RadioSet
|
||||||
|
|
||||||
|
|
||||||
|
class RadioChoicesApp(App[None]):
|
||||||
|
CSS_PATH = "radio_set.css"
|
||||||
|
|
||||||
|
def compose(self) -> ComposeResult:
|
||||||
|
yield Horizontal(
|
||||||
|
RadioSet(
|
||||||
|
RadioButton("Battlestar Galactica"),
|
||||||
|
RadioButton("Dune 1984"),
|
||||||
|
RadioButton("Dune 2021"),
|
||||||
|
RadioButton("Serenity", value=True),
|
||||||
|
RadioButton("Star Trek: The Motion Picture"),
|
||||||
|
RadioButton("Star Wars: A New Hope"),
|
||||||
|
RadioButton("The Last Starfighter"),
|
||||||
|
RadioButton(
|
||||||
|
"Total Recall :backhand_index_pointing_right: :red_circle:",
|
||||||
|
id="focus_me",
|
||||||
|
),
|
||||||
|
RadioButton("Wing Commander"),
|
||||||
|
),
|
||||||
|
RadioSet(
|
||||||
|
"Amanda",
|
||||||
|
"Connor MacLeod",
|
||||||
|
"Duncan MacLeod",
|
||||||
|
"Heather MacLeod",
|
||||||
|
"Joe Dawson",
|
||||||
|
"Kurgan, [bold italic red]The[/]",
|
||||||
|
"Methos",
|
||||||
|
"Rachel Ellenstein",
|
||||||
|
"Ramírez",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
def on_mount(self) -> None:
|
||||||
|
self.query_one("#focus_me", RadioButton).focus()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
RadioChoicesApp().run()
|
||||||
59
docs/widgets/radiobutton.md
Normal file
59
docs/widgets/radiobutton.md
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
# RadioButton
|
||||||
|
|
||||||
|
A simple radio button which stores a boolean value.
|
||||||
|
|
||||||
|
- [x] Focusable
|
||||||
|
- [ ] Container
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
The example below shows radio buttons, used within [RadioSet][textual.widgets.RadioSet]s.
|
||||||
|
|
||||||
|
=== "Output"
|
||||||
|
|
||||||
|
```{.textual path="docs/examples/widgets/radio_set.py"}
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "radio_set.py"
|
||||||
|
|
||||||
|
```python
|
||||||
|
--8<-- "docs/examples/widgets/radio_set.py"
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "radio_set.css"
|
||||||
|
|
||||||
|
```sass
|
||||||
|
--8<-- "docs/examples/widgets/radio_set.css"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Reactive Attributes
|
||||||
|
|
||||||
|
| Name | Type | Default | Description |
|
||||||
|
|---------|--------|---------|--------------------------------|
|
||||||
|
| `value` | `bool` | `False` | The value of the radio button. |
|
||||||
|
|
||||||
|
## Bindings
|
||||||
|
|
||||||
|
The radio button 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 radio button 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.RadioButton.Changed
|
||||||
|
|
||||||
|
## See Also
|
||||||
|
|
||||||
|
- [RadioButton](../api/radiobutton.md) code reference
|
||||||
@@ -134,6 +134,7 @@ nav:
|
|||||||
- "widgets/markdown_viewer.md"
|
- "widgets/markdown_viewer.md"
|
||||||
- "widgets/markdown.md"
|
- "widgets/markdown.md"
|
||||||
- "widgets/placeholder.md"
|
- "widgets/placeholder.md"
|
||||||
|
- "widgets/radiobutton.md"
|
||||||
- "widgets/static.md"
|
- "widgets/static.md"
|
||||||
- "widgets/switch.md"
|
- "widgets/switch.md"
|
||||||
- "widgets/text_log.md"
|
- "widgets/text_log.md"
|
||||||
|
|||||||
Reference in New Issue
Block a user