{"route":"/en-US-v0.13.1/reference/text/strike/","title":"Strikethrough","description":"Documentation for the `strike` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-stroke","name":"stroke","children":[]},{"id":"parameters-offset","name":"offset","children":[]},{"id":"parameters-extent","name":"extent","children":[]},{"id":"parameters-background","name":"background","children":[]},{"id":"parameters-body","name":"body","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"strike","title":"Strikethrough","keywords":[],"oneliner":"Strikes through text.","element":true,"contextual":false,"deprecation":null,"details":"

Strikes through text.

\n

Example

\n
This is #strike[not] relevant.\n
\"Preview\"
","example":null,"self":false,"params":[{"name":"stroke","details":"

How to stroke the line.

\n

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

\n

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

","example":"
This is #strike(stroke: 1.5pt + red)[very stricken through]. \\\nThis is #strike(stroke: 10pt)[redacted].\n
\"Preview\"
","types":["auto","length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"offset","details":"

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

\n

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

","example":"
#set text(font: "Inria Serif")\nThis is #strike(offset: auto)[low-ish]. \\\nThis is #strike(offset: -3.5pt)[on-top].\n
\"Preview\"
","types":["auto","length"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"extent","details":"

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

","example":"
This #strike(extent: -2pt)[skips] parts of the word.\nThis #strike(extent: 2pt)[extends] beyond the word.\n
\"Preview\"
","types":["length"],"strings":[],"default":"0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"background","details":"

Whether the line is placed behind the content.

","example":"
#set strike(stroke: red)\n#strike(background: true)[This is behind.] \\\n#strike(background: false)[This is in front.]\n
\"Preview\"
","types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body","details":"

The content to strike through.

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