Struct LinkElem 

pub struct LinkElem {
    pub dest: LinkTarget,
    pub body: Content,
}

Links to a URL or a location in the document.

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

Example

#show link: underline

https://example.com \

#link("https://example.com") \
#link("https://example.com")[
  See example.com
]

Syntax

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

Hyphenation

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

Accessibility

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

Links in HTML export

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

• If the link target turned into a single HTML element, that element will receive the ID. This is, for instance, typically the case when linking to a top-level heading (which turns into a single <h2> element).

• If the link target turned into a single text node, the node will be wrapped in a <span>, which will then receive the ID.

• If the link target turned into multiple nodes, the first node will receive the ID.

• If the link target turned into no nodes at all, an empty span will be generated to serve as a link target.

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

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

• All characters are alphabetic or numeric according to Unicode, or a hyphen, or an underscore.

• The label does not start with a digit or hyphen.

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

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

• If a label can be reused and is unique in the document, it will directly be used as the ID.

• If it’s reusable, but not unique, a suffix consisting of a hyphen and an integer will be added. For instance, if the label <mylabel> exists twice, it would turn into mylabel-1 and mylabel-2.

• Otherwise, a unique ID of the form loc- followed by an integer will be generated.

Fields

dest: LinkTarget

body: Content

Implementations

impl LinkElem

pub fn new(dest: LinkTarget, body: Content) -> Self

Create a new instance of the element.

impl LinkElem

pub const dest: Field<Self, 0u8>

pub const body: Field<Self, 1u8>

pub const current: Field<Self, 2u8>

impl LinkElem

pub fn from_url(url: Url) -> Self

Create a link element from a URL with its bare text.

Trait Implementations

impl Clone for LinkElem

fn clone(&self) -> LinkElem

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Construct for LinkElem

fn construct(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for LinkElem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for LinkElem

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl NativeElement for LinkElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl RequiredField<0> for LinkElem

const FIELD: RequiredFieldData<Self, 0u8>

type Type = LinkTarget

impl RequiredField<1> for LinkElem

const FIELD: RequiredFieldData<Self, 1u8>

type Type = Content

impl Set for LinkElem

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.

impl SettableProperty<2> for LinkElem

const FIELD: SettablePropertyData<Self, 2u8>

type Type = Option<Destination>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl RefableProperty<2> for LinkElem