Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/meilisearch/docs-searchbar.js

Front-end search bar for documentation with Meilisearch
https://github.com/meilisearch/docs-searchbar.js

integration meilisearch search-bar

Last synced: about 2 months ago
JSON representation

Front-end search bar for documentation with Meilisearch

Lists

README 

        


  Meilisearch




DEPRECATED - docs-searchbar.js



---



🚨 DEPRECATION WARNING 🚨



Dear Community,



We'd like to share some updates regarding the future maintenance of this repository:



Our team is small, and our availability will be reduced in the upcoming times. As such, we decided to deprecate this repository.

We invite you into using Tauri's [`meilisearch-docsearch`](https://github.com/tauri-apps/meilisearch-docsearch) instead of this one.



We still accept bug fixes from the community but no more enhancements.



Seeking immediate support? Please join us on [our Discord channel](https://discord.meilisearch.com/).



---





  Meilisearch |

  Meilisearch Cloud |

  Documentation |

  Discord |

  Roadmap |

  Website |

  FAQ






  NPM version

  Test

  License

  Bors enabled




**docs-searchbar.js** is a front-end SDK for **Meilisearch** providing a search bar for your documentation.



**docs-searchbar.js** comes with a css template. The default styling of this library fits a documentation search bar, but you can customize it.



To 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/).



**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)



![docs-searchbar.js example](/assets/docs-searchbar-example.png)



