@yamada-ui/react/dist/types/components/highlight/highlight.d.ts

React UI components of the Yamada, by the Yamada, for the Yamada built with React and Emotion

import { MarkProps } from "../mark/mark.js";
import { TextProps } from "../text/text.js";
import { FC } from "react";

//#region src/components/highlight/highlight.d.ts
interface HighlightProps extends Omit<TextProps, "children"> {
  /**
   * The text used for searching.
   */
  children: string;
  /**
   * Can be a single string or an array of strings. These are the terms that are highlighted in the text.
   */
  query: string | string[];
  /**
   * If `true`, `Fragment` is used for rendering.
   *
   * @default false
   */
  fragment?: boolean;
  /**
   * Properties passed to the Mark component which is used to highlight the matched terms.
   */
  markProps?: MarkProps;
}
/**
 * `Highlight` is a component that highlights specified strings within text. By default, it renders a `p` element.
 *
 * @see https://yamada-ui.com/docs/components/highlight
 */
declare const Highlight: FC<HighlightProps>;
//#endregion
export { Highlight, HighlightProps };
//# sourceMappingURL=highlight.d.ts.map