https://github.com/elastic/search-ui

Search UI. Libraries for the fast development of modern, engaging search experiences.
https://github.com/elastic/search-ui

app-search elasticsearch enterprise-search javascript react search workplace-search

Last synced: 6 days ago
JSON representation

Search UI. Libraries for the fast development of modern, engaging search experiences.

• Host: GitHub
• URL: https://github.com/elastic/search-ui
• Owner: elastic
• License: apache-2.0
• Created: 2018-10-16T16:11:21.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-10-12T02:37:01.000Z (23 days ago)
• Last Synced: 2024-10-20T08:10:59.469Z (15 days ago)
• Topics: app-search, elasticsearch, enterprise-search, javascript, react, search, workplace-search
• Language: TypeScript
• Homepage: https://docs.elastic.co/search-ui
• Size: 17.1 MB
• Stars: 1,914
• Watchers: 157
• Forks: 368
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Codeowners: CODEOWNERS
  • Security: SECURITY.txt

Awesome Lists containing this project

• awesome-building-blocks-for-web-apps - Search UI - UI integration for ElastiSearch. (Search)

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/index.js)

- [Elastic App Search](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/app-search&file=/src/pages/app-search/index.js)

- [Elastic Workplace Search](https://codesandbox.io/s/github/elastic/search-ui/tree/main/examples/sandbox?from-embed=&initialpath=/workplace-search&file=/src/pages/workplace-search/index.js)

- [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.js)

### 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.js)

- [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.js)

- [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.js)

## 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)

- [Search UI with Elastic App Search](https://docs.elastic.co/search-ui/tutorials/app-search)

- [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)!