UI Kit Components

With Inkeep, you can easily embed your AI assistants anywhere your users have questions.

@inkeep/uikit is our component library that are embeddable as both React components or JS snippets.

Components

Use the @inkeep/uikit-js library to embed the UI components with a snippet of JavaScript.

Add to any site or in-app experience.

Add to your docs or marketing site.

Embed a chat UI directly on your help center or support page.

Use your own custom button to trigger the Inkeep modal.

Use the @inkeep/uikit library to use Inkeep as native React components.

Add to any site or in-app experience.

Add to your docs or marketing site.

Embed a chat UI directly on your help center or support page.

Use your own custom button to trigger the Inkeep modal.

Here are some common scenarios:

Customize theme & CSS - Customize the look and feel of the UI components.
Add guidance & context - Provide user-specific information or provide custom instructions to the LLM.
Manage user privacy preferences - Handle user privacy settings and analytics opt-outs.
Authenticate users - Limit chat or search usage to users authenticated with your app.
Log events to your own analytics - Log events to your own custom analytics system.
Embed a support form - Add a support form embedded within the chat experience.
Make chats sharable - Enable the 'Share' button to make chats sharable.
Add workflows - Define tasks and guidance around specific scenarios for your users.

For an overview of local development and security for AI assistant's that are used on public sites, check out this guide.