{"route":"/en-US-v0.13.1/reference/text/underline/","title":"Underline","description":"Documentation for the `underline` 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-evade","name":"evade","children":[]},{"id":"parameters-background","name":"background","children":[]},{"id":"parameters-body","name":"body","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"underline","title":"Underline","keywords":[],"oneliner":"Underlines text.","element":true,"contextual":false,"deprecation":null,"details":"

Underlines text.

\n

Example

\n
This is #underline[important].\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.

","example":"
Take #underline(\n  stroke: 1.5pt + red,\n  offset: 2pt,\n  [care],\n)\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.

","example":"
#underline(offset: 5pt)[\n  The Tale Of A Faraway Line I\n]\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":"
#align(center,\n  underline(extent: 2pt)[Chapter 1]\n)\n
\"Preview\"
","types":["length"],"strings":[],"default":"0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"evade","details":"

Whether the line skips sections in which it would collide with the\nglyphs.

","example":"
This #underline(evade: true)[is great].\nThis #underline(evade: false)[is less great].\n
\"Preview\"
","types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"background","details":"

Whether the line is placed behind the content it underlines.

","example":"
#set underline(stroke: (thickness: 1em, paint: maroon, cap: "round"))\n#underline(background: true)[This is stylized.] \\\n#underline(background: false)[This is partially hidden.]\n
\"Preview\"
","types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body","details":"

The content to underline.

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