# search-ui

**Repository Path**: mirrors_elastic/search-ui

## Basic Information

- **Project Name**: search-ui
- **Description**: Search UI. Libraries for the fast development of modern, engaging search experiences.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2025-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# [Elastic Search UI](https://docs.elastic.co/search-ui)

A JavaScript library for the fast development of modern, engaging search experiences with [Elastic](https://www.elastic.co/). Get up and running quickly without re-inventing the wheel.

**Check out the [documentation](https://docs.elastic.co/search-ui) to learn more about setting up and using Search UI.**

## Features 👍

- **You know, for search** - Maintained by [Elastic](https://elastic.co), 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](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/elasticsearch&file=/src/pages/elasticsearch-basic/index.jsx)
- [Elastic Site Search (Swiftype)](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/site-search&file=/src/pages/site-search/index.jsx)

### Examples

- [Search as you type](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/search-as-you-type&file=/src/pages/search-as-you-type/index.jsx)
- [Search bar in header](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/search-bar-in-header&file=/src/pages/search-bar-in-header/index.jsx)
- [Customizing Styles and Components](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/customizing-styles-and-html&file=/src/pages/customizing-styles-and-html/index.jsx)

## 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](https://docs.elastic.co/search-ui/tutorials/elasticsearch)
- ⚠️ DEPRECATED. [Search UI with Elastic App Search](https://docs.elastic.co/search-ui/tutorials/app-search)
- ⚠️ DEPRECATED. [Search UI with Elastic Workplace Search](https://docs.elastic.co/search-ui/tutorials/workplace-search)

## Contributing

We welcome contributors to the project. Follow our [contributing guide](./CONTRIBUTING.md) to get started.

## License 📗

[Apache-2.0](https://github.com/elastic/search-ui/blob/main/LICENSE.txt) © [Elastic](https://github.com/elastic)

Thank you to all the [contributors](https://github.com/elastic/search-ui/graphs/contributors)!