当前位置：首页 > article >正文

React的文本高亮组件——React Highlight Words

article 2025/1/16 14:42:53

React Highlight Words是一个用于在文本中高亮指定单词或短语的React组件。它可以帮助你在搜索结果、文章、博客等场景中突出显示关键词。
在这里插入图片描述

安装

你可以使用npm或yarn来安装React Highlight Words：

npm install react-highlight-words

或

yarn add react-highlight-words

使用

以下是一个基本的使用示例：

import React from 'react';
import Highlighter from 'react-highlight-words';

const App = () => {
  const textToHighlight = 'The quick brown fox jumps over the lazy dog';
  const wordsToHighlight = ['fox', 'dog'];

  return (
    <Highlighter
      highlightClassName="highlight"
      searchWords={wordsToHighlight}
      autoEscape={true}
      textToHighlight={textToHighlight}
    />
  );
};

export default App;

在上面的示例中，我们首先导入了Highlighter组件。然后，我们定义了要高亮的文本和关键词。最后，我们将这些值传递给Highlighter组件，并指定了一个CSS类名（highlight）来应用于高亮的文本。

API

以下是Highlighter组件的主要属性：

textToHighlight: 要高亮的文本。
searchWords: 要高亮的关键词数组。
highlightClassName: 应用于高亮文本的CSS类名。
autoEscape: 是否自动转义特殊字符（默认为true）。
caseSensitive: 是否区分大小写（默认为false）。
unhighlightClassName: 应用于非高亮文本的CSS类名（可选）。
onHighlight: 当文本被高亮时调用的回调函数（可选）。
onUnhighlight: 当文本不再被高亮时调用的回调函数（可选）。

自定义样式

你可以通过CSS来自定义高亮文本的样式。例如：

.highlight {
  background-color: yellow;
}

高级用法

忽略某些单词

如果你想忽略某些单词不进行高亮，可以使用ignoreWords属性。例如：

<Highlighter
  ignoreWords={['the', 'and']}
  //...
/>

高亮多个关键词

如果你想高亮多个关键词，可以将它们作为数组传递给searchWords属性。例如：

<Highlighter
  searchWords={['fox', 'dog', 'quick']}
  //...
/>

处理回调函数

你可以使用onHighlight和onUnhighlight属性来处理高亮和非高亮事件。例如：

<Highlighter
  onHighlight={(highlightedWords) => console.log(highlightedWords)}
  onUnhighlight={(unhighlightedWords) => console.log(unhighlightedWords)}
  //...
/>