reablocks/dist/data/HighlightedText/HighlightedText.d.ts

Component library for React

import { FC, ReactNode } from 'react';
export interface HighlightedTextProps {
    /**
     * The keyword to highlight within the text.
     */
    search?: string;
    /**
     * The content to highlight. Only string or number children are
     * highlighted; other nodes render unchanged.
     */
    children?: string | number | ReactNode;
}
/**
 * Renders text with every case-insensitive occurrence of `search` wrapped
 * in a `<mark>` element. Non-text children are rendered as-is.
 *
 * Memoized so unchanged items skip re-rendering when used in lists.
 */
export declare const HighlightedText: FC<HighlightedTextProps>;