File: content_switcher.md

package info (click to toggle)
textual 2.1.2-1.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 55,080 kB
  • sloc: python: 85,423; lisp: 1,669; makefile: 101
file content (71 lines) | stat: -rw-r--r-- 2,080 bytes parent folder | download | duplicates (2)
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
71
# ContentSwitcher

!!! tip "Added in version 0.14.0"

A widget for containing and switching display between multiple child
widgets.

- [ ] Focusable
- [X] Container

## Example

The example below uses a `ContentSwitcher` in combination with two `Button`s
to create a simple tabbed view. Note how each `Button` has an ID set, and
how each child of the `ContentSwitcher` has a corresponding ID; then a
`Button.Clicked` handler is used to set `ContentSwitcher.current` to switch
between the different views.

=== "Output"

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

=== "content_switcher.py"

    ~~~python
    --8<-- "docs/examples/widgets/content_switcher.py"
    ~~~

    1. A `Horizontal` to hold the buttons, each with a unique ID.
    2. This button will select the `DataTable` in the `ContentSwitcher`.
    3. This button will select the `Markdown` in the `ContentSwitcher`.
    4. Note that the initial visible content is set by its ID, see below.
    5. When a button is pressed, its ID is used to switch to a different widget in the `ContentSwitcher`. Remember that IDs are unique within parent, so the buttons and the widgets in the `ContentSwitcher` can share IDs.

=== "content_switcher.tcss"

    ~~~sass
    --8<-- "docs/examples/widgets/content_switcher.tcss"
    ~~~

When the user presses the "Markdown" button the view is switched:

```{.textual path="docs/examples/widgets/content_switcher.py" lines="40" press="tab,enter"}
```

## Reactive Attributes

| Name      | Type            | Default | Description                                                             |
| --------- | --------------- | ------- | ----------------------------------------------------------------------- |
| `current` | `str` \| `None` | `None`  | The ID of the currently-visible child. `None` means nothing is visible. |

## Messages

This widget posts no messages.

## Bindings

This widget has no bindings.

## Component Classes

This widget has no component classes.


---


::: textual.widgets.ContentSwitcher
    options:
      heading_level: 2