Add Search Bar to Astro

What is Astro

Astro is an all-in-one web framework for content-driven websites. With Inkeep, you can Add AI Search & Chat to your landing page, app, blog, or documentation site powered by Astro.

Get an API key

Follow these steps to create an API key for your web integration.

Copy and add the apiKey to your environment variables:

.env

INKEEP_API_KEY="INKEEP_API_KEY"

Install the component library

npm install @inkeep/cxkit-react

yarn add @inkeep/cxkit-react

Define React components

Install the @astrojs/react package to use React components:

npx astro add react

bun astro add react

pnpm astro add react

yarn astro add react

Customize your settings

Define your Inkeep settings.

Define the component

Next, create an InkeepSearchBar.tsx file for the Search Bar component.

Use the component

Now use the InkeepSearchBar.tsx component in your Astro based website.

// ...
<InkeepSearchBar client:load />
// ...

Note

Use the client:load directive to load and hydrate the InkeepSearchBar.tsx component immediately on page load.

For a full list of customizations, check out the Search Bar documentation.