• 
• 
• Reference
• 
• Construct
• 
• Regex

regex

Create a regular expression from a string.

The result can be used as a show rule selector and with string methods like find, split, and replace.

See here for a specification of the supported syntax.

Example

// Works with show rules.
#show regex("\d+"): set text(red)

The numbers 1 to 10.

// Works with string methods.
#("a,b;c"
    .split(regex("[,;]")))

Parameters

Parameters are the inputs to a function. They are specified in parentheses after the function name.

regex

string

RequiredPositional

Positional parameters are specified in order, without names.

The regular expression as a string.

Most regex escape sequences just work because they are not valid Typst escape sequences. To produce regex escape sequences that are also valid in Typst (e.g. \\), you need to escape twice. Thus, to match a verbatim backslash, you would need to write regex("\\\\").

If you need many escape sequences, you can also create a raw element and extract its text to use it for your regular expressions: regex(`\d+\.\d+\.\d+`.text).

RangePrevious page

StringNext page