textual/docs/styles/offset.md

Offset

The offset rule defines an offset for the position of the widget.

Syntax

--8<-- "docs/snippets/syntax_block_start.md" offset: <scalar> <scalar>;

offset-x: <scalar>; offset-y: <scalar> --8<-- "docs/snippets/syntax_block_end.md"

The two <scalar> in the offset define, respectively, the offsets in the horizontal and vertical axes for the widget.

To specify an offset along a single axis, you can use offset-x and offset-y.

Values

--8<-- "docs/snippets/type_syntax/scalar.md"

Example

In this example, we have 3 widgets with differing offsets.

=== "Output"

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

=== "offset.py"

```python
--8<-- "docs/examples/styles/offset.py"
```

=== "offset.css"

```css
--8<-- "docs/examples/styles/offset.css"
```

CSS

/* Move the widget 8 cells in the x direction and 2 in tye y direction */
offset: 8 2;

/* Move the widget 4 cells in the x direction
offset-x: 4;
/* Move the widget -2 cells in the y direction
offset-y: -2;

Python

You cannot change programmatically the offset for a single axis. You have to set the two axes at the same time.

# Move the widget 2 cells in the x direction, and 4 in the y direction.
widget.styles.offset = (2, 4)