Function highlightPhraseHTML

  • highlightPhraseHTML(
        text: string,
        term: string,
        options?: HighlightOptions,
    ): string

    Convert original text to safe HTML with all occurrences of term highlighted. Matching is case-insensitive and respects the tokenizer's separators between tokens, e.g. "white house" will match "white_house", "WHITE-house", "white house".

    • Preserves original casing in the output.
    • Escapes all non-matching slices.
    • Wraps only the matched span with (or custom tag).

    Parameters

    Returns string

Settings

Member Visibility