hit-highlighter

hit-highlighter

A small and simple hit highlighter for search engines running in the browser and Node.js. Takes a query array and where the values matches within the item array, it adds hightight code. Goes well with words'n'numbers for extracting words (and numbers) from a string of text.

Browser demo

Check out the interactive demo.

Initialize

Browser

<script src="hit-highlighter.js"></script>

<script>
  //highlight() available
</script>

Node.js

const highlight = require ('hit-highlight')
// highlight() available

Usage

hightlight([query array], [item array], {highlighting object})

query and item are arrays of words. hightlighting is an object defining start and end tag for what is highlighted.

highlighting.start defaults to <span class="highlighted"> highlighting.end defaults to </span>

Default highlighting

const query = ['interesting', 'words']
const item = ['some', 'interesting', 'words', 'to', 'remember']

highlight(query, item)

// returns:
//[
//  'some',
//  '<span class="highlighted">interesting</span>',
//  '<span class="highlighted">words</span>',
//  'to',
//  'remember'
//]

Custom highlight.start and .end

const query = ['interesting', 'words']
const item = ['some', 'interesting', 'words', 'to', 'remember']
const highlighting = { start: '**', end: '**' }

highlight(query, item, highlighting)

// returns:
//[
//  'some',
//  '**interesting**',
//  '**words**',
//  'to',
//  'remember'
//]

No hits, returing item untouched

const query = ['no', 'hits']
const item = ['some', 'interesting', 'words', 'to', 'remember']

highlight(query, item)

// returns:
//[
//  'some',
//  'interesting',
//  'words',
//  'to',
//  'remember'
//]