README.md

Elastic Search UI

A JavaScript library for the fast development of modern, engaging search experiences with Elastic. Get up and running quickly without re-inventing the wheel.

Check out the documentation to learn more about setting up and using Search UI.

Features 👍

• You know, for search - Maintained by Elastic, the team behind Elasticsearch.
• Speedy Implementation - Build a complete search experience with a few lines of code.
• Customizable - Tune the components, markup, styles, and behaviors to your liking.
• Smart URLs - Searches, paging, filtering, and more, are captured in the URL for direct result linking.
• Flexible front-end - Not just for React. Use with any JavaScript library, even vanilla JavaScript.
• Flexible back-end - Use it with Elasticsearch, Elastic Enterprise Search, or any other search API.

Live demos 👀

Connectors

• Elasticsearch
• Elastic App Search
• Elastic Workplace Search
• Elastic Site Search (Swiftype)

Examples

• Search as you type
• Search bar in header
• Customizing Styles and Components

Get started

Installation

npm install @elastic/search-ui @elastic/react-search-ui @elastic/react-search-ui-views
# or
yarn add @elastic/search-ui @elastic/react-search-ui @elastic/react-search-ui-views

Tutorials

To quickly get started with Search UI, follow one of our tutorials:

• Search UI with Elasticsearch
• Search UI with Elastic App Search
• Search UI with Elastic Workplace Search

Contributing

We welcome contributors to the project. Follow our contributing guide to get started.

License 📗

Apache-2.0 © Elastic

Thank you to all the contributors!