b15f302ee3
* feat: Split docsearch-react package exports * Adds more explicit exports from @docsearch/react package * fix: docusaurus import --------- Co-authored-by: Dylan Tientcheu <dylan.tientcheu@algolia.com> Co-authored-by: Dylan Tientcheu <dylantientcheu@gmail.com> |
||
|---|---|---|
| .. | ||
| src | ||
| style | ||
| babel.config.mjs | ||
| button.js | ||
| modal.js | ||
| package.json | ||
| README.md | ||
| rollup.config.js | ||
| tsconfig.declaration.json | ||
| useDocSearchKeyboardEvents.js | ||
| useTheme.js | ||
| version.js | ||
@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;