@docsearch/react

@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 →

Similar packages

Other packages similar to @docsearch/react

react-instantsearch-dom

react-instantsearch-dom is a library by Algolia that provides a set of React components to build search interfaces. It offers more flexibility and customization options compared to @docsearch/react, but requires more setup and configuration.

react-searchbox

react-searchbox is a lightweight search component for React applications. It is simpler and easier to set up than @docsearch/react, but it does not offer the same level of integration with Algolia's search capabilities.

react-autosuggest

react-autosuggest is a React component for building input fields with suggestions. While it is not specifically designed for documentation search, it can be customized to provide similar functionality with more control over the suggestion logic.