@wordpress/components
Version:
UI components for WordPress.
28 lines • 1.05 kB
TypeScript
import type { FindAllArgs } from 'highlight-words-core';
/**
* Source:
* https://github.com/bvaughn/react-highlight-words/blob/HEAD/src/Highlighter.js
*/
interface Options {
autoEscape?: boolean;
caseSensitive?: boolean;
children: string;
sanitize?: FindAllArgs['sanitize'];
searchWords?: string[];
}
/**
* Creates the highlighted text rendered by Text.
*
* @param options Highlighter options.
* @param options.autoEscape Whether to escape regular-expression characters.
* @param options.caseSensitive Whether matching is case-sensitive.
* @param options.children Text to highlight.
* @param options.sanitize Text normalization function used for matching.
* @param options.searchWords Search terms to highlight.
*/
export declare function createHighlighterText({ autoEscape, caseSensitive, children, sanitize, searchWords, }: Options): import("react").DetailedReactHTMLElement<{
children: string;
key: number;
}, HTMLElement>[] | null;
export {};
//# sourceMappingURL=utils.d.ts.map