keyword-mark

1npm i keyword-mark

1import keywordMark from 'keyword-mark'
2
3/**
4 * This function searches for a keyword in a given content and returns the result.
5 * @param {string} content
6 * @param {string} keyword
7 * @param {Object|null} options
8 * @param {boolean} options.full - Whether to search for the full word only (default: true).
9 * @param {function} options.handle - A function to handle the search result (default: null).
10 * @param {boolean} options.ignoreCase - Whether to ignore case when searching (default: false).
11 * @param {string} options.tag - The HTML tag to wrap the search result in (default: 'em').
12 * @param {boolean} options.split (default: true).
13 * @returns {string}

14 */
15function keywordMark(content, keyword, options = null)

Example

1const content = 'Lorem ipsum dolor sit amet, consectetuer adIPiscing elit'
2const keyword = 'ip ad i'
3
4const result1 = keywordMark(content, 'ip')
5const result2 = keywordMark(content, keyword)
6const result3 = keywordMark(content, keyword, {
7  ignoreCase: true,
8})
9const result4 = keywordMark(content, keyword, {
10  full: false,
11})
12const result5 = keywordMark(content, keyword, {
13  handle(match) {
14    return `<small>${match}</small>`
15  }
16})
17const result6 = keywordMark(content, keyword, {
18  tag: 'strong'
19})
20const result7 = keywordMark(content, keyword, {
21  ignoreCase: true,
22  full: false,
23  handle(match) {
24    return `<u>${match}</u>`
25  }
26})
27
28console.log(result1)
29//Lorem <em>ip</em>sum dolor sit amet, consectetuer adIPiscing elit
30
31console.log(result2)
32//Lorem <em>ip</em>sum dolor s<em>i</em>t amet, consectetuer <em>ad</em>IP<em>i</em>sc<em>i</em>ng el<em>i</em>t
33
34console.log(result3)
35//Lorem <em>ip</em>sum dolor s<em>i</em>t amet, consectetuer <em>ad</em><em>IP</em><em>i</em>sc<em>i</em>ng el<em>i</em>t
36
37console.log(result4)
38//Lorem <em>ip</em>sum <em>d</em>olor s<em>i</em>t <em>a</em>met, consectetuer <em>ad</em>IP<em>i</em>sc<em>i</em>ng el<em>i</em>t
39
40console.log(result5)
41//Lorem <small>ip</small>sum dolor s<small>i</small>t amet, consectetuer <small>ad</small>IP<small>i</small>sc<small>i</small>ng el<small>i</small>t
42
43console.log(result6)
44//Lorem <strong>ip</strong>sum dolor s<strong>i</strong>t amet, consectetuer <strong>ad</strong>IP<strong>i</strong>sc<strong>i</strong>ng el<strong>i</strong>t
45
46console.log(result7)
47//Lorem <u>ip</u>sum <u>d</u>olor s<u>i</u>t <u>a</u>met, consectetuer <u>ad</u><u>IP</u><u>i</u>sc<u>i</u>ng el<u>i</u>t