# @brianmcallister/highlight-text 中文文档

规范地址：https://npmcn.com/package/%40brianmcallister/highlight-text/

版本：2\.0\.4
npm 元数据更新时间：2022-06-12T15:29:08.612Z
中文译文更新时间：2026-11-08T14:56:42.990Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40brianmcallister/highlight-text
原文对照：https://npmcn.com/package/%40brianmcallister/highlight-text/?lang=original
项目主页：https://highlight-text.netlify.com/
源码仓库：https://github.com/brianmcallister/highlight-text

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：35.7 kB，18 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2016-12-20T00:36:41.295Z
- 最新版本发布：2020-12-24T17:32:22.492Z
- 近 30 天下载量：11596（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 0 个）

## 中文简介

突出显示 `words` 内 `text`

## 安装

```sh
npm install @brianmcallister/highlight-text
```

也可以使用：`pnpm add @brianmcallister/highlight-text`、`yarn add @brianmcallister/highlight-text`、`bun add @brianmcallister/highlight-text`

## README

# @brianmcallistor/ 高亮文本

[![codecov](https://codecov.io/gh/brianmcallister/highlight-text/branch/master/graph/badge.svg)](https://codecov.io/gh/brianmcallister/highlight-text) [![CircleCI](https://circleci.com/gh/brianmcallister/highlight-text.svg?style=svg)](https://circleci.com/gh/brianmcallister/highlight-text) [![npm version](https://img.shields.io/npm/v/@brianmcallister/highlight-text?label=version&color=%2354C536&logo=npm)](https://www.npmjs.com/package/@brianmcallister/highlight-text)

> 突出显示 `words` 在一些 `text`

`highlight-text` 使字符和单词在字符串中快速地突出。 此库主要用于在网页中的任何文本中添加可视化指标,这与您浏览器中的默认搜索功能大相径庭.

这是突出从您应用程序中的输入字段收集的搜索结果或一系列可能的使用案例的好方法:

-   用户在聊天程序中配置搜索条件
-   管理员配置通知
-   视觉设计元素

默认情况下,库会接受一个字符串和一些子字符串进行搜索. 它会返回周围所有找到的字符串 [`<mark>` 标记](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark),然后它可以被样式 与你的品牌。 这是可配置的, 以防你想使用任意的字符串或 HTML 标记 .

## 目录

-   [演示](https://npmcn.com/package/%40brianmcallister/highlight-text/#readme-demo)
-   [安装](https://npmcn.com/package/%40brianmcallister/highlight-text/#readme-installation)
-   [使用量](https://npmcn.com/package/%40brianmcallister/highlight-text/#readme-usage)
-   [API 密码](https://npmcn.com/package/%40brianmcallister/highlight-text/#readme-api)
    -   [`highlightText`](https://npmcn.com/package/%40brianmcallister/highlight-text/#readme-highlighttext)

## 演示

主机演示 : [https://highlight-text.netlify.com/ 互联网档案馆的存檔,存档日期2013-12-21](https://highlight-text.netlify.com/)

也可以在本地运行演示. 要开始 :

```sh
git clone git@github.com:brianmcallister/highlight-text.git
cd highlight-text/demo
npm i
npm start
```

###### [高级](https://npmcn.com/package/%40brianmcallister/highlight-text/#readme-table-of-contents)

## 安装

```sh
npm install @brianmcallister/highlight-text
```

###### [高级](https://npmcn.com/package/%40brianmcallister/highlight-text/#readme-table-of-contents)

## 使用量

```js
import highlightText from '@brianmcallister/highlight-text';

highlightText('some text', ['om', 'ex']);
// #=> 's<mark>om</mark>e t<mark>ex</mark>t'
```

###### [高级](https://npmcn.com/package/%40brianmcallister/highlight-text/#readme-table-of-contents)

## API 密码

### `highlightText`

这是默认导出 。 3⁄4 ̄ ̧漯B.

```js
highlightText(text: string, words: string[]): string;
```

###### [高级](https://npmcn.com/package/%40brianmcallister/highlight-text/#readme-table-of-contents)

## 常见问题

### @brianmcallister/highlight-text 是什么？

突出显示 words 内 text

### 如何安装 @brianmcallister/highlight-text？

在项目目录运行 npm install @brianmcallister/highlight-text，或使用 pnpm add / yarn add / bun add。

### @brianmcallister/highlight-text 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/brianmcallister\_\_highlight-text 是否存在。

### @brianmcallister/highlight-text 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @brianmcallister/highlight-text 可以商用吗？

@brianmcallister/highlight-text 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @brianmcallister/highlight-text 的下载量有多少？

根据 npm 官方下载统计，@brianmcallister/highlight-text 在 2026/10/09 – 2026/11/07 这 30 天内被下载 11,596 次，日均约 387 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @brianmcallister/highlight-text 还在维护吗？

最新版本 2\.0\.4 发布于 2020/12/25（5 年前）；至今共发布 13 个版本，其中过去 12 个月发布了 0 个；首次发布于 2016/12/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。