1
0
Fork 0
docsearch/packages/docsearch-react
Paul Jankowski 0da291bb95
feat(v5): UI updates (#2896)
* feat(v5): UI updates

* fix: css file size

* fix: e2e tests

* fix: e2e tests

* fix: e2e tests

* chore: add theme toggle to react demo example

* Update sources panel display, update dark theme

* fix: lint

* fix(askai): address ui review feedback

* fix: pin icon positioning

* fix(askai): improve a11y and dark-mode shimmer for thinking and error states

- add role=alert/status and aria-hidden on error/thinking UI
- support dark-mode shimmer gradients via CSS variables
- respect prefers-reduced-motion for shimmer
- handle null date in useRelativeFormattedDate with fallback translation
2026-06-11 12:51:22 -04:00
..
src feat(v5): UI updates (#2896) 2026-06-11 12:51:22 -04:00
style feat(sidepanel): Introduce Ask AI Sidepanel (#2816) 2025-12-17 13:25:50 -05:00
askaiModal.js feat(askai): Split Ask AI modal into own component (#2884) 2026-05-19 13:36:23 -04:00
button.js feat: Split docsearch-react package exports (#2764) 2025-09-22 13:46:55 -04:00
docsearchAi.js feat(askai): Split Ask AI modal into own component (#2884) 2026-05-19 13:36:23 -04:00
modal.js feat: Split docsearch-react package exports (#2764) 2025-09-22 13:46:55 -04:00
package.json feat(v5): UI updates (#2896) 2026-06-11 12:51:22 -04:00
README.md chore: migrate to from yarn, lerna and shipjs to bun & changesets (#2827) 2026-03-02 18:52:01 +01:00
sidepanel.js feat(sidepanel): Introduce Ask AI Sidepanel (#2816) 2025-12-17 13:25:50 -05:00
tsdown.config.ts feat(askai): Split Ask AI modal into own component (#2884) 2026-05-19 13:36:23 -04:00
useDocSearchKeyboardEvents.js feat: Split docsearch-react package exports (#2764) 2025-09-22 13:46:55 -04:00
useTheme.js feat: Split docsearch-react package exports (#2764) 2025-09-22 13:46:55 -04:00
version.js feat: Split docsearch-react package exports (#2764) 2025-09-22 13:46:55 -04:00

@docsearch/react

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

Installation

npm install @docsearch/react@4

If you dont 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 →