5e9bdfed70
* feat(composable-api): Step 1, new core package, pull basic state up higer (#2771) * feat(composable-api): Step 1, new core package, pull basic state up higher * Package cleanup, update core Readme * Cleanup to fix weird import behavior * Fix dependencies * Try fixing deps again * Track new package dist in CI * Make sure to restore core package * feat(composable-api): Step 2, composable DocSearchButton (#2772) * feat(composable-api): Step 1, new core package, pull basic state up higher * Package cleanup, update core Readme * Cleanup to fix weird import behavior * Fix dependencies * Try fixing deps again * Track new package dist in CI * Make sure to restore core package * feat(composable-api): Step 2, move DocSearchButton to be composable * Implement keyboard shortcuts props * Set modal package version * Render new DocSearchButton in react package * Bump allowed bundle size for now * feat(composable-api): Step 3, composable DocSearchModal (#2774) * feat(composable-api): Step 1, new core package, pull basic state up higher * Package cleanup, update core Readme * Cleanup to fix weird import behavior * Fix dependencies * Try fixing deps again * Track new package dist in CI * Make sure to restore core package * feat(composable-api): Step 2, move DocSearchButton to be composable * Implement keyboard shortcuts props * Set modal package version * Render new DocSearchButton in react package * Bump allowed bundle size for now * feat(composable-api): Step 3, make DocSearchModal composable * Clean up needed dependencies, add more bundle checks * fix: CI * add test cases to core package * add test cases to modal package * fixes after rebase * fix: lint * Memoize modal props to stabalize rendering * Dont track isModalActive in props * bump @docsearch/modal bundlesize * remove icons dir from @docsearch-modal * update version definition for @docsearch-react and @docsearch-modal * fix: lint |
||
|---|---|---|
| .. | ||
| 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;