{"route":"/en-US-v0.14.1/reference/model/link/","title":"Link","description":"Documentation for the `link` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"syntax","name":"Syntax","children":[]},{"id":"hyphenation","name":"Hyphenation","children":[]},{"id":"accessibility","name":"Accessibility","children":[]},{"id":"links-in-html-export","name":"Links in HTML export","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-dest","name":"dest","children":[]},{"id":"parameters-body","name":"body","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"link","title":"Link","keywords":[],"oneliner":"Links to a URL or a location in the document.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Links to a URL or a location in the document.

\n

By default, links do not look any different from normal text. However,\nyou can easily apply a style of your choice with a show rule.

\n

Example

\n
#show link: underline\n\nhttps://example.com \\\n\n#link("https://example.com") \\\n#link("https://example.com")[\n  See example.com\n]\n
\"Preview\"
\n

Syntax

\n

This function also has dedicated syntax: Text that starts with http:// or\nhttps:// is automatically turned into a link.

\n

Hyphenation

\n

If you enable hyphenation or justification, by default, it will not apply to\nlinks to prevent unwanted hyphenation in URLs. You can opt out of this\ndefault via show link: set text(hyphenate: true).

\n

Accessibility

\n

The destination of a link should be clear from the link text itself, or at\nleast from the text immediately surrounding it. In PDF export, Typst will\nautomatically generate a tooltip description for links based on their\ndestination. For links to URLs, the URL itself will be used as the tooltip.

\n\n

In HTML export, a link to a label or location will be turned into a\nfragment link to a named anchor point. To support this, targets without an\nexisting ID will automatically receive an ID in the DOM. How this works\nvaries by which kind of HTML node(s) the link target turned into:

\n\n

If you rely on a specific DOM structure, you should ensure that the link\ntarget turns into one or multiple elements, as the compiler makes no\nguarantees on the precise segmentation of text into text nodes.

\n

If present, the automatic ID generation tries to reuse the link target's\nlabel to create a human-readable ID. A label can be reused if:

\n\n

These rules ensure that the label is both a valid CSS identifier and a valid\nURL fragment for linking.

\n

As IDs must be unique in the DOM, duplicate labels might need disambiguation\nwhen reusing them as IDs. The precise rules for this are as follows:

\n"}],"self":false,"params":[{"name":"dest","details":[{"kind":"html","content":"

The destination the link points to.

\n"},{"kind":"example","content":{"body":"
= Introduction <intro>\n#link("mailto:hello@typst.app") \\\n#link(<intro>)[Go to intro] \\\n#link((page: 1, x: 0pt, y: 0pt))[\n  Go to top\n]\n
\"Preview\"
","title":null}}],"types":["str","label","location","dictionary"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"body","details":[{"kind":"html","content":"

The content that should become a link.

\n

If dest is an URL string, the parameter can be omitted. In this case,\nthe URL will be shown as the link.

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