Add a Custom Trigger to your Next.js app

​

What is Next.js

Next.js is a React full-stack app development framework. You can use Inkeep's React component library to Add AI Search & Chat functionality to apps or documentation and marketing sites built with Next.js.

​

Get an API key

1. Go to the Inkeep Dashboard
2. Select your project under Projects
3. Go to the Integrations tab
4. Click on Create integration
5. Select Web
6. Provide a Name and URL (optional) for the integration
7. Click on Create
8. Click the Example < /> button to get your API key and view suggested settings

Copy and add the apiKey, integrationId and organizationId to your environment variables:

NEXT_PUBLIC_INKEEP_API_KEY="INKEEP_API_KEY"
NEXT_PUBLIC_INKEEP_INTEGRATION_ID="INKEEP_INTEGRATION_ID"
NEXT_PUBLIC_INKEEP_ORGANIZATION_ID="INKEEP_ORGANIZATION_ID"

​

Install the component library

• npm
• bun
• pnpm
• yarn

npm install @inkeep/uikit

​

Customize your settings

Create a useInkeepSettings.ts file that will contain a hook that will return the configuration for Inkeep component(s).

Make sure to add your Inkeep identifiers to your environment settings.

​

Define the component

Create an InkeepCustomTrigger.tsx file for our Custom Trigger component. <button> represents whatever UI element you’d like to use to trigger the Inkeep Modal.

For a full list of customizations, check out the Custom Trigger documentation.