Skip to content

Commit 635e343

Browse files
Restructure feature list
1 parent 71d637e commit 635e343

File tree

1 file changed

+9
-70
lines changed

1 file changed

+9
-70
lines changed

solutions/search/site-or-app/search-ui.md

Lines changed: 9 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -12,86 +12,25 @@ products:
1212

1313
# What is Search UI? [overview]
1414

15-
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.
15+
Search UI is a JavaScript library from [Elastic](https://www.elastic.co/). It helps you create modern and customizable search experiences. You can use it with Elasticsearch or other search APIs. It helps developers build complete search interfaces quickly, with minimal boilerplate.
1616

17+
As a headless library, Search UI separates logic from presentation. You can use it with React, vanilla JavaScript, or any front-end framework. You can use built-in React components for quick development. Or, you can create your own from the ground up.
1718

18-
## Features 👍 [overview-features]
19+
Search UI supports advanced capabilities like customizable query behavior, smart URL handling (capturing filters, paging, and queries in the URL), and flexible backend integration through connectors. It works seamlessly with Elasticsearch and also supports custom backends via custom connectors.
1920

20-
* **You know, for search** - Maintained by [Elastic](https://elastic.co), the team behind Elasticsearch.
21-
* **Speedy Implementation** - Build a complete search experience with a few lines of code.
22-
* **Customizable** - Tune the components, markup, styles, and behaviors to your liking.
23-
* **Smart URLs** - Searches, paging, filtering, and more, are captured in the URL for direct result linking.
24-
* **Flexible front-end** - Not just for React. Use with any JavaScript library, even vanilla JavaScript.
25-
* **Flexible back-end** - Use it with Elasticsearch, Elastic Enterprise Search, or any other search API.
2621
:::{important}
2722
Enterprise Search is not available in {{stack}} 9.0+.
2823
:::
2924

30-
## Get started 🌟
31-
* 📘 [Reference documentation](search-ui://reference/index.md): API docs, tutorials, and usage guides
25+
## Get started
26+
* [Reference documentation](search-ui://reference/index.md): API docs, tutorials, and usage guides
3227
* [Quickstart tutorials](search-ui://reference/tutorials.md)
3328
* [Ecommerce examples](search-ui://reference/ecommerce.md)
3429
* [Basic usage](search-ui://reference/basic-usage.md)
3530
* [API reference](search-ui://reference/api-reference.md)
36-
* 💻 [GitHub repository](https://github.com/elastic/search-ui): Source code, examples, and issue tracking
31+
* [GitHub repository](https://github.com/elastic/search-ui): Source code, examples, and issue tracking
3732

38-
## Use Cases 🛠️ [overview-use-cases]
39-
40-
41-
### Ecommerce [overview-ecommerce]
42-
43-
Search UI works great in the ecommerce use-case. Check out our [ecommerce guide](search-ui://reference/ecommerce.md) that includes demo and code examples, as well as general guidance for ecommerce search.
44-
45-
46-
## FAQ 🔮 [overview-faq]
47-
48-
49-
### Is Search UI only for React? [overview-is-search-ui-only-for-react]
50-
51-
Search UI is "headless". You can use vanilla JavaScript or write support for it into any JavaScript framework.
52-
53-
[Read about the search-ui package](https://github.com/elastic/search-ui/tree/main/packages/search-ui) for more information, or check out the [Vue.js Example](https://github.com/elastic/vue-search-ui-demo).
54-
55-
56-
### Can I use my own styles? [overview-can-i-use-my-own-styles]
57-
58-
You can!
59-
60-
Read the [Custom Styles and Layout Guide](search-ui://reference/basic-usage.md) to learn more, or check out the [Seattle Indies Expo Demo](https://github.com/elastic/seattle-indies-expo-search).
61-
62-
63-
### Can I build my own Components? [overview-can-i-build-my-own-components]
64-
65-
Yes! Absolutely.
66-
67-
Check out the [Build Your Own Component Guide](search-ui://reference/guides-creating-own-components.md).
68-
69-
70-
### Does Search UI only work with App Search? [overview-does-search-ui-only-work-with-app-search]
71-
72-
Nope! We do have two first party connectors: Site Search and App Search.
73-
74-
But Search UI is headless. You can use *any* Search API.
75-
76-
Read the [Building a custom connector](search-ui://reference/guides-building-custom-connector.md) to learn more about building your own connector for your API.
77-
78-
79-
### How do I use this with Elasticsearch? [overview-how-do-i-use-this-with-elasticsearch]
80-
81-
Read the [Elasticsearch Connector](search-ui://reference/api-connectors-elasticsearch.md) docs.
82-
83-
84-
### Where do I report issues with the Search UI? [overview-where-do-i-report-issues-with-the-search-ui]
85-
86-
If something is not working as expected, open an [issue](https://github.com/elastic/search-ui/issues/new).
87-
88-
89-
### Where can I go to get help? [overview-where-can-i-go-to-get-help]
90-
91-
The Enterprise Search team at Elastic maintains this library and are happy to help. Try posting your question to the [Elastic Enterprise Search](https://discuss.elastic.co/c/enterprise-search/84) discuss forums. Be sure to mention that you’re using Search UI and also let us know what backend your using; whether it’s App Search, Site Search, Elasticsearch, or something else entirely.
92-
93-
94-
## Contribute 🚀 [overview-contribute]
33+
## Contribute [overview-contribute]
9534

9635
We welcome contributors to the project. Before you begin, a couple notes…
9736

@@ -104,8 +43,8 @@ We welcome contributors to the project. Before you begin, a couple notes…
10443
* Write simple code and concise documentation, when appropriate.
10544

10645

107-
## License 📗 [overview-license]
46+
## License [overview-license]
10847

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

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

0 commit comments

Comments
 (0)