* feat(v4): add new UI (#2555) * feat: add new footer ui * feat: add new search box ui * feat: add searchbox actions * feat: add start screen * feat: add no results screen * feat: add new card ui * feat: add new icons * feat: add new key press class * fix: cypress tests * fix: circleci * fix: circleci * fix: close aria label * fix: circleci * fix: remove unused classes * fix: circleci * feat: update version * feat: add new dark mode ui * fix: colors * fix: design review * fix: hit title length * fix: improve accessibility * fix: ci * chore: increase bundle size threshold * fix: css * feat(v4): ask-ai foundations ✨ (#2574) * feat(v4): docsearch askAI context (#2587) * fix(v4): ask ai updates (#2654) * feat(v4): update beta documentation (#2659) * chore: release v4.0.0-beta.0 (#2660) * fix: make release run on branches like v4 * chore: release v4.0.0-beta.0 * hotfix: closing on askai error * chore: release v4.0.0-beta.1 (#2661) * fix: add a section on models * fix: update to `<package>@beta` * feat(docsearch-website): Updated docs (#2662) * feat(v4): update the landing page (#2665) * fix: beta in readme * feat: added glow around the search bar and a little copy above the keyboard * feat: add glow around the search bar and copy above the keyboard * fix: Add more styling * fix: polishing v4 (#2667) * chore: release v4.0.0-beta.2 (#2668) * fix: update docusaurus tarballs * fix(website): update docusaurus tarballs * fix: mobile search bar --------- Co-authored-by: Vasco Bettencourt <32492444+vascobettencourt@users.noreply.github.com> Co-authored-by: Natan Yagudayev <natanyagudayev@gmail.com>
45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
---
|
|
title: Dropdown Search-UI
|
|
---
|
|
|
|
Once your Algolia DocSearch index is ready, set up, and filled with the right data, you will need to integrate our dedicated Search-UI. To add the dropdown of results below your search input, you'll have to include our DocSearch library into your website as per the following example.
|
|
|
|
```html
|
|
<!-- Before the closing </head> -->
|
|
<link
|
|
rel="stylesheet"
|
|
href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"
|
|
/>
|
|
|
|
<!-- Before the closing </body> -->
|
|
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
|
<script>
|
|
docsearch({
|
|
// Your Search API Key
|
|
apiKey: '<YOUR_API_KEY>',
|
|
// The index populated by the DocSearch scraper
|
|
indexName: '<YOUR_INDEX_NAME>',
|
|
// Your Algolia Application ID
|
|
appId: '<YOUR_APP_ID>',
|
|
// Replace inputSelector with a CSS selector
|
|
// matching your search input
|
|
inputSelector: '<YOUR_CSS_SELECTOR>',
|
|
// Set debug to true to inspect the dropdown
|
|
debug: false,
|
|
});
|
|
</script>
|
|
```
|
|
|
|
You need to integrate this snippet into every page that integrates the dropdown UI.
|
|
|
|
## Testing
|
|
|
|
If you're eager to test DocSearch but don't have any credentials of your own yet, you can try out the one we use on this website:
|
|
|
|
```javascript
|
|
docsearch({
|
|
appId: 'PMZUYBQDAK',
|
|
apiKey: '24b09689d5b4223813d9b8e48563c8f6',
|
|
indexName: 'docsearch',
|
|
});
|
|
```
|