textual/docs/styles/dock.md

Dock

The dock property is used to fix a widget to the edge of a container (which may be the entire terminal window).

Syntax

dock: top | right | bottom | left;

Examples

The example below shows a left docked sidebar. Notice that even though the content is scrolled, the sidebar remains fixed.

=== "Output"

```{.textual path="docs/examples/guide/layout/dock_layout1_sidebar.py" press="pagedown,down,down,_,_,_,_,_"}
```

=== "dock_layout1_sidebar.py"

```python
--8<-- "docs/examples/guide/layout/dock_layout1_sidebar.py"
```

=== "dock_layout1_sidebar.css"

```sass hl_lines="2"
--8<-- "docs/examples/guide/layout/dock_layout1_sidebar.css"
```

The second example shows how one can use full-width or full-height containers to dock labels to the edges of a larger container. The labels will remain in that position (docked) even if the container they are in scrolls horizontally and/or vertically.

=== "Output"

```{.textual path="docs/examples/styles/dock_all.py"}
```

=== "dock_all.py"

```py
--8<-- "docs/examples/styles/dock_all.py"
```

=== "dock_all.css"

```css hl_lines="2-5 8-11 14-17 20-23"
--8<-- "docs/examples/styles/dock_all.css"
```

CSS

/* Dock the widget on the left edge of its parent container */
dock: left;

Python

# Dock the widget on the left edge of its parent container
widget.styles.dock = "left"