Add a Custom Trigger to your Nextra docs

What is Nextra

Nextra is a framework for creating content-focused websites using Next.js and markdown.

Get an API key

Go to the Inkeep Dashboard
Select your project under Projects
Go to the Integrations tab
Click on Create integration
Select Web
Provide a Name and URL (optional) for the integration
Click on Create
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:

.env

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 install @inkeep/uikit

bun add @inkeep/uikit

pnpm add @inkeep/uikit

yarn add @inkeep/uikit

Customize your settings

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

import { useTheme } from "nextra-theme-docs";
 
const useInkeepSettings = () => {
  const { resolvedTheme } = useTheme();
 
  const baseSettings = {
    apiKey: process.env.NEXT_PUBLIC_INKEEP_API_KEY!,
    integrationId: process.env.NEXT_PUBLIC_INKEEP_INTEGRATION_ID!,
    organizationId: process.env.NEXT_PUBLIC_INKEEP_ORGANIZATION_ID!,
    primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
    organizationDisplayName: "Inkeep",
    // ...optional settings
    colorMode: {
      forcedColorMode: resolvedTheme, // to sync dark mode with the widget
    },
  };
 
  const modalSettings = {
    // optional settings
  };
 
  const searchSettings = {
    // optional settings
  };
 
  const aiChatSettings = {
    // optional settings
    botAvatarSrcUrl: "/img/logo.svg", // use your own bot avatar
    quickQuestions: [
      "Example question 1?",
      "Example question 2?",
      "Example question 3?",
    ],
  };
 
  return { baseSettings, aiChatSettings, searchSettings, modalSettings };
};
 
export default useInkeepSettings;

import type {
  InkeepAIChatSettings,
  InkeepSearchSettings,
  InkeepBaseSettings,
  InkeepModalSettings,
} from "@inkeep/uikit";
import { useTheme } from "nextra-theme-docs";
 
type InkeepSharedSettings = {
  baseSettings: InkeepBaseSettings;
  aiChatSettings: InkeepAIChatSettings;
  searchSettings: InkeepSearchSettings;
  modalSettings: InkeepModalSettings;
};
 
const useInkeepSettings = (): InkeepSharedSettings => {
  const { resolvedTheme } = useTheme();
 
  const baseSettings: InkeepBaseSettings = {
    apiKey: process.env.NEXT_PUBLIC_INKEEP_API_KEY!,
    integrationId: process.env.NEXT_PUBLIC_INKEEP_INTEGRATION_ID!,
    organizationId: process.env.NEXT_PUBLIC_INKEEP_ORGANIZATION_ID!,
    primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
    organizationDisplayName: "Inkeep",
    // ...optional settings
    colorMode: {
      forcedColorMode: resolvedTheme, // to sync dark mode with the widget
    },
  };
 
  const modalSettings: InkeepModalSettings = {
    // optional settings
  };
 
  const searchSettings: InkeepSearchSettings = {
    // optional settings
  };
 
  const aiChatSettings: InkeepAIChatSettings = {
    // optional settings
    botAvatarSrcUrl: "/img/logo.svg", // use your own bot avatar
    quickQuestions: [
      "Example question 1?",
      "Example question 2?",
      "Example question 3?",
    ],
  };
 
  return { baseSettings, aiChatSettings, searchSettings, modalSettings };
};
 
export default useInkeepSettings;

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

Define the component

Create an InkeepCustomTrigger.tsx file for the Custom Trigger component.

import { useCallback, useEffect, useState } from "react";
import useInkeepSettings from "@/utils/useInkeepSettings";
 
export default function InkeepCustomTrigger() {
  const [isOpen, setIsOpen] = useState(false);
  const [CustomTrigger, setCustomTrigger] = useState();
 
  const handleClose = useCallback(() => {
    console.log("Modal closed");
    setIsOpen(false);
  }, []);
 
  const { baseSettings, aiChatSettings, searchSettings, modalSettings } =
    useInkeepSettings();
 
  // load the library asynchronously
  useEffect(() => {
    const loadCustomTrigger = async () => {
      try {
        const { InkeepCustomTrigger } = await import("@inkeep/uikit");
        setCustomTrigger(() => InkeepCustomTrigger);
      } catch (error) {
        console.error("Failed to load CustomTrigger:", error);
      }
    };
 
    loadCustomTrigger();
  }, []);
 
  const customTriggerProps = {
    isOpen,
    onClose: handleClose,
    baseSettings,
    aiChatSettings,
    searchSettings,
    modalSettings,
  };
 
  return (
    <div>
      <button onClick={() => setIsOpen(!isOpen)}>Toggle Modal</button>
      {CustomTrigger && <CustomTrigger {...customTriggerProps} />}
    </div>
  )
}

import { useCallback, useEffect, useState } from "react";
import useInkeepSettings from "@/utils/useInkeepSettings";
import type { InkeepCustomTriggerProps } from "@inkeep/uikit";
 
export default function InkeepCustomTrigger() {
  const [isOpen, setIsOpen] = useState(false);
  const [CustomTrigger, setCustomTrigger] =
    useState<(e: InkeepCustomTriggerProps) => JSX.Element>();
 
  const handleClose = useCallback(() => {
    console.log("Modal closed");
    setIsOpen(false);
  }, []);
 
  const { baseSettings, aiChatSettings, searchSettings, modalSettings } =
    useInkeepSettings();
 
  // load the library asynchronously
  useEffect(() => {
    const loadCustomTrigger = async () => {
      try {
        const { InkeepCustomTrigger } = await import("@inkeep/uikit");
        setCustomTrigger(() => InkeepCustomTrigger);
      } catch (error) {
        console.error("Failed to load CustomTrigger:", error);
      }
    };
 
    loadCustomTrigger();
  }, []);
 
  const customTriggerProps: InkeepCustomTriggerProps = {
    isOpen,
    onClose: handleClose,
    baseSettings,
    aiChatSettings,
    searchSettings,
    modalSettings,
  };
 
  return (
    <div>
      <button onClick={() => setIsOpen(!isOpen)}>Toggle Modal</button>
      {CustomTrigger && <CustomTrigger {...customTriggerProps} />}
    </div>
  )
}

Use the component

Add a widget component to the page:

import InkeepCustomTrigger from "@/components/InkeepCustomTrigger";
 
export default function MyApp() {
  return (
    <>
      <InkeepCustomTrigger />
    </>
  )
}

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