range-lookup
v0.2.0
Published
Find matching DOM ranges for a given text string
Downloads
22
Maintainers
Readme
range-lookup
Find all matching DOM ranges for a given text string.
Example
var rangeLookup = require('range-lookup');
var ranges = rangeLookup('some string');
ranges
//=> Array [ Range, Range, Range, Range ]
// Highlight ranges.
var selection = window.getSelection();
ranges.forEach(selection.addRange.bind(selection));
API
rangeLookup(query, [opts])
query
— string to search for.
Returns array of matching ranges.
opts.ignoreCase
Whether to ignore case while attempting a match in a string. Defaults to false
.
Limitations
- This module is not capable of matching text that crosses text nodes boundaries.
Install
npm install range-lookup
License
MIT