• 
• 
• Reference
• 
• Text
• 
• Underline

underlineElement

Element functions can be customized with set and show rules.

Underlines text.

Example

This is #underline[important].

Parameters

stroke

auto or length or color or gradient or stroke or tiling or dictionary

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

Default: auto

How to stroke the line.

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

View example

Take #underline(
  stroke: 1.5pt + red,
  offset: 2pt,
  [care],
)

offset

auto or length

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

Default: auto

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

View example

#underline(offset: 5pt)[
  The Tale Of A Faraway Line I
]

extent

length

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

Default: 0pt

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

View example

#align(center,
  underline(extent: 2pt)[Chapter 1]
)

evade

bool

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

Default: true

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

View example

This #underline(evade: true)[is great].
This #underline(evade: false)[is less great].

background

bool

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

Default: false

Whether the line is placed behind the content it underlines.

View example

#set underline(stroke: (thickness: 1em, paint: maroon, cap: "round"))
#underline(background: true)[This is stylized.] \
#underline(background: false)[This is partially hidden.]

body

content

RequiredPositional

Positional parameters are specified in order, without names.

The content to underline.

TextPrevious page

UppercaseNext page