![\"Holmes.js\"](\"https://haroen.me/holmes/images/logo.png\"){kind=logo}
](https://www.npmjs.com/package/holmes.js)\n\n> Fast and easy searching inside a page.\n\n[](https://travis-ci.org/Haroenv/holmes)\n[](https://coveralls.io/github/Haroenv/holmes)\n[](https://yarnpkg.com/en/package/holmes.js)\n[](https://badge.fury.io/bo/holmes.js)\n[](https://cdnjs.com/libraries/holmes.js)\n[](https://gitter.im/Haroenv/holmes?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n[](https://david-dm.org/haroenv/holmes?type=dev)\n[](https://unpkg.com/holmes.js)\n\nHolmes filters a list of elements based on the value of a `input` in just ~2KB.\n\n## Installation\n\nYou can install Holmes with either `npm` or `bower` under the package name `holmes.js`. For `npm` that looks like this:\n\n```sh\n$ yarn add holmes.js # or via npm\n```\n\nAfter which you can add it in your page with i.e. webpack, rollup, browserify or loading the module in a different script tag.\n\nYou have to make sure that you have a `css` rule for the class `.hidden` that hides elements however you want. One option is to have this:\n\n```css\n.hidden {\n display: none;\n}\n```\n\nbut this could be any `css` you want.\n\n## Usage\n\n[demo](https://haroen.me/holmes/)\n\n### When should I use it?\n\nYou should use Holmes when \n\n- you have a limited amount of items\n- you don't need typo-tolerance\n- you only want to add a really small library\n- all items are already visible on the page\n\nIn cases where you have a more complicated expectation, I'd suggest using a service like [Algolia](https://github.com/algolia/instantsearch.js).\n\n> Fair disclosure: I currently work at Algolia, does it seem interesting? [Join us!](https://algolia.com/careers)\n\n### Simple example\n\n```js\nholmes({\n input: '.search input', // default: input[type=search]\n find: '.results div' // querySelectorAll that matches each of the results individually\n})\n```\n\n## Options\n\n[full documentation](https://haroen.me/holmes/doc)\n\n### `input`\n**default**: `input[type=search]`\n\nquerySelector for the input\n\n**examples**: `input`, `.search input`\n\n### `find` **required**\n\nquerySelectorAll for elements to search in\n\n**examples**: `blockquote p`, `.result`, `.results div`\n\n### `class`\n\n#### `class.hidden`\n**default**: `hidden`\n\nClass to add when the a `.find` doesn't contain the search query.\n\n**examples**: `hidden`, `dn`, `none`\n\n#### `class.visible`\n**default**: `false`\n\nClass to add to visible items if they contain the search query.\n\n**examples**: `visible`, `vis`, `nohidden`\n\n### `placeholder`\n**default**: `false`\n\nhtml to show when no results.\n\n**examples**: `No results
`, `Didn't find anything.`\n\n### `dynamic`\n**default**: `false`\n\nEnable this option if you want Holmes to query the value of the `.find` at every input.\n\n**examples**: `true`, `false`\n\n### `instant` :warning: DEPRECATED\n**default**: `false`\n\nThis option is deprecated. To use Holmes in an async environment, initialise it with:\n\n```js\nholmes(options).start();\n// or\nconst h = new holmes(options);\nh.start();\n```\n\nThis way it'll start immediately, just like it used to do with `instant: true`. Sorry for the inconvenience.\n\nBy default Holmes will wait on a `DOMContentLoaded` event to start searching. If you're loading the elements by `AJAX` for example this event comes too early. In that case you can enable `instant`, and start Holmes when your content is ready.\n\n**examples**: `true`, `false`\n\n### `minCharacters`\n**default**: `0`\n\nA minimum amount of characters need to be typed before Holmes starts filtering.\n\n**examples**: `2`, `5`\n\n### `mark`\n**default**: `false`\n\nTo start showing the result in a `` tag inside the `.find`, you should enable this. To change the colour this `match` is shown in, you should style the [`mark`](https://developer.mozilla.org/en/docs/Web/HTML/Element/mark) background-color.\n\n>:exclamation: this will break event listeners on nested content\n\n>:exclamation: this won't work if the character after the match is a literal `>`.\n\n>:speaking_head: If you really have to use this character, you can replace all occurences of `>` by `>`\n\n\n**examples**: `true`, `false`\n\n### `hiddenAttr`\n**default**: `true`\n\nAdds `hidden=\"true\"` to hidden elements. [Interesting link](https://www.paciellogroup.com/blog/2012/05/html5-accessibility-chops-hidden-and-aria-hidden/) explaining its use.\n\n### `shouldShow`\n\ndefault match judgment is a partial match of the input value.\n\n```js\nfunction(htmlText, search) {\n return htmlText.indexOf(search) !== -1;\n}\n```\n\nA custom matching function to be called with as first argument the text of an element,\nand as second argument the current input text. This should return true if you want the\nelement to show, and false if it needs to be hidden.\n\n```js\nvar customMatching = function(htmlText, search) {\n return search.split(/\\s+/).every(function(v, i) {\n if (htmlText.indexOf(v) === -1) {\n return false;\n }\n return true;\n });\n}\nholmes({\n shouldShow: customMatching\n})\n```\n\n### `onHidden`\n\nCallback for when an item is hidden.\n\n```js\nfunction(el) {\n console.log('hide',el);\n}\n```\n\n### `onVisible`\n\nCallback for when an item is visible again.\n\n```js\nfunction(el) {\n console.log('show',el);\n}\n```\n\n### `onEmpty`\n\nCallback for when no items were found.\n\n```js\nfunction(placeholder) {\n console.log('nothing found',placeholder);\n}\n```\n\n### `onFound`\n\nCallback for when items are found after being empty.\n\n```js\nfunction(placeholder) {\n console.log('something found',placeholder);\n}\n```\n\n### `onInput`\n\nCallback for every input.\n\n```js\nfunction(input) {\n console.log('current input',input);\n}\n```\n\n## Methods and members\n\nFor all of the methods you should initialise a new instance of Holmes like this:\n\n```js\nvar h = new holmes(options);\n```\n\nThen you can use the following methods:\n\n### `.clear()`\n\nYou can clear a holmes input programmatically, by using:\n\n```js\nh.clear();\n```\n\n### `.count()`\n\nYou can receive informations on what elements are visible, hidden and in total at any point:\n\n```js\nh.count(); // {all: 41, hidden: 34, visible: 7}\n```\n\n### `.start()`\n\nStart an even listener for the specified options. Holmes **always** has `.start()` running on initialisation.\n\n```js\nh.start();\n```\n\n### `.stop()`\n\nStops the current running event listener. Resolves a Promise when this has been completed.\n\n```js\nh.stop();\nh.start(); // could accidentally start too soon\n\nh.stop().then(h.start); // might take a small time\n```\n\n### `.hidden`\n\nThere's also a member `.hidden` that gives the count without a function call:\n\n```js\nconsole.log(h.hidden); // 34\n```\n\n### `.elements`\n\nA `NodeList` of all of the elements that holmes considers. There's also `.elementsLength` for the amount of elements and `.elementsArray` with an array of the elements.\n\n### `.input`\n\nThe input that holmes looks in. There's also the last search string as `.searchString`\n\n### `.placeholder`\n\nThe current placeholder (DOM Node).\n\n### `.running`\n\nWhether or not this instance is running.\n\n### `.options`\n\nShows the options chosen chosen for this instance of holmes. You can also set options like this after initialisation.\n\n```js\nconsole.log(h.options); // specified options\n```\n\n> note: setting options after it's running might require `h.stop().then(h.start)`\n\n### Showcase\n\nWhat|who|image\n---|---|---\n[bullg.it](https://bullg.it)|[@haroenv](https://github.com/haroenv)|![\"screenshot](\"https://haroen.me/holmes/images/screen-bullgit.gif\")
\n[family.scss](https://lukyvj.github.io/family.scss)|[@lukyvj](https://github.com/lukyvj)|![\"screenshot](\"https://haroen.me/holmes/images/screen-family.gif\")
\n[wikeo.be](https://wikeo.be)|[@bistory](https://github.com/bistory)|![\"searching](\"https://haroen.me/holmes/images/screen-wikeo.gif\")
\n[lunchbreakapp.be](https://www.lunchbreakapp.be)|[@AndreasBackx](https://github.com/AndreasBackx)|![\"searching](\"https://thumbs.gfycat.com/FancyDependentGiraffe-size_restricted.gif\")
\n\nI'd love to find out how people use my project, [let me know](https://github.com/Haroenv/holmes/issues/new?title=add+my+project+to+usages&body=who%7Cwhat%0D%0A---%7C---%0D%0A%40myusername%7C%5Bmy+project%5D%28https%3A%2F%2Flink-to-project.com%29%0D%0A%0D%0ASome+explanation+what+it+is) if you want to be featured!\n\n### Questions?\n\nCompatible up to IE11. For support of older browsers you'll need to polyfill `classList`, `addEventListener` and the `input` event with for example [remy/polyfills](https://github.com/remy/polyfills). I haven't tried this myself yet, so let me know what you used if you support older browsers!\n\nFor IE11 you need to polyfill `Object.assign` and `String.includes`, you can do that as described in [#90](https://github.com/Haroenv/holmes/issues/90)\n\nLet me know on twitter: [@haroenv](https://twitter.com/haroenv), or in an issue.\n\n## Contributing\n\nContributions are always welcome! Here are some loose guidelines:\n\n* use `feature branches`\n* don't make it slower\n* explain why you want a feature\n* `npm run doc` to recreate the documentation\n\nBuilding to a UMD is done via rollup (`npm run build`).\n\nBut I don't bite, if you have any questions or insecurities, hit me up for example on [gitter](https://gitter.im/Haroenv/holmes?utm_source=readme&utm_medium=link&utm_content=link).\n\n## License\n\nApache 2.0\n","maintainers":[{"name":"haroenv","email":"hello@haroen.me"}],"time":{"modified":"2022-06-18T21:06:03.940Z","created":"2016-06-04T13:37:30.857Z","0.0.0":"2016-06-04T13:37:30.857Z","1.0.0":"2016-06-04T18:02:26.506Z","1.1.0":"2016-06-04T18:03:46.470Z","1.1.1":"2016-06-04T18:09:21.096Z","1.2.0":"2016-06-04T19:10:02.510Z","1.2.1":"2016-06-04T19:24:33.174Z","1.2.2":"2016-06-04T19:32:38.124Z","1.3.0":"2016-06-05T08:05:17.196Z","1.4.0":"2016-06-05T09:12:05.126Z","1.4.1":"2016-06-05T10:41:24.436Z","1.5.0":"2016-06-05T13:27:42.555Z","1.5.1":"2016-06-05T13:35:31.817Z","1.6.0":"2016-06-05T17:56:24.939Z","1.6.1":"2016-06-11T18:35:04.249Z","1.6.2":"2016-06-12T08:02:32.737Z","1.6.3":"2016-06-13T07:10:20.315Z","1.7.0":"2016-06-13T09:39:14.917Z","1.7.1":"2016-06-14T00:17:35.254Z","1.8.0":"2016-06-15T06:39:53.130Z","1.9.0":"2016-06-19T03:29:41.984Z","1.9.1":"2016-06-19T03:30:13.683Z","1.10.0":"2016-07-12T21:14:17.873Z","1.10.1":"2016-07-12T21:21:26.360Z","1.10.2":"2016-07-23T14:26:29.165Z","1.11.0":"2016-08-09T12:01:23.662Z","1.11.1":"2016-08-18T09:35:33.150Z","1.11.2":"2016-08-18T10:57:51.398Z","1.12.0":"2016-08-21T13:37:16.471Z","1.12.1":"2016-08-21T13:46:18.446Z","1.12.2":"2016-08-25T07:43:48.289Z","1.12.3":"2016-08-25T08:00:02.780Z","1.13.0":"2016-08-27T21:30:20.216Z","1.13.1":"2016-08-29T15:41:55.104Z","1.13.2":"2016-08-31T08:28:55.566Z","1.13.3":"2016-09-19T16:26:35.486Z","1.13.4":"2016-10-06T20:08:44.748Z","1.13.5":"2016-10-06T20:22:19.870Z","1.14.0":"2016-11-23T01:39:53.463Z","1.15.0":"2016-12-02T07:41:18.617Z","1.15.1":"2016-12-02T08:18:09.182Z","1.16.0":"2017-01-13T08:11:01.509Z","1.16.1":"2017-01-15T18:35:26.180Z","1.16.2":"2017-01-16T00:09:32.556Z","1.16.3":"2017-01-18T21:19:34.765Z","1.16.4":"2017-01-18T21:51:46.607Z","1.16.5":"2017-01-19T12:11:49.755Z","1.16.6":"2017-01-20T21:35:22.746Z","1.16.7":"2017-06-09T19:46:50.083Z","1.16.8":"2017-07-15T18:57:08.604Z","1.17.0":"2017-08-04T09:37:22.896Z","1.17.1":"2017-08-16T13:45:16.202Z","1.17.1-beta.0":"2017-08-16T13:51:03.163Z","1.17.2":"2017-08-16T17:04:16.369Z","1.17.3":"2017-09-07T08:20:39.054Z"},"homepage":"https://haroen.me/holmes/","keywords":["search","dom","filter"],"repository":{"type":"git","url":"git+https://github.com/Haroenv/holmes.git"},"author":{"name":"Haroen Viaene","email":"hello@haroen.me"},"bugs":{"url":"https://github.com/Haroenv/holmes/issues"},"license":"Apache-2.0","readmeFilename":"README.md","users":{"davidazullo":true}}