File: header.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 (63 lines) | stat: -rw-r--r-- 1,738 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
# Header

A simple header widget which docks itself to the top of the parent container.

!!! note

    The application title which is shown in the header is taken from the [`title`][textual.app.App.title] and [`sub_title`][textual.app.App.sub_title] of the application.

- [ ] Focusable
- [ ] Container

## Example

The example below shows an app with a `Header`.

=== "Output"

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

=== "header.py"

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

This example shows how to set the text in the `Header` using `App.title` and `App.sub_title`:

=== "Output"

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

=== "header_app_title.py"

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

## Reactive Attributes

| Name   | Type   | Default | Description                                                                                                                                                                                      |
| ------ | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `tall` | `bool` | `True`  | Whether the `Header` widget is displayed as tall or not. The tall variant is 3 cells tall by default. The non-tall variant is a single cell tall. This can be toggled by clicking on the header. |

## Messages

This widget posts no messages.

## Bindings

This widget has no bindings.

## Component Classes

This widget has no component classes.

---


::: textual.widgets.Header
    options:
      heading_level: 2