UI Components Release Notes

Add a triggerSelector prop to the modalSettings, this allows you to specify a custom selector to trigger the modal without needing to implement your own onOpenChange handler or keep track of the open state.

Version 0.5.81

New SidebarChat component, see Sidebar Chat or Sidebar Chat (React) for more details.

Version 0.5.80

Pin react-remove-scroll to version 2.6.3 to fix an uncaught error in the latest version.

Version 0.5.79

Add global error boundary to all components
Prevent errors from propagating to the parent

Version 0.5.78

Small style fix for conflict with Tailwind version 4

Version 0.5.77

Fix bug with events in shared chats

Version 0.5.76

Add analyticsProperties to baseSettings to allow for custom properties to be sent to analytics
Update UserProperties type to allow for custom properties

Version 0.5.75

Remove react-icons dependency
Add data-has-message-buttons attribute to the message container when message buttons are rendered as a result of a tool call

Version 0.5.73

Add prop askAICardLabel to customize the label of the ask AI card separately from the ask AI toggle label

Version 0.5.72

Minor UI adjustments

Version 0.5.71

Ask ai query animation

Version 0.5.70

Add toolcalls to events

Version 0.5.69

Support copying as html

Version 0.5.66

Fix bug with shouldAutoFocusInput prop not working as expected
Release new Fern integration package @inkeep/cxkit-fern, see here for details

Version 0.5.64

Add events for modal_opened and modal_closed
Tweak dual pane search ui spacing

Version 0.5.63

Add styles to collapse the search bar for small screens to the docusaurus package

Version 0.5.62

Fix incompatible deps
Decrease animation time when opening modal

Version 0.5.59

Improve prompting for the intelligent form
Small bug fix

Version 0.5.58

Fix prefilling in the intelligent form

Version 0.5.57

Small bug fix search breadcrumbs casing

Version 0.5.56

Add default z-index to chat button

Version 0.5.55

Accessibility improvements

Version 0.5.52

Small style bug fix

Version 0.5.51

Add more built-in icons

Version 0.5.50

Bug fix for event logging

Version 0.5.49

Implement focus trap for modal

Version 0.5.48

Bug fix

Version 0.5.47

Bug fix

Version 0.5.46

Fix for disclaimer tooltip on mobile

Version 0.5.45

Bug fix

Version 0.5.44

Add conversation context to onToolCall

Version 0.5.43

Add onToolCall callback

Version 0.5.42

Bundle cxkit-js package into cxkit-mintlify

Version 0.5.40

Add new Mintlify integration package @inkeep/cxkit-mintlify, see here for details

Version 0.5.39

Improve search result rendering

Version 0.5.37

Add support for tool calls see here for details

Version 0.5.36

Small bug fix

Version 0.5.35

Small bug fix

Version 0.5.34

Add js package types to @inkeep/cxkit-types

Version 0.5.33

Tweak dual pane search styles

Version 0.5.32

Fix search result item previews in dual-pane search

Version 0.5.31

Add a new prop to search settings called view which can be single-pane (default) or dual-pane, this prop determines whether to render the search results in a single list or a two pane view with a list of results on the left and a preview of the content on the right

Version 0.5.30

Small bug fix for message id generation

Version 0.5.20

Bug fix for duplicate breadcrumb keys

Version 0.5.18

Fix id collision in the js package

Version 0.5.17

Use first tab as default tab

Version 0.5.16

Bundle types

Version 0.5.15

Configure Webpack to resolve JavaScript modules

Version 0.5.11 `@inkeep/cxkit-react`

Breaking changes

Base Settings

Removed:

integrationId
organizationId
userType
remoteErrorLogsLevel
consoleDebugLevel
customCardSettings (use transformSource instead)
breadcrumbRules (use transformSource instead)
stringReplacementRules (use transformSource instead)

Changed:

userId, userEmail, userName were renamed and are now under userProperties:
userProperties: { id: "user-456", email: "jane@enterprise.com", name: "Jane Smith", cohorts: ["admin", "engineering"], }
userToken -> userAuthToken
The logEventCallback was renamed to onEvent and the InkeepCallbackEvent type has changed, see here for details
The event names and structure have also changed, see here for details
optOutAnalyticalCookies, optOutAllAnalytics, optOutFunctionalCookies are now under privacyPreferences:
privacyPreferences: { optOutAnalyticalCookies: false, optOutAllAnalytics: false, optOutFunctionalCookies: false, }
chatApiProxyDomain -> aiApiBaseUrl
analyticsApiProxyDomain -> analyticsApiBaseUrl
env options are now lower case: "development" | "production"
appendQueryParamsToUrls -> urlQueryParamsToAppend
colorMode now allows for more robust synchronization, see here for details
stylesheets and stylesheetUrls were renamed to styles see here for details
Updated classnames can be found here

