{"_id":"jquery-highlight","_rev":"9-1d6c6a6ec7b0e041e7c5a9b5b96df279","name":"jquery-highlight","description":"Text highlighting plugin for jQuery","dist-tags":{"latest":"3.5.0"},"versions":{"3.2.2":{"name":"jquery-highlight","version":"3.2.2","description":"Text highlighting plugin for jQuery","main":"jquery.highlight.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git://github.com/knownasilya/jquery-highlight.git"},"keywords":["jquery","highlight","keywords"],"author":"","license":"MIT","bugs":{"url":"https://github.com/knownasilya/jquery-highlight/issues"},"homepage":"https://github.com/knownasilya/jquery-highlight","dependencies":{"jquery":">= 1.0.0"},"_id":"jquery-highlight@3.2.2","_shasum":"9a5bca2662edd9a9fbafb8e27adecbb1776d2603","_from":".","_npmVersion":"1.4.7","_npmUser":{"name":"knownasilya","email":"ilya@burstcreations.com"},"maintainers":[{"name":"knownasilya","email":"ilya@burstcreations.com"}],"dist":{"shasum":"9a5bca2662edd9a9fbafb8e27adecbb1776d2603","tarball":"https://registry.npmjs.org/jquery-highlight/-/jquery-highlight-3.2.2.tgz","integrity":"sha512-CK/UFp1/+Ohlk664GE0O5JL6jlnk0CyAEJX+TScKQI9ZBJKTgpeapzCQvQ7EW275HVDHjrBZWQgbOidBf6w47A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDhO6AfvrIIe8GGGL0prNylgsnjSq0WPuriynGpPWAGJAiEAoiaVPCYFNUk+vrVnWzEijMfAqf4lS2IAb1uSF4VIfnA="}]},"directories":{}},"3.3.0":{"name":"jquery-highlight","version":"3.3.0","description":"Text highlighting plugin for jQuery","main":"jquery.highlight.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git://github.com/knownasilya/jquery-highlight.git"},"keywords":["jquery","highlight","keywords"],"author":"","license":"MIT","bugs":{"url":"https://github.com/knownasilya/jquery-highlight/issues"},"homepage":"https://github.com/knownasilya/jquery-highlight","dependencies":{"jquery":">= 1.0.0"},"gitHead":"f8feab8e94d0a379814dcd17a9df40967ba7dcc4","_id":"jquery-highlight@3.3.0","_shasum":"d4493334f26964a5c3ad15116f0af5e943d39276","_from":".","_npmVersion":"2.11.1","_nodeVersion":"2.3.0","_npmUser":{"name":"knownasilya","email":"ilya@burstcreations.com"},"maintainers":[{"name":"knownasilya","email":"ilya@burstcreations.com"}],"dist":{"shasum":"d4493334f26964a5c3ad15116f0af5e943d39276","tarball":"https://registry.npmjs.org/jquery-highlight/-/jquery-highlight-3.3.0.tgz","integrity":"sha512-PkPMthboidQ6hEGqOst+qewXlOu6X1Mmqx0b2rCb0vIhNGROfbQhhbhA0XU6zED0lM8+MBXcBmAn8RqJmRP2Wg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICcA1ubfaEZMRiMFV5u3bzMWLOJcl0Klh+gJPM63ZQzVAiEA+tbfJdUbZINZb4tCJ9xYL1yhK/+PoGPkoVtCFliBF20="}]},"directories":{}},"3.4.0":{"name":"jquery-highlight","version":"3.4.0","description":"Text highlighting plugin for jQuery","main":"jquery.highlight.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","release":"standard-version"},"repository":{"type":"git","url":"git://github.com/knownasilya/jquery-highlight.git"},"keywords":["jquery","highlight","keywords"],"author":"","license":"MIT","bugs":{"url":"https://github.com/knownasilya/jquery-highlight/issues"},"homepage":"https://github.com/knownasilya/jquery-highlight","dependencies":{"jquery":">= 1.0.0"},"gitHead":"8c7723ec0fa3433dbab7d7405c1d4be8d448bead","_id":"jquery-highlight@3.4.0","_shasum":"05cc0e765477838a98c60f542e3d5dc319742f87","_from":".","_npmVersion":"3.10.10","_nodeVersion":"6.9.4","_npmUser":{"name":"knownasilya","email":"ilya@burstcreations.com"},"dist":{"shasum":"05cc0e765477838a98c60f542e3d5dc319742f87","tarball":"https://registry.npmjs.org/jquery-highlight/-/jquery-highlight-3.4.0.tgz","integrity":"sha512-h90OY2BU2Oqtg+uOb3yPoKyPEhFBCxulHwjFvHf9Pwje0ic1A2BAAV5afYk2MCCy2zsm6c0Vx/J5aWGUtOFe7w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBX/fzsRM1WnL023j6vnpMJuuxKRCWsZr4sWUXFCzVcvAiEA++FpqVaGjqtm8kfjtRkGbkCeMBRtJckq9jdOwGBGdI8="}]},"maintainers":[{"name":"knownasilya","email":"ilya@burstcreations.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/jquery-highlight-3.4.0.tgz_1489292992362_0.8258900013752282"},"directories":{}},"3.5.0":{"name":"jquery-highlight","version":"3.5.0","description":"Text highlighting plugin for jQuery","main":"jquery.highlight.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","release":"standard-version"},"repository":{"type":"git","url":"git://github.com/knownasilya/jquery-highlight.git"},"keywords":["jquery","highlight","keywords"],"author":"","license":"MIT","bugs":{"url":"https://github.com/knownasilya/jquery-highlight/issues"},"homepage":"https://github.com/knownasilya/jquery-highlight","dependencies":{"jquery":">= 1.0.0"},"devDependencies":{"standard-version":"^4.4.0"},"gitHead":"7f01bf5dad7bfc8dd309b3905927d24df31e4e3b","_id":"jquery-highlight@3.5.0","_npmVersion":"6.4.1","_nodeVersion":"10.11.0","_npmUser":{"name":"knownasilya","email":"ilya@burstcreations.com"},"dist":{"integrity":"sha512-5gzRomQyy3n/byb2G5zhbavdiXcPZ6rAWXtU5FgdEvguDEn90kMm9/QARY3zdKhH/+tfqqu9GNKocbMGf7ThNg==","shasum":"354fb3a8b98c594525ec1ccc003fd3d1dc305815","tarball":"https://registry.npmjs.org/jquery-highlight/-/jquery-highlight-3.5.0.tgz","fileCount":10,"unpackedSize":21083,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcTnSiCRA9TVsSAnZWagAAJaIQAJ+/ijlXppbnC1WpjGKv\n4jTdL4U6KPlzFLWisIzwrRMZnjy2ZUx6Bt9hG6AmQPoJOh8MtOX37Ah2WtpI\ni+RWwLVP/OfN98fJHj73ftE7E6NXWcsfvXurzjczio/6sva3aqq9/YgNIDOY\n3+z9Vx2Q/eoOSVDipFWNiGLVPxXu1xMfy96yIc7MzPO933UFH7Em7j6ErZ8i\ndtW692M6RmB3aKRhQZdNmKpZL5TEI5hmdTvcdMZB85NVqEzFbNoFmt5jKspK\nPPAchb8ZDkL9jLuVblQQDJa8HQEj7WH6mXwpvnvTqx8sSx0NXNmNDjxpCIjG\n6tWmqJ+WHWckWE5gZhfg1sUO6UrmmGLji/C6vCPXRS83kIJrAJGeAQRQVARV\np3MqUR48fkEiZKe2ISZCa9REtzkz0YdrtXiePam46wyOpOTH7o3s7UCuZ/Xo\nXuTsJ56zLG35nuaU9a/AyUYtvfqbFKPvoqGop7mSFZAGNmV6Y/oYNd5mSoNn\n0GXg23ehzx2biDHDoZLo/NmFjvCJ8z2vtf9Bmtrfp1asNgIjwicvxd/P9I77\n+00QhPK98U3og4Q4cm147o3mfY18JQm5xlyW8sl+8uBgthnNKpZgj1MSnKWa\nRBbljT+ofo3asza5QIdt4tJ16AXZWqhyb/FKr/z2eQjxJL9YhXfj4TmkxKQh\njGBy\r\n=KyMX\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGyleY2ptFBcFqSeY2to6BMikd3pU0AbqWQxLZY4iHR+AiAxvj3zhCBALqETc+dnkLgrrsxvYAMS2bhbdYAVE3FyLw=="}]},"maintainers":[{"name":"knownasilya","email":"ilya@burstcreations.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/jquery-highlight_3.5.0_1548645537209_0.41459976913915164"},"_hasShrinkwrap":false}},"readme":"jQuery.Highlight.js\n===================\n\nText highlighting plugin for jQuery.\n\nOriginal [code][1] and [documentation][2].\n\n- [Install](#install)\n- [API](#api)\n- [Examples](#examples)\n- [Attribution](#attribution)\n\n## Install\n\nHow to use this plugin.\n\n_Note: This plugin requires jQuery to be included, which is left up to you._\n\nFirst you need to install the module, which can be installed in one\nof the following ways:\n\n```bash\nnpm install jquery-highlight\nbower install jquery-highlight\ncomponent install knownasilya/jquery-highlight\n# or just download it from Github\n```\n\n## API\n\n### `$.highlight`\n\nFunction signature: `highlight(word, options, callback)`\n\nThe parameters are:\n\n  **word** `string|array` (required)\n  \n  string such as `\"lorem\"` or `\"lorem ipsum\"` or an array of string such as `[\"lorem\", \"ipsum\"]` \n  \n  **options** `object` (optional)\n  \n  object with the following available options\n\n   * `className` -- The CSS class of a highlighted element, defaults to 'highlight'.\n   * `element` -- The element that wraps the highlighted word, defaults to 'span'.\n   * `caseSensitive` -- If the search should be case sensitive, defaults to `false`.\n   * `wordsOnly` -- If we want to highlight partial sections of a word, e.g. 'ca' from 'cat', defaults to `false`.\n   * `wordsBoundary` -- If `wordsOnly` is set to `true`, this is used to determine these boundaries, defaults to `\\\\b` (word boundary).\n   * `wordsBoundaryStart` -- If `wordsOnly` is set to `true`, this is used to determine prefix word boundaries, defaults to the value of `wordsBoundary`.\n   * `wordsBoundaryEnd` -- If `wordsOnly` is set to `true`, this is used to determine suffix word boundaries, defaults to the value of `wordsBoundary`.\n    \n**callback** `function` (optional)\n\nfunction that will be called for each DOM node/element highlighted\n  \n\n### `$.unhighlight`\n\nFunction signature: `unhighlight(options)`:\n\nThe parameters are:\n\n**options** `object` (optional)\n\n  object with the following available options\n\n  * `className`  -- The highlights to remove based on CSS class, defaults to 'highlight'.\n  * `element` -- The highlights to remove based on HTML element, defaults to 'span'.\n\n## Examples\n\nBelow are several ways that you can utilize this plugin.\n\n```js\n// wrap every occurrence of text 'lorem' in content\n// with <span class='highlight'> (default options)\n$('#content').highlight('lorem');\n\n// search for and highlight more terms at once\n// so you can save some time on traversing DOM\n$('#content').highlight(['lorem', 'ipsum']);\n$('#content').highlight('lorem ipsum');\n\n// wrap every occurrence of text 'lorem' in content\n// with <span class='highlight'> (default options)\n// log every word highlighted to the console using the invoked callback\n$('#content').highlight('lorem', {}, function(el) {\n console.log('highligting DOM element', el)\n});\n\n// search only for entire word 'lorem'\n$('#content').highlight('lorem', {\n  wordsOnly: true\n});\n\n// search only for the entire word 'C#'\n// and make sure that the word boundary can also\n// be a 'non-word' character, as well as a regex latin1 only boundary:\n$('#content').highlight('C#', {\n  wordsOnly: true,\n  wordsBoundary: '[\\\\b\\\\W]'\n});\n\n// search only for the entire word 'C++'\n// and make sure that the word boundary can also\n// be a 'non-word' character, as well as a regex latin1 only boundary:\n$('#content').highlight('C++', {\n  wordsOnly: true,\n  wordsBoundaryEnd: '\\\\W*\\\\b'\n});\n\n\n// don't ignore case during search of term 'lorem'\n$('#content').highlight('lorem', {\n  caseSensitive: true\n});\n\n// wrap every occurrance of term 'ipsum' in content\n// with <em class='important'>\n$('#content').highlight('ipsum', {\n  element: 'em',\n  className: 'important'\n});\n\n// remove default highlight\n$('#content').unhighlight();\n\n// remove custom highlight\n$('#content').unhighlight({\n  element: 'em',\n  className: 'important'\n});\n```\n\n\n## Attribution\n\nPlugin was originally created by Bartek Szopka ([@bartaz][bartaz]).\n\n## License\n\nMIT\n\n[1]: https://github.com/bartaz/sandbox.js/blob/master/jquery.highlight.js\n[2]: http://bartaz.github.io/sandbox.js/jquery.highlight.html\n[bartaz]: https://github.com/bartaz\n","maintainers":[{"name":"knownasilya","email":"ilya@burstcreations.com"}],"time":{"modified":"2022-06-19T05:04:33.329Z","created":"2014-09-16T16:33:02.481Z","3.2.2":"2014-09-16T16:33:02.481Z","3.3.0":"2015-08-17T17:53:06.829Z","3.4.0":"2017-03-12T04:29:54.332Z","3.5.0":"2019-01-28T03:18:57.349Z"},"homepage":"https://github.com/knownasilya/jquery-highlight","keywords":["jquery","highlight","keywords"],"repository":{"type":"git","url":"git://github.com/knownasilya/jquery-highlight.git"},"bugs":{"url":"https://github.com/knownasilya/jquery-highlight/issues"},"license":"MIT","readmeFilename":"README.md","users":{"johnshao":true}}