Info
This site is generated using the static site generator developed by the Typst Community. Please adjust the text content of this banner according to your usage requirements. At Typst GmbH's request, when publishing documentation, you must clearly indicate that it is non-official and display the version of Typst being documented. For details, refer to Issue #874 on typst/typst.
TypstDocumentEnglish
v0.dev.2025-09-12

strike
Element
Element
Element functions can be customized with set and show rules.

Strikes through text.

Example

This is #strike[not] relevant.
Preview

Parameter
Parameter
Parameters are input values for functions. Specify them in parentheses after the function name.

stroke
Settable
Settable
Settable parameters can be set using the set rule, changing the default value used thereafter.

How to stroke the line.

If set to auto, takes on the text's color and a thickness defined in the current font.

Note: Please don't use this for real redaction as you can still copy paste the text.

Default value:

auto

Show example
This is #strike(stroke: 1.5pt + red)[very stricken through]. \
This is #strike(stroke: 10pt)[redacted].
Preview

offset
Settable
Settable
Settable parameters can be set using the set rule, changing the default value used thereafter.

The position of the line relative to the baseline. Read from the font tables if auto.

This is useful if you are unhappy with the offset your font provides.

Default value:

auto

Show example
#set text(font: "Inria Serif")
This is #strike(offset: auto)[low-ish]. \
This is #strike(offset: -3.5pt)[on-top].
Preview

extent
Settable
Settable
Settable parameters can be set using the set rule, changing the default value used thereafter.

The amount by which to extend the line beyond (or within if negative) the content.

Default value:

0pt

Show example
This #strike(extent: -2pt)[skips] parts of the word.
This #strike(extent: 2pt)[extends] beyond the word.
Preview

background
Settable
Settable
Settable parameters can be set using the set rule, changing the default value used thereafter.

Whether the line is placed behind the content.

Default value:

false

Show example
#set strike(stroke: red)
#strike(background: true)[This is behind.] \
#strike(background: false)[This is in front.]
Preview

body
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The content to strike through.

Open official docs

Search