File: radiobutton.md

package info (click to toggle)
textual 2.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 55,056 kB
  • sloc: python: 85,423; lisp: 1,669; makefile: 101
file content (70 lines) | stat: -rw-r--r-- 1,433 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# RadioButton

!!! tip "Added in version 0.13.0"

A simple radio button which stores a boolean value.

- [x] Focusable
- [ ] Container

A radio button is best used with others inside a [`RadioSet`](./radioset.md).

## Example

The example below shows radio buttons, used within a [`RadioSet`](./radioset.md).

=== "Output"

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

=== "radio_button.py"

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

=== "radio_button.tcss"

    ```css
    --8<-- "docs/examples/widgets/radio_button.tcss"
    ```

## Reactive Attributes

| Name    | Type   | Default | Description                    |
| ------- | ------ | ------- | ------------------------------ |
| `value` | `bool` | `False` | The value of the radio button. |

## Messages

- [RadioButton.Changed][textual.widgets.RadioButton.Changed]

## Bindings

The radio button widget defines the following bindings:

::: textual.widgets._toggle_button.ToggleButton.BINDINGS
    options:
      show_root_heading: false
      show_root_toc_entry: false

## Component Classes

The checkbox widget inherits the following component classes:

::: textual.widgets._toggle_button.ToggleButton.COMPONENT_CLASSES
    options:
      show_root_heading: false
      show_root_toc_entry: false

## See Also

- [RadioSet](./radioset.md)

---


::: textual.widgets.RadioButton
    options:
      heading_level: 2