AI Chat Settings

Removed:

isControlledMessage
includeAIAnnotations (equivalent functionality coming soon)
aiAnnotationPolicies (equivalent functionality coming soon)

Changed:

botName -> aiAssistantName
botAvatarSrcUrl -> aiAssistantAvatar
botAvatarDarkSrcUrl -> can be configured by passing an object with light and dark URLs for different theme modes:
// Single URL aiAssistantAvatar: "/assets/assistant.png" // Or light/dark mode URLs aiAssistantAvatar: { light: "/assets/assistant-light.png", dark: "/assets/assistant-dark.png" }
userAvatarSrcUrl -> userAvatar
quickQuestions -> exampleQuestions
quickQuestionsLabel -> exampleQuestionsLabel
shouldHighlightFirstQuickQuestion -> isFirstExampleQuestionHighlighted
disclaimerSettings properties were renamed:

 disclaimerSettings: {
    isEnabled: true,
    label: "AI Assistant",
    tooltip: "Responses are AI-generated and may require verification.",
  },

handleMessageChange -> onInputMessageChange
getHelpCallToActions -> getHelpOptions types and form configurations have changed, see here for details
The FormConfig type was renamed to AIChatFormSettings has and the configuration has changed, see here for details.
isChatSharingEnabled -> isShareButtonVisible
shouldShowCopyChatButton -> isCopyChatButtonVisible
actionButtonLabels -> toolbarButtonLabels
Within toolbarButtonLabels:
- clearButtonLabel -> clear
- shareButtonLabel -> share
- getHelpButtonLabel -> getHelp
- stopButtonLabel -> stop
- copyChatButtonLabel -> copyChat
context use prompts instead, see here for details
guidance use prompts instead, see here for details

Search Settings

Removed:

isControlledSearchQuery

Changed:

prefilledQuery -> defaultQuery
handleSearchQueryChange -> onQueryChange
tabSettings -> tabs and type has changed, see here for details
shouldShowAskAICard was moved to be a top level prop
maximumHitsLimit -> maxResults
debounceTime -> debounceTimeMs

Removed:

isShortcutKeyEnabled pass shortcutKey as null to disable the shortcut key or pass a key to enable it
isAlignedToTop
isAlignedToRight
onShortcutKeyPressed

Changed:

openShortcutKey -> shortcutKey
askAILabel was moved to be a top level prop
switchToSearchMessage -> searchLabel and was moved to be a top level prop
isModeSwitchingEnabled -> canToggleView and was moved to be a top level prop
forceInitialDefaultView -> forceDefaultView and was moved to be a top level prop

Chat Button

Removed:

chatButtonType
chatButtonBgColor can be change via css using this className .ikp-chat-button__button
chatButtonBgColorDarkMode can be change via css using this className [data-theme='dark'] .ikp-chat-button__button
isPositionFixed can be change via css by setting position: relative; on this className .ikp-chat-button__container
fixedPositionXOffset can be change via css by setting right: 0; on this className .ikp-chat-button__container
fixedPositionYOffset can be change via css by setting bottom: 0; on this className .ikp-chat-button__container

Changed:

chatButtonText -> label

Custom Trigger

Changed:

This component was renamed to ModalSearchAndChat for both search and chat functionality or ModalSearch for just search functionality or ModalChat for just chat functionality see here for details.
isOpen was moved inside modalSettings
onOpen -> onOpenChange (moved inside modalSettings)
onClose -> can utilize onOpenChange (moved inside modalSettings)

JS Snippet

The interface for using the js snippet has changed, see here for details

Docusaurus

The interface for adding and configuring the Docusaurus plugin has changed, see here for details.

API keys

Production API keys for web integrations are now required to have Enforce referrer URL enabled for additional security, see here for details. API keys without this setting will be severely rate limited.

New

Intelligent form component see here for details
Embedded search component see here for details
Embedded search and chat component see here for details

Version 0.3.19

Minor bug fix for search result titles.

Version 0.3.18

Minor bug fixes.

Version 0.3.17

Fix bug with modal closing unexpectedly in mobile view.

Version 0.3.16

