Highlight

Highlight is a component that highlights specified strings within text. By default, it renders a p element.

わかんないよ…。わっかんないよ！ジュー君の言ってることはひとつもわかんないよ！ジュー君がいいって言ってるもの、何がいいのかわかんないよ！わかんない！私にはわかんないの！ブラッディって何がカッコイイの？血なんて嫌だよ！痛いだけだよ！狂うのどこがカッコイイの？クレイジーのどこがいいのかわかんない！

<Highlight query="わかんない" colorScheme="warning">
  わかんないよ…。わっかんないよ！ ジュー君の言ってることはひとつもわかんないよ！
  ジュー君がいいって言ってるもの、何がいいのかわかんないよ！
  わかんない！私にはわかんないの！
  ブラッディって何がカッコイイの？血なんて嫌だよ！痛いだけだよ！
  狂うのどこがカッコイイの？クレイジーのどこがいいのかわかんない！
</Highlight>

Usage

import { Highlight } from "@yamada-ui/react"

import { Highlight } from "@/components/ui"

import { Highlight } from "@workspaces/ui"

<Highlight />

Change Variant

<VStack>
  <For each={["subtle", "solid", "text", "accent"]}>
    {(variant, index) => (
      <Highlight
        key={index}
        query="わかんない"
        colorScheme="warning"
        markProps={{ variant }}
      >
        わかんないよ…。わっかんないよ！
        ジュー君の言ってることはひとつもわかんないよ！
        ジュー君がいいって言ってるもの、何がいいのかわかんないよ！
        わかんない！私にはわかんないの！
        ブラッディって何がカッコイイの？血なんて嫌だよ！痛いだけだよ！
        狂うのどこがカッコイイの？クレイジーのどこがいいのかわかんない！
      </Highlight>
    )}
  </For>
</VStack>

Change Color Scheme

<VStack>
  <For each={["warning", "success"]}>
    {(colorScheme, index) => (
      <Highlight key={index} query="わかんない" colorScheme={colorScheme}>
        わかんないよ…。わっかんないよ！
        ジュー君の言ってることはひとつもわかんないよ！
        ジュー君がいいって言ってるもの、何がいいのかわかんないよ！
        わかんない！私にはわかんないの！
        ブラッディって何がカッコイイの？血なんて嫌だよ！痛いだけだよ！
        狂うのどこがカッコイイの？クレイジーのどこがいいのかわかんない！
      </Highlight>
    )}
  </For>
</VStack>

Specify Multiple

<Highlight query={["わかんない", "ジュー君"]} colorScheme="warning">
  わかんないよ…。わっかんないよ！ ジュー君の言ってることはひとつもわかんないよ！
  ジュー君がいいって言ってるもの、何がいいのかわかんないよ！
  わかんない！私にはわかんないの！
  ブラッディって何がカッコイイの？血なんて嫌だよ！痛いだけだよ！
  狂うのどこがカッコイイの？クレイジーのどこがいいのかわかんない！
</Highlight>

Style the Highlight

<Highlight
  query="わかんない"
  colorScheme="warning"
  markProps={{ rounded: "full" }}
>
  わかんないよ…。わっかんないよ！ ジュー君の言ってることはひとつもわかんないよ！
  ジュー君がいいって言ってるもの、何がいいのかわかんないよ！
  わかんない！私にはわかんないの！
  ブラッディって何がカッコイイの？血なんて嫌だよ！痛いだけだよ！
  狂うのどこがカッコイイの？クレイジーのどこがいいのかわかんない！
</Highlight>

Use Fragments

By default, Highlight renders a p element. By setting fragment, highlight will use Fragment.

<Text>
  <Highlight fragment query="わかんない" colorScheme="warning">
    わかんないよ…。わっかんないよ！
    ジュー君の言ってることはひとつもわかんないよ！
    ジュー君がいいって言ってるもの、何がいいのかわかんないよ！
    わかんない！私にはわかんないの！
    ブラッディって何がカッコイイの？血なんて嫌だよ！痛いだけだよ！
    狂うのどこがカッコイイの？クレイジーのどこがいいのかわかんない！
  </Highlight>
</Text>

Customize the Rendered Element

By using useHighlight, you can customize multiple elements and their styles.

const chunks = useHighlight({
  query: ["わかんない", "ジュー君"],
  text: " わかんないよ…。わっかんないよ！ ジュー君の言ってることはひとつもわかんないよ！ ジュー君がいいって言ってるもの、何がいいのかわかんないよ！ わかんない！私にはわかんないの！ ブラッディって何がカッコイイの？血なんて嫌だよ！痛いだけだよ！ 狂うのどこがカッコイイの？クレイジーのどこがいいのかわかんない！",
})

return (
  <Text>
    {chunks.map(({ match, text }, index) =>
      match ? (
        text === "わかんない" ? (
          <Mark key={index} colorScheme="warning">
            {text}
          </Mark>
        ) : (
          <Mark key={index} colorScheme="success">
            {text}
          </Mark>
        )
      ) : (
        text
      ),
    )}
  </Text>
)

If you use this code, you need to add "use client" to the top of the file.

Props

Prop	Default	Type / Description
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`children`	-	`string` The text used for searching.
`query`	-	`string \| string[]` Can be a single string or an array of strings. These are the terms that are highlighted in the text.
`align`	-	`"-khtml-center" \| "-khtml-left" \| "-khtml-right" \| "-moz-center" \| "-moz-initial" \| "-moz-left" \| "-moz-right" \| "-webkit-center" \| "-webkit-left" \| "-webkit-match-parent" ...` The CSS `text-align` property.
`casing`	-	`"-moz-initial" \| "capitalize" \| "full-size-kana" \| "full-width" \| "inherit" \| "initial" \| "lowercase" \| "math-auto" \| "none" \| "revert-layer" ...` The CSS `text-transform` property.
`decoration`	-	`"-moz-initial" \| "AccentColor" \| "AccentColorText" \| "ActiveBorder" \| "ActiveCaption" \| "ActiveText" \| "aliceblue" \| "antiquewhite" \| "AppWorkspace" \| "aqua" ...` The CSS `text-decoration` property.
`fragment`	`false`	`boolean` If `true`, `Fragment` is used for rendering.
`markProps`	-	`MarkProps` Properties passed to the Mark component which is used to highlight the matched terms.

Similar Components

Text is a component that represents a paragraph of text. By default, it renders a p element.

Mark is a component that emphasizes a specific part of the text.

Kbd is a component that represents keyboard input.

Heading is a component that represents section headings. By default, it renders an h1 element.

Em is a component that represents emphasized text. By default, it renders a em element.

Code is a component that represents a code block. By default, it renders a code element.

Blockquote is a component that represents a quotation. By default, it renders a blockquote element.

Link is a component for creating hyperlinks to different web pages, locations within the same page, or other URLs.

Uses Components & Hooks

Mark is a component that emphasizes a specific part of the text.

Text is a component that represents a paragraph of text. By default, it renders a p element.