docsearch/packages/docsearch-sidepanel-js

@docsearch/sidepanel-js

JavaScript package for DocSearch Sidepanel, a standalone Ask AI chat panel.

Installation

npm install @docsearch/sidepanel-js

Get started

If you don’t want to use a package manager, you can use a standalone endpoint:

<script src="https://cdn.jsdelivr.net/npm/@docsearch/sidepanel-js@5"></script>

To get started, you need a container for your DocSearch Sidepanel component to go in. If you don’t have one already, you can insert one into your markup:

<div id="docsearch-sidepanel"></div>

Then, insert DocSearch Sidepanel into it by calling the sidepanel function and providing the container. It can be a CSS selector or an Element.

Make sure to provide a container (for example, a div).

import sidepanel from '@docsearch/sidepanel-js';

import '@docsearch/css/dist/sidepanel.css';

sidepanel({
  container: '#docsearch-sidepanel',
  indexName: 'YOUR_INDEX_NAME',
  appId: 'YOUR_APP_ID',
  apiKey: 'YOUR_SEARCH_API_KEY',
  agentId: 'YOUR_AGENT_ID',
});

Documentation

Read documentation →