mark() method

Syntax

// javascript
const instance = new Mark(context);
instance.mark(search[, options]);
// jQuery
$(context).mark(search[, options]);

Parameters:

search string or string[] - string or array of strings
options object - Optional options:

Option	Type	Default	Description
`element`	string	`mark`	A custom mark element e.g. `span`.
`className`	string	`''`	A custom class to be added to mark elements.
`exclude`	string or string[]	`[]`	A string or an array of selectors. Specifies DOM elements that should be excluded from searching. See exclude option for more details.
`separateWordSearch`	boolean or string	`true`	A boolean value `true` specifies to break term(s) into separate words and search for each individual word. A string value `'preserveTerms'` preserved term(s) surrounding by double quotes from breaking into separate words. See separateWordSearch option for more details.
`diacritics`	boolean	`true`	Whether to match diacritic characters
`caseSensitive`	boolean	`false`	Whether to search case sensitive
`accuracy`	string or object	`'partially'`	Either one of the following string value: `'partially'` e.g. searching 'a' mark 'a' in words 'and', 'back', and 'visa'. `'exactly'` This option is actually forced to use an accuracy object, because the default word boundaries are white spaces and start/end of a text node content (with `acrossElements` option - start/end of a context). `'startsWith'` e.g. searching 'pre' mark the whole words 'prefix', 'predict', and 'prefab'. `'complementary'` e.g. searching 'a' mark the whole words 'and', 'back', and 'visa'. The built-in boundaries for values `startsWith` and `complementary` are: white spaces and !"#$%&'`()+,-./:;<=>?@[\]^_{\|}~¡¿ characters. Or an object* with two properties: `value`: `'exactly'` or `'startsWith'` or `'complementary'` `limiters`: a string or an array of custom word boundary characters, e.g. `{ value : "exactly", limiters : ",.;:?!'\"()" }`
`wildcards`	string	`disabled`	Two characters `?` and `` used as wildcards unless they are escaped `disabled`: The characters `?` and `` match itself `enabled`: The character `?` match any non-white-space character zero or one time. The character `` match any non-white-space character zero or more times. `withSpaces`: The character `?` match any character zero or one time. The character `` match any character zero or more times, but as few times as possible.
`ignoreJoiners`	boolean	`false`	Whether to find matches that contain soft hyphen, zero width space, zero width non-joiner and zero width joiner
`ignorePunctuation`	string or string[]	`[]`	A string or an array of punctuation characters
`synonyms`	object	`{}`	An object with synonyms e.g. `{ 'one': '1' }` - '1' is synonym for 'one' and vice versa. The value can be an array, e.g. `{ 'be': ['am', 'is', 'are'] }`.
`acrossElements`	boolean	`false`	Whether to search for matches across elements See acrossElements option for more details.
`combinePatterns`	number or boolean	`10`	Combine a specified number of individual term patterns into one See Performance for more details.
`cacheTextNodes`	boolean	`undefined`	Caching information to improve performance See Performance for more details.
`blockElementsBoundary`	boolean or object	`undefined`	Whether to limit matches within default HTML block elements and/or custom elements See Elements boundaries for more details. `tagNames` string[] - An array of custom HTML tag names `extend` boolean - `true` extends default boundary elements by the custom elements otherwise only the custom elements do have boundaries `char` string - A custom boundary character. The default is `\x01`.
`shadowDOM`	boolean	`undefined`	Whether to mark inside shadow DOMs See Highlighting in shadow DOM for more details.
`iframes`	boolean	`false`	Whether to mark inside iframes
`iframesTimeout`	number	`5000` ms	The max time to wait for iframe(s) to load before skipping
`debug`	boolean	`false`	Whether to log messages
`log`	object	`console`	Log messages to a specific object
`filter`	function		A callback to filter matches. It calls for each match (with `acrossElements` option, if the match is located across several elements, it calls for each text node which is part of the match) filter : (textNode, term, matchesSoFar, termMatchesSoFar, filterInfo) => {} `textNode` Text - The text node which includes the match or with `acrossElements` option can be part of the match `term` string - The current term `matchesSoFar` number - The number of all wrapped matches so far `termMatchesSoFar` number - The number of wrapped matches for the current term so far `filterInfo` object: `match` array - The result of RegExp exec() method `matchStart` boolean - indicate the start of a match AE `execution` object - The helper object for early abort: `abort` boolean - Setting it to `true` breaks method execution `offset` number - When 'acrossElements: false': the absolute start index of a text node in joined context. When 'acrossElements: true': the sum of the lengths of separated spaces or boundary strings that were added to the composite string so far. The function must return either `true` (to wrap) or `false` (to skip wrapping mark element). See Filtering matches for more details.
`each`	function		A callback for each marked element each : (markElement, eachInfo) => {} `markElement` HTMLElement - The marked DOM element `eachInfo` object: `match` array - The result of RegExp exec() method `matchStart` boolean - Indicate the start of a match AE `count` number - The number of wrapped matches so far See Code examples.
`done`	function		A callback on finish done : (totalMarks, totalMatches, termStats) => {} `totalMarks` number - The total number of marked elements `totalMatches` number - The total number of matches `termStats` object - An object containing an individual term's matches count
`noMatch`	function		A callback that is called when a term has no match at all noMatch : (term) => {} `term` string or string[] - The not found term(s); the parameter is an array when `combinePatterns` option is used

Available properties of the `filterInfo` object depending on options

options	match	matchStart	execution	offset
acrossElements: true	+	+	+	+
acrossElements: false	+	-	+	+

Available properties of the `eachInfo` object depending on options

options	match	matchStart	count
acrossElements: true	+	+	+
acrossElements: false	+	-	+

Example with default options values

const options = {
    element : 'mark',
    className : '',
    separateWordSearch : true,
    diacritics : true,
    exclude : [],
    caseSensitive : false,
    accuracy : 'partially',
    synonyms : {},
    ignoreJoiners : false,
    ignorePunctuation : [],
    wildcards : 'disabled',
    
    acrossElements : false,
    combinePatterns : false,
    cacheTextNodes : false,
    blockElementsBoundary : false,
    
    shadowDOM : false,
    iframes : false,
    iframesTimeout : 5000,
    
    filter : (textNode, term, marksSoFar, termMarksSoFar, filterInfo) => {
        return true; // must return either true or false
    },
    each : (markElement, eachInfo) => {},
    done : (totalMarks, totalMatches, termStats) => {},
    noMatch : (term) => {},
    debug : false,
    log : window.console
};

JavaScript:

var instance = new Mark(document.querySelector('selector'));
instance.mark('test', options);

jQuery:

$('selector').mark('test', options);

AE - only available when acrossElements option is set to true

mark() method

Syntax

Parameters:

Available properties of the filterInfo object depending on options

Available properties of the eachInfo object depending on options

Available properties of the `filterInfo` object depending on options

Available properties of the `eachInfo` object depending on options