Document Header widget

docs/examples/widgets/header.py

@@ -0,0 +1,12 @@
+from textual.app import App, ComposeResult
+from textual.widgets import Header
+
+
+class HeaderApp(App):
+    def compose(self) -> ComposeResult:
+        yield Header()
+
+
+if __name__ == "__main__":
+    app = HeaderApp()
+    app.run()

docs/reference/header.md

@@ -0,0 +1 @@
+::: textual.widgets.Header

docs/widgets/footer.md

@@ -15,7 +15,7 @@ widget. Notice how the `Footer` automatically displays the keybind.
     ```{.textual path="docs/examples/widgets/footer.py"}
     ```
 
-=== "button.py"
+=== "footer.py"
 
     ```python
     --8<-- "docs/examples/widgets/footer.py"

docs/widgets/header.md

@@ -1 +1,34 @@
 # Header
+
+## Description
+
+A simple header widget which docks itself to the top of the parent 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.
+
+## See Also
+
+* [Header](../reference/header.md) code reference

mkdocs.yml

@@ -102,6 +102,7 @@ nav:
     - "reference/events.md"
     - "reference/footer.md"
     - "reference/geometry.md"
+    - "reference/header.md"
     - "reference/index.md"
     - "reference/message_pump.md"
     - "reference/message.md"