Home

Awesome

vue-highlight-text

NPM version NPM downloads Build Status

Vue component for highlight multiple instances of a word

Installation

# with yarn
yarn add vue-highlight-text

# with npm
npm install --save vue-highlight-text

Use component

import Vue from 'vue';
import HighlightText from 'vue-highlight-text';

Vue.component('HighlightText', HighlightText);

Use directive

import Vue from 'vue';
import highlight from 'vue-highlight-text/public/directive.min.js';

Vue.directive('highlight', highlight);

In file vue

<!-- component -->
<HighlightText :keyword="keyword" :sensitive="sensitive">{{msg}}</HighlightText>
<!-- Directive -->
<span v-highlight="{keyword: keyword}">{{msg}}</span>

Props or value of directive

NameTypeDefaultDescription
keywordstring''word for highlight in message.
sensitivebooltruehighlight with case sensitive
overWriteStyleObject{color: '#00C1E8'}custom highlight for overwrite style by HTML DOM Style Object