Files
textual/docs/widgets/header.md
Will McGugan 2244b1161e api docs (#2240)
* api docs

* more docstrings

* logs

* docs shakeup

* fix notes, added intro to all apis

* Remove defaults to

* add note to events

* note

* use fira code
2023-04-08 15:35:49 +01:00

1.1 KiB

Header

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

  • 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"
```

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 sends no messages.


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