{"route":"/en-US-v0.13.1/reference/text/highlight/","title":"Highlight","description":"Documentation for the `highlight` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-fill","name":"fill","children":[]},{"id":"parameters-stroke","name":"stroke","children":[]},{"id":"parameters-top-edge","name":"top-edge","children":[]},{"id":"parameters-bottom-edge","name":"bottom-edge","children":[]},{"id":"parameters-extent","name":"extent","children":[]},{"id":"parameters-radius","name":"radius","children":[]},{"id":"parameters-body","name":"body","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"highlight","title":"Highlight","keywords":[],"oneliner":"Highlights text with a background color.","element":true,"contextual":false,"deprecation":null,"details":"

Highlights text with a background color.

\n

Example

\n
This is #highlight[important].\n
\"Preview\"
","example":null,"self":false,"params":[{"name":"fill","details":"

The color to highlight the text with.

","example":"
This is #highlight(\n  fill: blue\n)[highlighted with blue].\n
\"Preview\"
","types":["none","color","gradient","tiling"],"strings":[],"default":"rgb("#fffd11a1")","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"stroke","details":"

The highlight's border color. See the\nrectangle's documentation for more details.

","example":"
This is a #highlight(\n  stroke: fuchsia\n)[stroked highlighting].\n
\"Preview\"
","types":["none","length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"(:)","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"top-edge","details":"

The top end of the background rectangle.

","example":"
#set highlight(top-edge: "ascender")\n#highlight[a] #highlight[aib]\n\n#set highlight(top-edge: "x-height")\n#highlight[a] #highlight[aib]\n
\"Preview\"
","types":["length","str"],"strings":[{"string":"ascender","details":"

The font's ascender, which typically exceeds the height of all glyphs.

"},{"string":"cap-height","details":"

The approximate height of uppercase letters.

"},{"string":"x-height","details":"

The approximate height of non-ascending lowercase letters.

"},{"string":"baseline","details":"

The baseline on which the letters rest.

"},{"string":"bounds","details":"

The top edge of the glyph's bounding box.

"}],"default":""ascender"","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"bottom-edge","details":"

The bottom end of the background rectangle.

","example":"
#set highlight(bottom-edge: "descender")\n#highlight[a] #highlight[ap]\n\n#set highlight(bottom-edge: "baseline")\n#highlight[a] #highlight[ap]\n
\"Preview\"
","types":["length","str"],"strings":[{"string":"baseline","details":"

The baseline on which the letters rest.

"},{"string":"descender","details":"

The font's descender, which typically exceeds the depth of all glyphs.

"},{"string":"bounds","details":"

The bottom edge of the glyph's bounding box.

"}],"default":""descender"","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"extent","details":"

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

","example":"
A long #highlight(extent: 4pt)[background].\n
\"Preview\"
","types":["length"],"strings":[],"default":"0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"radius","details":"

How much to round the highlight's corners. See the\nrectangle's documentation for more details.

","example":"
Listen #highlight(\n  radius: 5pt, extent: 2pt\n)[carefully], it will be on the test.\n
\"Preview\"
","types":["relative","dictionary"],"strings":[],"default":"(:)","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body","details":"

The content that should be highlighted.

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