\n\n**docs-searchbar.js** is a front-end SDK for **Meilisearch** providing a search bar for your documentation.\n\n**docs-searchbar.js** comes with a css template. The default styling of this library fits a documentation search bar, but you can customize it.\n\nTo make it work, You need to have your documentation's content in a Meilisearch instance. If not already the case, you can achieve this using [`docs-scraper`](https://github.com/meilisearch/docs-scraper/).\n\n**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)\n\n\n\nš” If you use VuePress for your website, you should check out our [VuePress plugin for Meilisearch](https://github.com/meilisearch/vuepress-plugin-meilisearch).\n\n## Table of Contents \n\n- [š§ Installation](#-installation)\n- [š¬ Getting Started](#-getting-started)\n- [šØ Customization](#-customization)\n- [š¤ Compatibility with Meilisearch](#-compatibility-with-meilisearch)\n- [āļø Development Workflow and Contributing](#%EF%B8%8F-development-workflow-and-contributing)\n- [š„ Credits](#-credits)\n\n## š§ Installation\n\n**With npm**:\n\nWe only guarantee that the package works with `node` >= 12 and `node` < 15.\n```sh\n# With NPM\nnpm install docs-searchbar.js\n# With Yarn\nyarn add docs-searchbar.js\n```\n\n**In your HTML**:\n\nAdd the following script into your `HTML` file:\n\n```html\n\n```\n\n### šāāļø Run Meilisearch \n\nThere are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).\n\nFor example, using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):\n\n```bash\n# Install Meilisearch\ncurl -L https://install.meilisearch.com | sh\n\n# Launch Meilisearch\n./meilisearch --master-key=masterKey\n```\n\nNB: you can also download Meilisearch from **Homebrew** or **APT** or even run it using **Docker**.\n\n### Index your data \n\nThe goal of this library is to provide a front-end search bar into your own documentation. To make that possible, you need to gather your website content in advance, and index it in a Meilisearch instance.\n\nLuckily, we provide all the tools that you need, and can help you through the whole process, if you follow [this guide](https://docs.meilisearch.com/create/how_to/search_bar_for_docs.html) š\n\nNote: If you want to try out `docs-searchbar.js` as a first introduction, [try out our playground](./CONTRIBUTING.md#playground).\n\n#### Use your own scraper \n\nWe recommend using the [`docs-scraper` tool](https://github.com/meilisearch/docs-scraper) to scrape your website, but this is not mandatory.\n\nIf you already have your own scraper but you still want to use Meilisearch and `docs-searchbar.js`, check out [this discussion](https://github.com/meilisearch/docs-searchbar.js/issues/40).\n\n\n## š¬ Getting Started\n\n#### ES module \n\nAdd an `input` tag with the attribute `id=\"search-bar-input` in one of your `HTML` file.\n\n```html\n\n```\n\nThen, import `docs-searchbar.js` and run the `docsSearchBar` function. For more explaination of the required parameters, see next section.\n```js\nimport docsSearchBar from 'docs-searchbar.js'\n\ndocsSearchBar({\n hostUrl: 'https://mymeilisearch.com',\n apiKey: 'XXX',\n indexUid: 'docs',\n inputSelector: '#search-bar-input',\n})\n```\n\n#### HTML \n\nAdd the following code to one of your `HTML` files.\n```html\n\n\n \n \n \n\n \n \n \n \n \n\n```\n\nThe `hostUrl` and the `apiKey` (_optional_) fields are the credentials of your Meilisearch instance. \n`indexUid` is the index identifier in your Meilisearch instance in which your website content is stored. \n`inputSelector` is the `id` attribute of the HTML search input tag. As an alternative the dom element can be supplied with `inputElement` directly.\n\n_Your documentation content is not indexed yet? Check out [this tutorial](https://docs.meilisearch.com/create/how_to/search_bar_for_docs.html)._\n\n**WARNING: We recommend providing the Meilisearch public key, which is enough to perform search requests. \nRead more about [Meilisearch authentication](https://docs.meilisearch.com/reference/features/authentication.html).**\n\n### Styling\n\n`docs-searchbar.js` comes with a css template. It has to be added in your project in the following way:\n\nIn an ES+ environment:\n\n```js\nimport 'docs-searchbar.js/dist/cdn/docs-searchbar.css'\n```\n\nIn a `HTML` file, the `link` tag should be added in your header:\n\n```html\n\n```\n\n## šØ Customization\n\nThe default behavior of this library fits perfectly for a documentation search bar, but you might need some customizations.\n\n- [Optional parameters](#optional-parameters-) (when calling `docsSearchBar` method)\n- [Styling](#styling-) (with CSS)\n\n### Optional parameters \n\nWhen calling the `docsSearchBar` method, you can add optional fields:\n\n#### `queryHook` \n\n`queryHook` takes a callback function as value. This function will be called on every keystroke to transform the typed keywords before querying Meilisearch. By default, it does not do anything, but it is the perfect place for you to add some preprocessing or custom functionality.\n\n#### `transformData` \n\n`transformData` takes a callback function as value. This function will be called on every hit before displaying them. By default, it does not do anything, but it lets you add any post-processing around the data you received from Meilisearch.\n\n#### `handleSelected` \n\n`handleSelected` takes a callback function a value. This function is called when a suggestion is selected (either from a click or a keystroke). By default, it displays anchor links to the results page. Here is an example to override this behavior:\n\n```javascript\ndocsSearchBar({\n // ...\n handleSelected: function (input, event, suggestion, datasetNumber, context) {\n // Prevents the default behavior on click and rather opens the suggestion\n // in a new tab.\n if (context.selectionMethod === 'click') {\n input.setVal('')\n\n const windowReference = window.open(suggestion.url, '_blank')\n windowReference.focus()\n }\n },\n})\n```\n\nNote that, by default, you can already open a new tab thanks to the CMD/CTRL + Click action.\n\nThe function is called with the following arguments:\n\n- `input`: a reference to the search input element. It comes with the `.open()`, `.close()`, `.getVal()` and `.setVal()` methods.\n\n- `event`: the actual event triggering the selection.\n\n- `suggestion`: the object representing the current selection. It contains a `.url` key representing the destination.\n\n- `datasetNumber`: this should always be equal to 1 as `docs-searchbar.js` is searching into one dataset at a time. You can ignore this attribute.\n\n- `context`: additional information about the selection. Contains a `.selectionMethod` key that can be either `click`, `enterKey`, `tabKey` or `blur`, depending on how the suggestion was selected.\n\n#### `meilisearchOptions` \n\nYou can forward search parameters to the Meilisearch API by using the `meilisearchOptions` key. Checkout out the [Meilisearch documentation about search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html#search-parameters).\n\nFor example, you might want to increase the number of results displayed in the dropdown:\n\n```javascript\ndocsSearchBar({\n meilisearchOptions: {\n limit: 10,\n },\n})\n```\n\n#### `enableDarkMode` \n\nAllows you to display the searchbar in dark mode. It is useful if your website has dark mode support and you also want the searchbar to appear in a dark version.\nYou can always edit the style of the searchbar to match the style of your website. When the option `enableDarkMode` is set to `auto`, the searchbar automatically sets the mode to the system mode.\n\n`enableDarkMode` has three possible states:\n- `false`: enforce light mode.\n- `true`: enforce dark mode.\n- `auto`: system mode (light or dark).\n\nExample:\n\n```javascript\ndocsSearchBar({\n ...\n enableDarkMode: 'auto'\n})\n```\n\nDark mode with `enableDarkMode` set to `auto` and system mode set to `dark`:\n\n\n\n#### `enhancedSearchInput` \n\nWhen set to `true`, a theme is applied to the search box to improve its appearance. It adds the `.searchbox` class which can be used to further customise the search box.\n\nExample:\n\n```javascript\ndocsSearchBar({\n ...\n enhancedSearchInput: true\n})\n```\n\n##### More Examples \n\nHere is a basic [HTML file](playground/index.html) used in the playground of this repository.\n\nAs a more concrete example, you can [check out the configuration](https://github.com/meilisearch/vuepress-plugin-meilisearch/blob/main/MeiliSearchBox.vue#L60) applied in the Meilisearch plugin for VuePress.\n\n#### Styling \n\n```css\n/* Main dropdown wrapper */\n.meilisearch-autocomplete .dsb-dropdown-menu {\n width: 500px;\n}\n\n/* Main category */\n.meilisearch-autocomplete .docs-searchbar-suggestion--category-header {\n color: darkgray;\n border: 1px solid gray;\n}\n\n/* Category */\n.meilisearch-autocomplete .docs-searchbar-suggestion--subcategory-column {\n color: gray;\n}\n\n/* Title */\n.meilisearch-autocomplete .docs-searchbar-suggestion--title {\n font-weight: bold;\n color: black;\n}\n\n/* Description */\n.meilisearch-autocomplete .docs-searchbar-suggestion--text {\n font-size: 0.8rem;\n color: gray;\n}\n\n/* Highlighted text */\n.meilisearch-autocomplete .docs-searchbar-suggestion--highlight {\n color: blue;\n}\n```\n\n**TIPS: When inspecting the dropdown markup with your browser tools, you should add `debug: true` to your `docsSearchBar` call to prevent it from closing on inspection.**\n\n##### More Examples \n\nHere is the [CSS customization](https://github.com/meilisearch/vuepress-plugin-meilisearch/blob/main/MeiliSearchBox.vue#L82) applied in the Meilisearch plugin for VuePress.\n\n## š¤ Compatibility with Meilisearch\n\nThis package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/docs-searchbar.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.\n\n## āļø Development Workflow and Contributing\n\nAny new contribution is more than welcome in this project!\n\nIf you want to know more about the development workflow or want to contribute, please visit our [contributing guidelines](/CONTRIBUTING.md) for detailed instructions!\n\n## š„ Credits\n\nBased on [Algolia DocSearch repository](https://github.com/algolia/docsearch) from [this commit](https://github.com/algolia/docsearch/commit/4c32b6f80b753f592de83351116664bf74b10297). \nDue to a lot of future changes in this repository compared to the original one, we don't maintain it as an official fork.\n\n\n\n**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.\n","readmeFilename":"README.md"}
![\"Meilisearch\"](\"https://github.com/meilisearch/integration-guides/blob/main/assets/logos/logo.svg\"){kind=logo}
\n![\"NPM](\"https://img.shields.io/npm/v/docs-searchbar.js.svg\")
\n ![\"Test\"](\"https://github.com/meilisearch/docs-searchbar.js/workflows/Tests/badge.svg\"){kind=icon}
\n ![\"License\"](\"https://img.shields.io/badge/license-MIT-informational\"){kind=icon}
![\"Bors](\"https://bors.tech/images/badge_small.svg\"){kind=icon}
\n