Package Exports

@docsearch/react

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@docsearch/react) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@docsearch/react

React package for DocSearch, the best search experience for docs.

Installation

yarn add @docsearch/react@4
# or
npm install @docsearch/react@4

If you don’t want to use a package manager, you can use a standalone endpoint:

<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@4"></script>

Get started

DocSearch generates a fully accessible search box for you.

import { DocSearch } from '@docsearch/react';

import '@docsearch/css';

function App() {
  return (
    <DocSearch
      appId="YOUR_APP_ID"
      indexName="YOUR_INDEX_NAME"
      apiKey="YOUR_SEARCH_API_KEY"
    />
  );
}

export default App;

Documentation

Read documentation →