Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an example of using a RadioSet.Changed message #1935

Merged
merged 1 commit into from
Mar 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/examples/widgets/radio_set_changed.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Vertical {
align: center middle;
}

Horizontal {
align: center middle;
height: auto;
}

RadioSet {
width: 45%;
}
43 changes: 43 additions & 0 deletions docs/examples/widgets/radio_set_changed.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
from textual.app import App, ComposeResult
from textual.containers import Horizontal, Vertical
from textual.widgets import Label, RadioButton, RadioSet


class RadioSetChangedApp(App[None]):
CSS_PATH = "radio_set_changed.css"

def compose(self) -> ComposeResult:
with Vertical():
with Horizontal():
with RadioSet():
yield RadioButton("Battlestar Galactica")
yield RadioButton("Dune 1984")
yield RadioButton("Dune 2021")
yield RadioButton("Serenity", value=True)
yield RadioButton("Star Trek: The Motion Picture")
yield RadioButton("Star Wars: A New Hope")
yield RadioButton("The Last Starfighter")
yield RadioButton(
"Total Recall :backhand_index_pointing_right: :red_circle:",
id="focus_me",
)
yield RadioButton("Wing Commander")
with Horizontal():
yield Label(id="pressed")
with Horizontal():
yield Label(id="index")

def on_mount(self) -> None:
self.query_one("#focus_me", RadioButton).focus()

def on_radio_set_changed(self, event: RadioSet.Changed) -> None:
self.query_one("#pressed", Label).update(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I didn't know I could write queries like this! Cool 👍

f"Pressed button label: {event.pressed.label}"
)
self.query_one("#index", Label).update(
f"Pressed button index: {event.input.pressed_index}"
)


if __name__ == "__main__":
RadioSetChangedApp().run()
19 changes: 19 additions & 0 deletions docs/widgets/radioset.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,25 @@ The example below shows two radio sets, one built using a collection of

### ::: textual.widgets.RadioSet.Changed

Here is an example of using the message to react to changes in a `RadioSet`:

=== "Output"

```{.textual path="docs/examples/widgets/radio_set_changed.py" press="enter"}
```

=== "radio_set_changed.py"

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

=== "radio_set_changed.css"

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

## See Also

- [RadioSet](../api/radioset.md) code reference
Expand Down