Added name property to get_help_option_clicked event.

Version 0.3.15

Added pinToToolbar prop on GetHelpCallToAction. See here for more details.
Minor bug fixes.

Version 0.3.14

Fix list style bug.

Version 0.3.13

Added a prop forceInitialDefaultView to modalSettings to allow modal to open in a certain view, regardless of which view was last opened. See modalSettings for more details.

Version 0.3.12

Fix export for InkeepEvent types.

Version 0.3.11

Added optional searchQueryParamKey prop to searchSettings.
Added event logging for search result clicks.
Made the default placeholder text 'Search...' for small screens.

Version 0.3.10

Exposed the SearchFunctions in the embed js package.
Fixed targetElement being marked as required for ChatButton and CustomTrigger component types in the embed js package.

Version 0.3.9

Added a prop called shouldShowCopyChatButton to aiChatSettings, when enabled this will show a button to allow users to copy their entire conversation as markdown.
Added messages and chatSessionId as arguments to the InvokeCallbackAction for GetHelpCallToAction and ShowEscalateToSupportButtonAction.
Added analytics events for when a user clicks a get help menu item or support button.
Minor UI / bug fixes.

Version 0.3.8

Added SELECT field type to support form. See here for details.
Added support for markdown strings in the message prop of the SuccessConfirmationPageProps. See here for details.

Version 0.3.7

Small bug fix.

Version 0.3.6

Small style fix.

Version 0.3.5

Update license field.
Small style tweak.

Version 0.3.4

Minor UI improvements.

Version 0.3.1

Minor UI improvements.

Version 0.3.0 `@inkeep/uikit`

We have renamed the @inkeep/widgets and @inkeep/widgets-embed packages to @inkeep/uikit and @inkeep/uikit-js respectively. Links to new packages can be found here: uikit / uikit-js.
This new package contains a significant change to the search ui, moving from a two pane search result view to a single pane view with support for keyboard navigation.

Additions

New prop in searchSettings shouldShowAskAICard to control whether or not to show the Ask AI "<query>" card in the search results. Default true.

Breaking changes

Renamed the following options for chatButtonType: ICON_TEXT is now PILL and ICON_TEXT_SHORTCUT is now RECTANGLE_SHORTCUT.
Renamed the type InkeepWidgetBaseSettings to InkeepBaseSettings.
Consolidated chatButtonPillText and chatButtonCommandText into a single prop chatButtonText.
Moved stylesheets and stylesheetUrls props into theme (within baseSettings).
switchToChatMessage is now askAILabel and will apply to both the Ask AI "<query>" card in the search results and to the toggle to switch to chat.
submitOnEnterOnly prop was removed from searchSettings.
Removed support for passing colorMode in the theme (which was deprecated in version 0.2.247), colorMode will only be supported in baseSettings.
Removed support for passing highlighterTheme in baseSettings (which was deprecated in version 0.2.247), syntaxHighlighter will only be supported in the theme.
Removed no longer used CustomIcons: linkIndicator, newLine, and enter.
Removed shouldAnimateSwitchToChatButton prop, the animation was removed since button was changed to a toggle.
Updated and removed some classnames to match ui changes.

Added:
- .ikp-ask-ai-card
- .ikp-search-result-line__first
- .ikp-search-result-line__second
Removed:
- .ikp-switch-to-chat-button
- .ikp-switch-to-chat-button__shortcut
- .ikp-enter-icon
- .ikp-heading-tree__title
- .ikp-heading-tree__list
- .ikp-heading-tree__item
- .ikp-heading-tree__heading
- .ikp-new-line-icon
- .ikp-preview-content-header__heading
- .ikp-preview-content-header__title
- .ikp-link-indicator-icon

Version 0.2.289

Update license.
Fix bug with duplicate titles in mobile view.

Version 0.2.286

Allow users to pass in query params to append to documentation links. See appendQueryParamsToUrls in baseSettings for more details.

Version 0.2.285

Fix small style bug.

Version 0.2.284

Allow users to pass in their own instance of Prism js to avoid conflicts in the global namespace.

Version 0.2.282

Fix being able to style the switch to chat button with custom css.

Version 0.2.281

Fixes to support for react 19.

Version 0.2.280

Remove apollo dev tools console message.

Version 0.2.279

Bug fix to improve multi language support.

Version 0.2.278

Bug fixes.

Version 0.2.276

Fallback to default bot avatar if user provided bot avatar doesn't load.
Improve styling for docs search preview.

