Version 3.18.1
Show:

Highlight Class

Module: highlight-base
Parent Module: highlight

Provides methods for highlighting strings within other strings by wrapping them in HTML.

The highlight methods first escape any special HTML characters in the input strings and then highlight the appropriate substrings by wrapping them in a <b class="yui3-highlight"></b> element. The <b> element is used rather than <strong> in accordance with HTML5's definition of <b> as being purely presentational, which is exactly what highlighting is.

Item Index

Methods

Properties

Methods

all

(
  • haystack
  • needles
  • [options]
)
String static

Highlights all occurrences in the haystack string of the items in the needles array, regardless of where they occur. The returned string will have all HTML characters escaped except for the highlighting markup.

Parameters:

  • haystack String

    String to apply highlighting to.

  • needles String | String[]

    String or array of strings that should be highlighted.

  • [options] Object optional

    Options object.

    • [caseSensitive=false] Boolean optional

      If true, matching will be case-sensitive.

    • [startsWith=false] Boolean optional

      If true, matches must be anchored to the beginning of the string.

Returns:

String:

Escaped and highlighted copy of haystack.

allCase

(
  • haystack
  • needles
  • [options]
)
String static

Same as all(), but case-sensitive by default.

Parameters:

  • haystack String

    String to apply highlighting to.

  • needles String | String[]

    String or array of strings that should be highlighted.

  • [options] Object optional

    Options object. See all() for details.

Returns:

String:

Escaped and highlighted copy of haystack.

allFold

(
  • haystack
  • needles
  • [options]
)
String static

Accent-folding version of all().

Parameters:

  • haystack String

    String to apply highlighting to.

  • needles String | String[]

    String or array of strings that should be highlighted.

  • [options] Object optional

    Options object.

    • [startsWith=false] Boolean optional

      If true, matches must be anchored to the beginning of the string.

Returns:

String:

Escaped and highlighted copy of haystack.

start

(
  • haystack
  • needles
  • [options]
)
String static

Highlights needles that occur at the start of haystack. The returned string will have all HTML characters escaped except for the highlighting markup.

Parameters:

  • haystack String

    String to apply highlighting to.

  • needles String | String[]

    String or array of strings that should be highlighted.

  • [options] Object optional

    Options object.

    • [caseSensitive=false] Boolean optional

      If true, matching will be case-sensitive.

Returns:

String:

Escaped and highlighted copy of haystack.

startCase

(
  • haystack
  • needles
)
String static

Same as start(), but case-sensitive by default.

Parameters:

  • haystack String

    String to apply highlighting to.

  • needles String | String[]

    String or array of strings that should be highlighted.

Returns:

String:

Escaped and highlighted copy of haystack.

startFold

(
  • haystack
  • needles
)
String static

Accent-folding version of start().

Parameters:

  • haystack String

    String to apply highlighting to.

  • needles String | String[]

    String or array of strings that should be highlighted.

Returns:

String:

Escaped and highlighted copy of haystack.

words

(
  • haystack
  • needles
  • [options]
)
String static

Highlights complete words in the haystack string that are also in the needles array. The returned string will have all HTML characters escaped except for the highlighting markup.

Parameters:

  • haystack String

    String to apply highlighting to.

  • needles String | String[]

    String or array of strings containing words that should be highlighted. If a string is passed, it will be split into words; if an array is passed, it is assumed to have already been split.

  • [options] Object optional

    Options object.

    • [caseSensitive=false] Boolean optional

      If true, matching will be case-sensitive.

Returns:

String:

Escaped and highlighted copy of haystack.

wordsCase

(
  • haystack
  • needles
)
String static

Same as words(), but case-sensitive by default.

Parameters:

  • haystack String

    String to apply highlighting to.

  • needles String | String[]

    String or array of strings containing words that should be highlighted. If a string is passed, it will be split into words; if an array is passed, it is assumed to have already been split.

Returns:

String:

Escaped and highlighted copy of haystack.

wordsFold

(
  • haystack
  • needles
)
String static

Accent-folding version of words().

Parameters:

  • haystack String

    String to apply highlighting to.

  • needles String | String[]

    String or array of strings containing words that should be highlighted. If a string is passed, it will be split into words; if an array is passed, it is assumed to have already been split.

Returns:

String:

Escaped and highlighted copy of haystack.

Properties

_REGEX

String protected final static

Regular expression template for highlighting a match that occurs anywhere in a string. The placeholder %needles will be replaced with a list of needles to match, joined by | characters.

This regex should have two capturing subpatterns:

  1. Zero or one unclosed HTML entity (e.g. "&amp" without a ";" at the end).
  2. The %needles placeholder.

The first subpattern match is used to emulate a negative lookbehind assertion in order to prevent highlighting inside HTML entities.

_REPLACER

Function | String protected final static

Regex replacer function or string for normal matches.

_START_REGEX

String protected final static

Regular expression template for highlighting start-of-string matches (i.e., only matches that occur at the beginning of a string). The placeholder %needles will be replaced with a list of needles to match, joined by | characters.

See _REGEX for a description of the capturing subpatterns this regex string should contain.

_TEMPLATE

String protected final static

Highlight template which will be used as a replacement for matched substrings. The placeholder {s} will be replaced with the matched substring.

Default: '<b class="yui3-highlight">{s}</b>'