@ark-ui/vue/dist/components/highlight/highlight.types.d.ts

A collection of unstyled, accessible UI components for Vue, utilizing state machines for seamless interaction.

export interface UseHighlightProps {
    /**
     * The text to highlight
     */
    text: string;
    /**
     * The query to highlight in the text
     */
    query: string | string[];
    /**
     * Whether to ignore case while matching
     */
    ignoreCase?: boolean;
    /**
     * Whether to match multiple instances of the query
     */
    matchAll?: boolean;
    /**
     * Whether to match the exact query
     */
    exactMatch?: boolean;
}
export interface HighlightChunk {
    text: string;
    match: boolean;
}
export interface HighlightSpan {
    start: number;
    end: number;
    match?: boolean;
}