{"route":"/en-US-v0.13.1/reference/foundations/label/","title":"Label","description":"Documentation for the Label type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"syntax","name":"Syntax","children":[]},{"id":"constructor","name":"Constructor","children":[{"id":"constructor-name","name":"name","children":[]}]}],"body":{"kind":"type","content":{"name":"label","title":"Label","keywords":[],"oneliner":"A label for an element.","details":"

A label for an element.

\n

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

\n

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

\n

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

\n

Example

\n
#show <a>: set text(blue)\n#show label("b"): set text(red)\n\n= Heading <a>\n*Strong* #label("b")\n
\"Preview\"
\n

Syntax

\n

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

\n

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

\n
// Equivalent to `#heading[Introduction] <a>`.\n= Introduction <a>\n\n// Equivalent to `#heading[Conclusion #label("b")]`.\n= Conclusion #label("b")\n
\n

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

","constructor":{"path":[],"name":"label","title":"Construct","keywords":[],"oneliner":"Creates a label from a string.","element":false,"contextual":false,"deprecation":null,"details":"

Creates a label from a string.

","example":null,"self":false,"params":[{"name":"name","details":"

The name of the label.

","example":null,"types":["str"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["label"],"scope":[]},"scope":[]}}}