Search Widget

Introduction

The DocsGPT Search Bar Widget offers a simple yet powerful way to embed AI-powered document search directly into your web applications. This widget allows users to perform searches across your documents or pages, enabling them to quickly find the information they need. This guide will walk you through embedding the Search Bar Widget into your projects, whether you’re using React or plain HTML.

Try out the interactive widget showcase and customize its parameters at the DocsGPT Widget Demo .

Setup

npm install docsgpt

import { SearchBar } from "docsgpt";

<SearchBar
    apiKey="your-agent-api-key"
    apiHost="https://gptcloud.arc53.com"
    theme="light"
    placeholder="Search or Ask AI..."
    width="300px"
/>

<script src="https://unpkg.com/docsgpt@0.8.0/dist/legacy/browser.js"></script>

<div id="search-bar-container"></div>

<!DOCTYPE html>
<div id="search-bar-container"></div>
<script src="https://unpkg.com/docsgpt@0.8.0/dist/legacy/browser.js"></script>
<script>
  window.onload = function() {
    renderSearchBar('search-bar-container', {
      apiKey: 'your-agent-api-key',
      apiHost: 'https://gptcloud.arc53.com',
      theme: 'light',
      placeholder: 'Search here...',
      width: '300px'
    });
  }
</script>

Properties Table

The DocsGPT Search Bar Widget offers a range of customizable properties that allow you to tailor its appearance and behavior to perfectly match your web application. These parameters can be modified directly when embedding the widget in your React components or HTML code. Below is a detailed overview of each available prop:

Modal or dropdown

With the default variant: 'modal', the search field on your page is a button. Selecting it, or pressing ⌘K (Ctrl K on Windows and Linux), opens a search dialog over the page. On a phone the dialog opens as a sheet from the bottom of the screen, above the keyboard.

With variant: 'dropdown', visitors type straight into the field on your page. ⌘K (Ctrl K) focuses it, and the results open in a panel under the field once there is something to search for. The panel stays inside the screen, and closes on Esc, a click elsewhere, or moving focus away.

<SearchBar
  apiKey="your-agent-api-key"
  variant="dropdown"
  shape="rounded"
  buttonText="Search the docs"
  width="320px"
/>

Both work the same way inside:

• The first row is Ask the AI. Selecting it, or pressing Enter, opens the chat with the query already asked.
• The arrow keys move between rows, and Enter opens the highlighted one.
• A result from a web page shows its title and the matching lines, and opens the page in a new tab.
• A result from an uploaded file shows the same, but is not a link, because a visitor has no way to open a file from your library.

Notes on Widget Properties

• Full Customization: Every property listed in the table can be customized. Override the defaults to create a Search Bar Widget that perfectly matches your branding and application context.
• API Key Handling: The search bar needs the API key of a published agent; /api/search rejects requests without one. See Agent API keys. If you leave apiKey out, the search bar falls back to a built-in key for a public DocsGPT demo agent: on DocsGPT Cloud it searches that demo agent’s knowledge instead of yours, and on a self-hosted instance the key is invalid and searches fail. apiHost for DocsGPT Cloud is https://gptcloud.arc53.com.

Explore and Customize Further

The DocsGPT Search Bar Widget is fully open-source, allowing for deep customization and extension beyond the readily available props.

The complete source code for the React-based widget is available in the extensions/react-widget directory within the main DocsGPT GitHub Repository . Feel free to explore the code, fork the repository, and tailor the widget to your exact requirements.