Skip to content

@neosjs/highlight ​

关键词高亮组件。在一个字符串中查找一个或多个关键词,命中的部分用指定标签包裹并以高亮样式展示,支持正则转义、大小写敏感与自定义标签。

安装 ​

sh
pnpm add @neosjs/highlight
sh
npm i @neosjs/highlight
sh
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 ​

参数类型默认值说明
keywordsstring | string[]必填要高亮的关键词
source-stringstring''原始文本
auto-escapebooleantrue是否转义关键词中的正则特殊字符
case-sensitivebooleanfalse匹配是否区分大小写
highlight-classstring—高亮部分的类名
unhighlight-classstring—非高亮部分的类名
highlight-tagstring'span'高亮部分使用的标签
unhighlight-tagstring'span'非高亮部分使用的标签
tagstring'div'最外层容器标签