Highlight

Highlight given part of a string with mark tag
Import

Usage

Use Highlight component to highlight a substring in a given string with mark tag.

Pass main string as children to Highlight component and string part that should be highlighted to highlight prop. If main string does not include highlight part, it will be ignored. Component ignores trailing whitespace and highlights all matched characters sequence.

Highlight This, definitely THIS and also this!
HighlightColor
import { Highlight } from '@mantine/core';
function Demo() {
return (
<Highlight highlight="this">
Highlight This, definitely THIS and also this!
</Highlight>
);
}

Highlight multiple substrings

To highlight multiple substrings, provide an array of values:

Highlight this and also that
import { Highlight } from '@mantine/core';
function Demo() {
return <Highlight highlight={['this', 'that']}>Highlight this and also that</Highlight>;
}

Change highlight styles

Default Mark styles can be overwritten with highlightStyles prop, it accepts either function with a subscription to theme or an object with styles:

You can change styles of highlighted part if you do not like default styles
import { Highlight } from '@mantine/core';
function Demo() {
return (
<Highlight
align="center"
highlight={['highlighted', 'default']}
highlightStyles={(theme) => ({
backgroundImage: theme.fn.linearGradient(45, theme.colors.cyan[5], theme.colors.indigo[5]),
fontWeight: 700,
WebkitBackgroundClip: 'text',
WebkitTextFillColor: 'transparent',
})}
>
You can change styles of highlighted part if you do not like default styles
</Highlight>
);
}

Text props

Highlight accepts the same props as Text component:

import { Highlight } from '@mantine/core';
function Demo() {
return (
<Highlight
component="a"
href="https://mantine.dev"
target="_blank"
highlight="mantine"
variant="link"
weight={500}
>
Mantine website
</Highlight>
);
}