Version 0.2.275

Added a file input type to the support form.

Version 0.2.274

Added a prop to change the chat button color. See here for more details.

Version 0.2.272

Add workflowId to chat_message_submitted and chat_message_bot_response_received events.

Version 0.2.271

Add info tooltip for workflow attachments.

Version 0.2.270

Minor style tweak.

Version 0.2.269

Exposed the AIChatFunctions in the embed js package.
Added openForm to AIChatFunctions so it can be triggered from outside the widget. See here for more details.
Added closeFormAction to FormConfig. See here for more details.

Breaking changes

Removed backToChatButtonLabel from SuccessConfirmationPageProps and replaced with SuccessConfirmationButton. See here for more details.

Version 0.2.268

Add switch to chat and submit hot key (cmd + enter)
Fix bug with prefilled query not showing in search bar
Fix low chroma primary color derivatives calculations
Use filled sparkles for default icon in chat component

Version 0.2.267

Adding additional class names for stylization.

Version 0.2.266

Minor bug fixes

Version 0.2.265

Edit default disclaimer copy.

Version 0.2.264

Added support for CustomIcons. Refer to custom icons for details.

Version 0.2.263

Added support for a new GetHelpCallToAction and ShowEscalateToSupportButtonAction. Refer to get help call to actions and support workflows for details.
Fix for highlighting search text in dark mode.

Version 0.2.262

Minor UI improvements.

Version 0.2.261

Added support workflows feature. Refer to Support workflows for details.
Minor UI improvements.

Version 0.2.260

Minor bug fixes.

Version 0.2.259

Adding context and guidance to AIChatSettings for providing dynamic information and instructions to the bot.

Version 0.2.258

Fix copy button tooltip.
Add default targetElement for the ChatButton and CustomTrigger in the js snippet.
Add colorModeSync logic to the js snippet.

Version 0.2.256

Fix to close modal if clicking on a search result link within the same page and shouldOpenLinksInNewTab is false.

Version 0.2.254

Fix bug with loading stylesheets.

Version 0.2.253

Deep merge properties in the widgets-embed package to improve devx.
Add fallback targetEl in the widgets-embed package.

Version 0.2.252

Update default AI assistant avatar.

Version 0.2.250

Add data-state="active" to the thumbs up and thumbs down buttons after the relative feedback has been submitted, by default they will have data-state="inactive". This can be used to style the buttons differently after feedback submission.

Version 0.2.249

Fix bug with chat button fixedPositionXOffset and fixedPositionYOffset props not being applied.
Add shrink size variant for the SearchBarTrigger component, this variant will shrink the search bar to just the search icon for the smallest screen sizes.

Version 0.2.248

Breaking changes

Changed the prop areOpenHotKeysDisabled to isShortcutKeyEnabled in modalSettings
By default isShortcutKeyEnabled is false for all InkeepChatButton variants except ICON_TEXT_SHORTCUT, (it is true by default for the InkeepSearchBar and InkeepCustomTrigger components).
By default the openShortcutKey is / for the InkeepChatButton component (it is still k for the InkeepSearchBar and InkeepCustomTrigger components).

Version 0.2.247

Added support for passing colorMode in baseSettings, passing in colorMode in theme is still supported but is deprecated.
Added support for passing syntaxHighlighter in theme, passing in baseSettings (as highlighterTheme) is still supported but is deprecated.
Changed the default chatButtonType to ICON_TEXT.

Version 0.2.246

Added loading state for AI chat when passing in the chatId prop.

Version 0.2.245

Added support for customizing the chat action button labels and switch to search button label.

Version 0.2.244

Added a prop to SearchSettings called submitOnEnterOnly which will submit search query on enter instead of onChange. Default is false.

Version 0.2.243

Added a prop to AIChatSettings called chatId which will load the chat corresponding to the id.

Version 0.2.242

Bumped dependencies to address vulnerability in vite@4.4.11.

Version 0.2.241

Fixed a bug where chat actions were only shown for most recent message.

Version 0.2.238

Added a prop to ModalSettings called shouldAnimateSwitchToChatButton which determines whether to animate the switch to chat button on first load. Default is true.
Added a variant to the theme for the SwitchToChat button, example:

const inkeepBaseSettings: InkeepBaseSettings = {
  theme: {
    components: {
      SwitchToChat: {
        defaultProps: {
          variant: "subtle", // options are 'primary' or 'subtle'
        },
      },
    },
  },
};

UI Components Release Notes

On this page