Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@elastic/search-ui

elastic217.3kApache-2.01.24.0TypeScript support: included

A Headless Search UI library

readme

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

Examples

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:

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!