sylvinus / instantsearch.js

:zap: Lightning-fast search for your apps, by Algolia

InstantSearch.js is a library for building blazing fast search-as-you-type search UIs with Algolia.

---

InstantSearch.js is a vanilla JavaScript library that lets you create an instant-search result experience using Algolia’s search API. It is part of the InstantSearch family:

InstantSearch.js | React InstantSearch | Vue InstantSearch | Angular InstantSearch | React InstantSearch Native | InstantSearch Android | InstantSearch iOS

Table of contents

• Why
• Getting started
• Documentation
• Demos
• Playground
• Browser support
• Contributing
• We're hiring
• License

Why

You should be using InstantSearch if you want to:

• Design search experiences with best practices
• Customize your components at will
• Remain independent from external frameworks

Getting started

Using InstantSearch.js is as simple as adding this JavaScript code to your page:

// 1. Instantiate the search
const search = instantsearch({
  appId: 'latency',
  apiKey: '6be0576ff61c053d5f9a3225e2a90f76',
  indexName: 'instant_search',
});

// 2. Create an interactive search box
search.addWidget(
  instantsearch.widgets.searchBox({
    container: document.querySelector('#searchBox'),
    placeholder: 'Search for products',
  })
);

// 3. Plug the search results into the product container
search.addWidget(
  instantsearch.widgets.hits({
    container: document.querySelector('#products'),
    templates: {
      item: '{{{_highlightResult.name.value}}}',
    },
  })
);

// 4. Make the brands refinable
search.addWidget(
  instantsearch.widgets.refinementList({
    container: document.querySelector('#brand'),
    attributeName: 'brand',
  })
);

// 5. Start the search!
search.start();

To learn more about the library, follow the getting started guide or check how to add it to your own project.

Documentation

The documentation is available at community.algolia.com/instantsearch.js.

Demos

E-commerce	Media	Travel

See more examples on the website.

Playground

You can get to know InstantSearch.js on this playground.

Start by adding widgets and tweaking the display. Once you feel familiar with the library, we recommend following the getting started guide.

Browser support

We support the last two versions of major browsers. To support IE11, we recommend using polyfill.io.

Contributing

We welcome all contributors, from casual to regular 💙

• Bug report. Is something not working as expected? Send a bug report.
• Feature request. Would you like to add something to the library? Send a feature request.
• Documentation. Did you find a typo in the doc? Click on the edit this page button.
• Development. If you don't know where to start, you can check the open issues that are tagged easy, the bugs or chores.

To start contributing to code, you need to:

1. Fork the project
2. Clone the repository
3. Install the dependencies: yarn
4. Run the development mode: yarn run dev
5. Open dev-novel

Please read our contribution process to learn more.

We're hiring

Join the InstantSearch squad and help us build tools that will empower thousands of other developers.

Open positions:

• Open Source Software Engineer (Paris)
• Engineering Manager (Paris)

License

InstantSearch.js is MIT licensed.