​
Release notes

​
Version 0.3.18

  • Minor bug fixes
  npm install @inkeep/uikit@0.3.18

​
Version 0.3.17

  • Fix bug with modal closing unexpectedly in mobile view.
  npm install @inkeep/uikit@0.3.17

​
Version 0.3.16

  • Added name property to get_help_option_clicked event.
  npm install @inkeep/uikit@0.3.16

​
Version 0.3.15

  • Added pinToToolbar prop on GetHelpCallToAction. See here for more details.
  • Minor bug fixes.
  npm install @inkeep/uikit@0.3.15

​
Version 0.3.14

  • Fix list style bug.
  npm install @inkeep/uikit@0.3.14

​
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.
  npm install @inkeep/uikit@0.3.13

​
Version 0.3.12

  • Fix export for InkeepEvent types.
  npm install @inkeep/uikit@0.3.12

​
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.
  npm install @inkeep/uikit@0.3.11

​
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.
  npm install @inkeep/uikit@0.3.10

​
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.
  npm install @inkeep/uikit@0.3.9

​
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.
  npm install @inkeep/uikit@0.3.8

​
Version 0.3.7

  • Small bug fix.
  npm install @inkeep/uikit@0.3.7

​
Version 0.3.6

  • Small style fix.
  npm install @inkeep/uikit@0.3.6

​
Version 0.3.5

  • Update license field.
  • Small style tweak.
  npm install @inkeep/uikit@0.3.5

​
Version 0.3.4

  • Minor UI improvements.
  npm install @inkeep/uikit@0.3.4

​
Version 0.3.1

  • Minor UI improvements.
  npm install @inkeep/uikit@0.3.1

​
Version 0.3.0 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
  npm install @inkeep/uikit@0.3.0

​
Version 0.2.289

  • Update license.
  • Fix bug with duplicate titles in mobile view.
  npm i @inkeep/widgets@0.2.289

​
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

​
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'
        },
      },
    },
  },
};
JavaScriptChat Completions