UNPKG

582 BTypeScriptView Raw
1import { type HighlightChunk } from "@ark-ui/react/highlight";
2import { type JSX } from "react";
3import { type SystemStyleObject } from "../../styled-system";
4export interface HighlightProps {
5 query: string | string[];
6 children: string | ((props: HighlightChunk[]) => React.ReactNode);
7 styles?: SystemStyleObject;
8 ignoreCase?: boolean;
9 matchAll?: boolean;
10}
11/**
12 * `Highlight` allows you to highlight substrings of a text.
13 *
14 * @see Docs https://chakra-ui.com/docs/components/highlight
15 */
16export declare function Highlight(props: HighlightProps): JSX.Element;
17
\No newline at end of file