TypstDocumentation

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.

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.

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

Constructor
Question mark

Creates a label from a string.

label() -> label

name
str
RequiredPositional
Question mark

The name of the label.