README.md

Word Highlighter

This is NOT a highlight.js plugin.

<pre style="background-color: #eee;">
  <code class="word-highlighter">
    #1{Hello}, #2{dark}#3{ness}, my #4{old friend}
    #5{I}#6{'}#7{ve} #8{com}#9{e} #10{to} #11{ta}#12{lk wi}#13{th} #14{you} #15{ag}#16{ain}
  </code>
</pre>

Usage

Download the minified script from github releases

Add this to your HTML

<script src="/path/to/word-highlighter.min.js"></script>

Or require as common modules

const wordHighlighter = require('word-highlighter');
wordHighlighter.registerColors([
  '#ff0000',
  '#00ff00',
  '#0000ff',
])
const html = wordHighlighter.renderHtml('#1{Hello} #5{World}'); // ((5 - 1) % 3) + 1) = 2 (Out of bounds safe)
// outputs <span class="word-highlighter-1">Hello</span> <span class="word-highlighter-2">World</span>
const css = wordHighlighter.generateCss();
// outputs .word-highlighter-1 {color: '#ff0000'} .word-highlighter-2 {color: '#00ff00'} .word-highlighter-3 {color: '#0000ff'}

Rerendering

Call window.wordHighlighterRender() to rerender the highlighting on the page. It is useful if you are making dynamic content.

Run npm run build and checkout build/index.html for a working demo.