Type to search.

Core API

Serverless

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Core API is the main set of interfaces and configurations used to set up and manage search functionality in Search UI.

Core API consists of three main parts:

  1. Configuration - configuration of search queries, autocomplete, and event handlers
  2. State - application state management, including:
    • Request State
    • Response State
    • Application State
  3. Actions - functions to update the Request State and perform API requests, including:
    • Search term management
    • Filter operations
    • Sorting
    • Pagination
    • Analytics tracking
  • Search query configuration with support for filters and facets
  • Autocomplete and suggestions configuration
  • Application state management
  • Integration with various search backends through connectors
  • URL state and routing configuration
Jsx 
import { SearchProvider } from "@elastic/react-search-ui";

const config = {
  apiConnector: connector,
  searchQuery: {
    facets: {
      states: { type: "value", size: 30 }
    }
  },
  autocompleteQuery: {
    results: {
      resultsPerPage: 5
    }
  }
};

<SearchProvider config={config}>{/* Search UI components */}</SearchProvider>;