MCPcopy
hub / github.com/elastic/search-ui

github.com/elastic/search-ui @v1.24.2 sqlite

repository ↗ · DeepWiki ↗ · release v1.24.2 ↗
558 symbols 1,407 edges 274 files 18 documented · 3%
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!

Extension points exported contracts — how you extend this code

IApiClientTransporter (Interface)
(no doc) [9 implementers]
packages/search-ui-elasticsearch-connector/src/transporter/ApiClientTransporter.ts
Transporter (Interface)
(no doc) [7 implementers]
packages/search-ui-engines-connector/src/types.ts
APIConnector (Interface)
(no doc) [11 implementers]
packages/search-ui/src/types/index.ts
OptionDataProps (Interface)
(no doc)
packages/react-search-ui-views/src/SingleSelectFacet.tsx
AppSearchAPIConnectorParamsBase (Interface)
(no doc)
packages/search-ui-app-search-connector/src/AppSearchAPIConnector.ts
AnalyticsPluginOptions (Interface)
(no doc)
packages/search-ui-analytics-plugin/src/index.ts
WithSearchProps (Interface)
(no doc)
packages/react-search-ui/src/WithSearchRenderProps.tsx
ResultClickParams (Interface)
(no doc)
packages/search-ui-workplace-search-connector/src/WorkplaceSearchAPIConnector.ts

Core symbols most depended-on inside this repo

setupDriver
called by 50
packages/search-ui/src/test/helpers.ts
next
called by 27
packages/search-ui-elasticsearch-connector/src/handlers/handleAutocomplete.ts
doFilterValuesMatch
called by 25
packages/search-ui/src/helpers.ts
appendClassName
called by 23
packages/react-search-ui-views/src/view-helpers/appendClassName.ts
runWithDebounce
called by 19
packages/search-ui/src/DebounceManager.ts
useSearch
called by 18
packages/react-search-ui/src/hooks/useSearch.tsx
formatResult
called by 17
packages/react-search-ui-views/src/view-helpers/formatResult.ts
subscribeToStateChanges
called by 14
packages/search-ui/src/SearchDriver.ts

Shape

Function 353
Method 112
Class 57
Interface 36

Languages

TypeScript100%

Modules by API surface

packages/search-ui/src/URLManager.ts27 symbols
packages/search-ui/src/SearchDriver.ts13 symbols
packages/search-ui-elasticsearch-connector/src/queryBuilders/SearchQueryBuilder.ts13 symbols
packages/search-ui-elasticsearch-connector/src/queryBuilders/BaseQueryBuilder.ts13 symbols
packages/search-ui/src/types/index.ts12 symbols
packages/search-ui-workplace-search-connector/src/WorkplaceSearchAPIConnector.ts12 symbols
packages/search-ui-elasticsearch-connector/src/handlers/__tests__/handleSearch.test.ts12 symbols
packages/search-ui-app-search-connector/src/AppSearchAPIConnector.ts12 symbols
packages/search-ui/src/test/helpers.ts9 symbols
packages/search-ui-elasticsearch-connector/src/transformer/__tests__/responseTransformer.test.ts9 symbols
packages/search-ui-elasticsearch-connector/src/handlers/__tests__/handleAutocomplete.test.ts9 symbols
packages/search-ui-elasticsearch-connector/src/connectors/ApiProxyConnector.ts9 symbols

Dependencies from manifests, versioned

@elastic/app-search-javascript8.1.2 · 1×
@elastic/behavioral-analytics-javascript-tracker2.1.3 · 1×
@elastic/behavioral-analytics-tracker-core2.0.5 · 1×
@elastic/datemath5.0.3 · 1×
@elastic/elasticsearch8.17.1 · 1×
@elastic/eui102.1.0 · 1×
@elastic/react-search-ui1.24.2 · 1×
@elastic/react-search-ui-views1.24.2 · 1×
@elastic/search-ui1.24.2 · 1×
@elastic/search-ui-app-search-connector1.24.1 · 1×
@elastic/search-ui-elasticsearch-connector1.24.2 · 1×
@elastic/search-ui-engines-connector1.24.2 · 1×

For agents

$ claude mcp add search-ui \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact