makoconstruct / clevermatcher Goto Github PK

##CleverMatcher

CleverMatcher is (or at least as a stone soup, aspires to be) an extremely efficient fuzzy text search for applications with autocompletion widgets. It's largely inspired by Sublime Text's autocompletion behavior, having a developed preference for matching acronym shorthands to their expansions.

CleverMatcher wants you to type in shorthand. CleverMatcher will always understand.

###Example

var ms = matchset([
  ['Binding Lantern Smith', 0],
  ['Hopeful Woods', 1],
  ['blustery_green', 2],
  ['Holy Sword', 3]
]);

ms.seek('bl');

yields

[ { score: 15,
    key: 0,
    text: 'Binding Lantern Smith' },
  { score: 11,
    key: 2,
    text: 'blustery_green' } ]

###API If no keys are specified, a text's index will be injected as its key

var ms = matchset(['Binding Lantern Smith', 'Hopeful Woods', 'blustery_green', 'Holy Sword']);

This matchset will be equivalent to the above

You can control the number of results you'll get, and have CleverMatcher give you match html text that highlights the leters matched.

var ms = matchset(sameListAsAbove, 'hot-pink');
ms.seek('hs', 1);

returns

[ { score: 15,
    matched: '<span class="hot-pink">H</span>oly <span class="hot-pink">S</span>word',
    key: 3,
    text: 'Holy Sword' } ]