Function: highlightSubstring()

highlightSubstring(text, substring, highlightProps): Element

Defined in: widgets/utility/listElementView.tsx:140

Renders a text span with all occurrences of the specified sub-string highlighted.

Parameters

Parameter	Type	Default value	Description
text	string	undefined	source text to display
substring	undefined | string	undefined	sub-string to highlight each instance of inside the text
highlightProps	HTMLProps<HTMLSpanElement>	DEFAULT_HIGHLIGHT_PROPS	props to pass to each <span> for a sub-string occurrence

Returns

Element