Info
This site is generated using the static site generator developed by the Typst Community. Please adjust the text content of this banner according to your usage requirements. At Typst GmbH's request, when publishing documentation, you must clearly indicate that it is non-official and display the version of Typst being documented. For details, refer to Issue #874 on typst/typst.
TypstDocumentEnglish
v0.dev.2025-09-12

label

A label for an element.

Inserting a label into content attaches it to the closest preceding element that is not a space. The preceding element must be in the same scope as the label, which means that Hello #[<label>], for instance, wouldn't work.

A labelled element can be referenced, queried for, and styled through its label.

Once constructed, you can get the name of a label using str.

Example

#show <a>: set text(blue)
#show label("b"): set text(red)

= Heading <a>
*Strong* #label("b")
Preview

Syntax

This function also has dedicated syntax: You can create a label by enclosing its name in angle brackets. This works both in markup and code. A label's name can contain letters, numbers, _, -, :, and .. A label cannot be empty.

Note that there is a syntactical difference when using the dedicated syntax for this function. In the code below, the <a> terminates the heading and thus attaches to the heading itself, whereas the #label("b") is part of the heading and thus attaches to the heading's text.

// Equivalent to `#heading[Introduction] <a>`.
= Introduction <a>

// Equivalent to `#heading[Conclusion #label("b")]`.
= Conclusion #label("b")

Currently, labels can only be attached to elements in markup mode, not in code mode. This might change in the future.

Constructor
Parameter
Parameters are input values for functions. Specify them in parentheses after the function name.

Creates a label from a string.

label()->

name
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The name of the label.

Unlike the dedicated syntax, this constructor accepts any non-empty string, including names with special characters.

Open official docs

Search