Typst Fumadocs

Alignment

Documentation for the Alignment type.

Where to align something along an axis.

Possible values are:

  • start: Aligns at the start of the text direction.
  • end: Aligns at the end of the text direction.
  • left: Align at the left.
  • center: Aligns in the middle, horizontally.
  • right: Aligns at the right.
  • top: Aligns at the top.
  • horizon: Aligns in the middle, vertically.
  • bottom: Align at the bottom.

These values are available globally and also in the alignment type's scope, so you can write either of the following two:

Loading compiler...

2D alignments

To align along both axes at the same time, add the two alignments using the + operator. For example, top + right aligns the content to the top right corner.

Loading compiler...

Fields

The x and y fields hold the alignment's horizontal and vertical components, respectively (as yet another alignment). They may be none.

Loading compiler...

Methods

The axis this alignment belongs to.

  • "horizontal" for start, left, center, right, and end
  • "vertical" for top, horizon, and bottom
  • none for 2-dimensional alignments
Loading compiler...

The inverse alignment.

Loading compiler...

On this page