Selector

A filter for selecting elements within the document.

To construct a selector you can:

• use an element function
• filter for an element function with specific fields
• use a string or regular expression
• use a <label>
• use a location
• call the selector constructor to convert any of the above types into a selector value and use the methods below to refine it

Selectors are used to apply styling rules to elements. You can also use selectors to query the document for certain types of elements.

Furthermore, you can pass a selector to several of Typst's built-in functions to configure their behaviour. One such example is the outline where it can be used to change which elements are listed within the outline.

Multiple selectors can be combined using the methods shown below. However, not all kinds of selectors are supported in all places, at the moment.

Example

Constructor

Turns a value into a selector. The following values are accepted:

• An element function like a heading or figure.
• A string or regular expression.
• A <label>.
• A location.
• A more complex selector like heading.where(level: 1).

#selector(
  target
) -> selector

Parameters

Methods

Selects all elements that match this or any of the other selectors.

#selector.or(
  others
) -> selector

Parameters

Selects all elements that match this and all of the other selectors.

#selector.and(
  others
) -> selector

Parameters

Returns a modified selector that will only match elements that occur before the first match of end.

#selector.before(
  end,
  inclusive: bool
) -> selector

Parameters

Returns a modified selector that will only match elements that occur after the first match of start.

#selector.after(
  start,
  inclusive: bool
) -> selector

Parameters