Documentation

highlightElement
Question mark
Go to source

Highlights text with a background color.

Example

This is #highlight[important].

Parameters

highlight(
fill: nonecolorgradienttiling,stroke: nonelengthcolorgradientstroketilingdictionary,top-edge: lengthstr,bottom-edge: lengthstr,extent: length,radius: relativedictionary,content,
) → content

fill
none or color or gradient or tiling
Settable
Question mark
Default: rgb("#fffd11a1")

The color to highlight the text with.

ExpandView example
This is #highlight(
  fill: blue
)[highlighted with blue].

stroke
none or length or color or gradient or stroke or tiling or dictionary
Settable
Question mark
Default: (:)

The highlight’s border color. See the rectangle’s documentation for more details.

ExpandView example
This is a #highlight(
  stroke: fuchsia
)[stroked highlighting].

top-edge
length or str
Settable
Question mark
Default: "ascender"

The top end of the background rectangle.

ExpandView example
#set highlight(top-edge: "ascender")
#highlight[a] #highlight[aib]

#set highlight(top-edge: "x-height")
#highlight[a] #highlight[aib]
VariantDetails
"ascender"The font’s ascender, which typically exceeds the height of all glyphs.
"cap-height"The approximate height of uppercase letters.
"x-height"The approximate height of non-ascending lowercase letters.
"baseline"The baseline on which the letters rest.
"bounds"The top edge of the glyph’s bounding box.

bottom-edge
length or str
Settable
Question mark
Default: "descender"

The bottom end of the background rectangle.

ExpandView example
#set highlight(bottom-edge: "descender")
#highlight[a] #highlight[ap]

#set highlight(bottom-edge: "baseline")
#highlight[a] #highlight[ap]
VariantDetails
"baseline"The baseline on which the letters rest.
"descender"The font’s descender, which typically exceeds the depth of all glyphs.
"bounds"The bottom edge of the glyph’s bounding box.

extent
length
Settable
Question mark
Default: 0pt

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

ExpandView example
A long #highlight(extent: 4pt)[background].

radius
relative or dictionary
Settable
Question mark
Default: (:)

How much to round the highlight’s corners. See the rectangle’s documentation for more details.

ExpandView example
Listen #highlight(
  radius: 5pt, extent: 2pt
)[carefully], it will be on the test.

body
content
RequiredPositional
Question mark

The content that should be highlighted.