@neosjs/highlight
关键词高亮组件。在一个字符串中查找一个或多个关键词,命中的部分用指定标签包裹并以高亮样式展示,支持正则转义、大小写敏感与自定义标签。
安装
sh
pnpm add @neosjs/highlightsh
npm i @neosjs/highlightsh
yarn add @neosjs/highlight快速上手
keywords 必填,支持字符串或字符串数组;sourceString 为要处理的原文。
vue
<script setup lang="ts">
import { Highlight } from '@neosjs/highlight'
import { ref } from 'vue'
const sourceString = ref('NeosJS 是一套 Vue3 组件库,NeosJS 组件轻量好用。')
const keywords = ref('NeosJS')
</script>
<template>
<Highlight :keywords="keywords" :source-string="sourceString" />
</template>多关键词与大小写
vue
<Highlight
:keywords="['vue3', '组件库']"
source-string="基于 vue3 的组件库"
:case-sensitive="true"
highlight-class="my-highlight"
/>TIP
auto-escape 默认开启,关键词中的正则特殊字符(如 . * ?)会被转义,按普通文本匹配;多个关键词命中区间重叠时会自动合并为一个高亮块。
Props
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| keywords | string | string[] | 必填 | 要高亮的关键词 |
| source-string | string | '' | 原始文本 |
| auto-escape | boolean | true | 是否转义关键词中的正则特殊字符 |
| case-sensitive | boolean | false | 匹配是否区分大小写 |
| highlight-class | string | — | 高亮部分的类名 |
| unhighlight-class | string | — | 非高亮部分的类名 |
| highlight-tag | string | 'span' | 高亮部分使用的标签 |
| unhighlight-tag | string | 'span' | 非高亮部分使用的标签 |
| tag | string | 'div' | 最外层容器标签 |