💡 If you use VuePress for your website, you should check out our [VuePress plugin for Meilisearch](https://github.com/meilisearch/vuepress-plugin-meilisearch).



## Table of Contents 



- [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)

- [🔧 Installation](#-installation)

- [🎬 Getting Started](#-getting-started)

- [🎨 Customization](#-customization)

- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)

- [⚙️ Development Workflow and Contributing](#%EF%B8%8F-development-workflow-and-contributing)

- [🥇 Credits](#-credits)



## ⚡ Supercharge your Meilisearch experience



Say goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=docs-searchbar.js). Get started with a 14-day free trial! No credit card required.



## 🔧 Installation



**With npm**:



We only guarantee that the package works with `node` >= 12 and `node` < 15.



```sh

# With NPM

npm install docs-searchbar.js

# With Yarn

yarn add docs-searchbar.js

```



**In your HTML**:



Add the following script into your `HTML` file:



```html



```



### 🏃‍♀️ Run Meilisearch 



There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/reference/features/installation.html#download-and-launch).



For example, using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):



```bash

# Install Meilisearch

curl -L https://install.meilisearch.com | sh



# Launch Meilisearch

./meilisearch --master-key=masterKey

```



NB: you can also download Meilisearch from **Homebrew** or **APT** or even run it using **Docker**.



### Index your data 



The 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.



Luckily, we provide all the tools that you need, and can help you through the whole process, if you follow [this guide](https://www.meilisearch.com/docs/create/how_to/search_bar_for_docs.html) 🚀



Note: If you want to try out `docs-searchbar.js` as a first introduction, [try out our playground](./CONTRIBUTING.md#playground).



#### Use your own scraper 



We recommend using the [`docs-scraper` tool](https://github.com/meilisearch/docs-scraper) to scrape your website, but this is not mandatory.



If 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).



## 🎬 Getting Started



#### ES module 



Add an `input` tag with the attribute `id="search-bar-input` in one of your `HTML` file.



```html



```



Then, import `docs-searchbar.js` and run the `docsSearchBar` function. For more explaination of the required parameters, see next section.



```js

import docsSearchBar from 'docs-searchbar.js'



docsSearchBar({

  hostUrl: 'https://mymeilisearch.com',

  apiKey: 'XXX',

  indexUid: 'docs',

  inputSelector: '#search-bar-input',

})

```



#### HTML 



Add the following code to one of your `HTML` files.



```html



  

    

  



  

    

    

    

      docsSearchBar({

        hostUrl: 'https://mymeilisearch.com',

        apiKey: 'XXX',

        indexUid: 'docs',

        inputSelector: '#search-bar-input',

        debug: true, // Set debug to true if you want to inspect the dropdown

      })

    

  



```



The `hostUrl` and the `apiKey` (_optional_) fields are the credentials of your Meilisearch instance.


`indexUid` is the index identifier in your Meilisearch instance in which your website content is stored.


`inputSelector` is the `id` attribute of the HTML search input tag. As an alternative the dom element can be supplied with `inputElement` directly.



_Your documentation content is not indexed yet? Check out [this tutorial](https://www.meilisearch.com/docs/create/how_to/search_bar_for_docs.html)._



**WARNING: We recommend providing the Meilisearch public key, which is enough to perform search requests.


Read more about [Meilisearch authentication](https://www.meilisearch.com/docs/reference/features/authentication.html).**



### Styling



`docs-searchbar.js` comes with a css template. It has to be added in your project in the following way:



In an ES+ environment:



```js

import 'docs-searchbar.js/dist/cdn/docs-searchbar.css'

```



In a `HTML` file, the `link` tag should be added in your header:



```html



```



## 🎨 Customization



The default behavior of this library fits perfectly for a documentation search bar, but you might need some customizations.



- [Optional parameters](#optional-parameters-) (when calling `docsSearchBar` method)

- [Styling](#styling-) (with CSS)



### Optional parameters 



When calling the `docsSearchBar` method, you can add optional fields:



#### `queryHook` 



`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.



#### `transformData` 



`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.



#### `handleSelected` 



`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:



```javascript

docsSearchBar({

  // ...

  handleSelected: function (input, event, suggestion, datasetNumber, context) {

    // Prevents the default behavior on click and rather opens the suggestion

    // in a new tab.

    if (context.selectionMethod === 'click') {

      input.setVal('')



      const windowReference = window.open(suggestion.url, '_blank')

      windowReference.focus()

    }

  },

})

```



Note that, by default, you can already open a new tab thanks to the CMD/CTRL + Click action.



The function is called with the following arguments:



- `input`: a reference to the search input element. It comes with the `.open()`, `.close()`, `.getVal()` and `.setVal()` methods.



- `event`: the actual event triggering the selection.



- `suggestion`: the object representing the current selection. It contains a `.url` key representing the destination.



- `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.



- `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.



#### `meilisearchOptions` 



You can forward search parameters to the Meilisearch API by using the `meilisearchOptions` key. Checkout out the [Meilisearch documentation about search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters#search-parameters).



For example, you might want to increase the number of results displayed in the dropdown:



```javascript

docsSearchBar({

  meilisearchOptions: {

    limit: 10,

  },

})

```



#### `enableDarkMode` 



Allows 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.

You 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.



`enableDarkMode` has three possible states:



- `false`: enforce light mode.

- `true`: enforce dark mode.

- `auto`: system mode (light or dark).



Example:



```javascript

docsSearchBar({

  ...

  enableDarkMode: 'auto'

})

```



Dark mode with `enableDarkMode` set to `auto` and system mode set to `dark`:



![docs-searchbar with dark mode](assets/dark-mode.png)



#### `enhancedSearchInput` 



When 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.



Example:



```javascript

docsSearchBar({

  ...

  enhancedSearchInput: true

})

```



##### More Examples 



Here is a basic [HTML file](playground/index.html) used in the playground of this repository.



As 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.



#### Styling 



```css

/* Main dropdown wrapper */

.meilisearch-autocomplete .dsb-dropdown-menu {

  width: 500px;

}



/* Main category */

.meilisearch-autocomplete .docs-searchbar-suggestion--category-header {

  color: darkgray;

  border: 1px solid gray;

}



/* Category */

.meilisearch-autocomplete .docs-searchbar-suggestion--subcategory-column {

  color: gray;

}



/* Title */

.meilisearch-autocomplete .docs-searchbar-suggestion--title {

  font-weight: bold;

  color: black;

}



/* Description */

.meilisearch-autocomplete .docs-searchbar-suggestion--text {

  font-size: 0.8rem;

  color: gray;

}



/* Highlighted text */

.meilisearch-autocomplete .docs-searchbar-suggestion--highlight {

  color: blue;

}

```



**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.**



##### More Examples 



Here is the [CSS customization](https://github.com/meilisearch/vuepress-plugin-meilisearch/blob/main/MeiliSearchBox.vue#L82) applied in the Meilisearch plugin for VuePress.



## 🤖 Compatibility with Meilisearch



This 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.



## ⚙️ Development Workflow and Contributing



Any new contribution is more than welcome in this project!



If you want to know more about the development workflow or want to contribute, please visit our [contributing guidelines](/CONTRIBUTING.md) for detailed instructions!



## 🥇 Credits



Based on [Algolia DocSearch repository](https://github.com/algolia/docsearch) from [this commit](https://github.com/algolia/docsearch/commit/4c32b6f80b753f592de83351116664bf74b10297).


Due to a lot of future changes in this repository compared to the original one, we don't maintain it as an official fork.






**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.