UI Components Release Notes

Release notes

Version 0.5.39

• Improve search result rendering

  npm install @inkeep/cxkit-react@0.5.39

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.39/dist/embed.js"
    integrity="sha256-GGyAIDirU+PwRbtQegaph7DOZXHkaOYeJvkoVYMLix4="
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.5.37

• Add support for tool calls see here for details

  npm install @inkeep/cxkit-react@0.5.37

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.37/dist/embed.js"
    integrity="sha256-20s62TpWKlunFxtVPWr8XnmM8XwrV+ZlsHeksL2xWqo="
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.5.36

• Small bug fix

  npm install @inkeep/cxkit-react@0.5.36

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.36/dist/embed.js"
    integrity="sha256-GqqNO84Cftrl+8Ou1tCUJ96X+D+7jRACZQFkW1PzTSc="
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.5.35

• Small bug fix

  npm install @inkeep/cxkit-react@0.5.35

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.35/dist/embed.js"
    integrity="sha256-Svtz1F8FIv63EVTBUZfccyG1BTEB+3O6NPPkaQq6jN8="
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.5.34

• Add js package types to @inkeep/cxkit-types

  npm install @inkeep/cxkit-react@0.5.34

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.34/dist/embed.js"
    integrity="sha256-VyuDBONLs9q5OS9Mrz4BTkkngnD6IYWgB168ntgBnKc="
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.5.33

• Tweak dual pane search styles

  npm install @inkeep/cxkit-react@0.5.33

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.33/dist/embed.js"
    integrity="sha256-eO15NnHD8xfrHuF0mHQmnMJjm1CvSTxAqFWT5dKC7CE="
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.5.32

• Fix search result item previews in dual-pane search

  npm install @inkeep/cxkit-react@0.5.32

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.32/dist/embed.js"
    integrity="sha256-o7/nlmLf5CQmMoCvUykyjtAA6jdEMp76VqQjG9xRUtM="
    crossorigin="anonymous"
    defer
  >
  </script>

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

  npm install @inkeep/cxkit-react@0.5.31

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.31/dist/embed.js"
    integrity="sha256-JgngZjTbKSSmceuGeilZ/NC0/SQ7XfCgGbXyOUvxrWk="
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.5.30

• Small bug fix for message id generation

  npm install @inkeep/cxkit-react@0.5.30

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.30/dist/embed.js"
    integrity="sha256-zADKtQG7GVmoXB6fT70dD2pwRhFVZ05SV1WO5zDRGfs="
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.5.20

• Bug fix for duplicate breadcrumb keys

  npm install @inkeep/cxkit-react@0.5.20

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.20/dist/embed.js"
    integrity="sha384-+7WXh7wn0k+r56vdVMGD6XAXekgV/lAmn0LoSeRDSf4mQwC7dQY9mCPbWVdQF0xX"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.5.18

• Fix id collision in the js package

  npm install @inkeep/cxkit-react@0.5.18

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.18/dist/embed.js"
    integrity="sha384-KbWITD/BaKTuF5DmVlo6VKtxgYCRU2NrOptHF803eCcfSC32w4pnh5acECETdWwO"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.5.17

• Use first tab as default tab

  npm install @inkeep/cxkit-react@0.5.17

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.17/dist/embed.js"
    integrity="sha384-Ey+Hc6KmeFFxXaTh1l8xIe8KUNc3kcInscPry+WqEIlgJA1/huRvMszhhrhAdk+e"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.5.16

• Bundle types

  npm install @inkeep/cxkit-react@0.5.16

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.16/dist/embed.js"
    integrity="sha384-8mWzNNXH3NQTDynPPwZpmPM7sy5ArY3qOPUBURUrOlgbuQYlloKNsM6ji1PMnJgW"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.5.15

• Configure Webpack to resolve JavaScript modules

  npm install @inkeep/cxkit-react@0.5.15

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.15/dist/embed.js"
    integrity="sha384-sHG91YYxt9Pe9HQid5jCWCZuNlmr50+q5yNfdZS9GK3J2UZEhOCO7ixH6xKE/3DI"
    crossorigin="anonymous"
    defer
  >
  </script>

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

Modal Settings

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

  npm install @inkeep/cxkit-react@0.5.11

  <script
    type="module"
    src="https://unpkg.com/@inkeep/cxkit-js@0.5.11/dist/embed.js"
    integrity="sha384-wBDmA9KDOaZPmb8OeKdQUaJko6IpRQRMfFnKM1n4ZHfoSFJ2rvcNswQ2OMnv/vqF"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.3.19

• Minor bug fix for search result titles.

  npm install @inkeep/uikit@0.3.19

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.19/dist/embed.js"
    integrity="sha384-NrApcNv8E5NXyoaHq8Zbyi9byJkCkCJ7BZJRlZ+8ELzfp0qgixQYy4FXfkJcVkn3"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.3.18

• Minor bug fixes.

  npm install @inkeep/uikit@0.3.18

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.18/dist/embed.js"
    integrity="sha384-L0dDhbtoDYVxDwHFUFUqgnSQioDzKMH4ylSDFya0pBHpbrSvvP/qybqTs2UEqpxa"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.3.17

• Fix bug with modal closing unexpectedly in mobile view.

  npm install @inkeep/uikit@0.3.17

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.17/dist/embed.js"
    integrity="sha384-Gg/fcaqv3nfqhVXHGKYAwuxqDKkrgseD/D3/TzCedGwVrf8xdZTNsunA7sqnftOE"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.3.16

• Added name property to get_help_option_clicked event.

  npm install @inkeep/uikit@0.3.16

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.16/dist/embed.js"
    integrity="sha384-w/YcUoMq/jYrvjQ7V0K4z5D93tgsj647CyCQosk44Q80hysCGkLySJQnvqFdh7ry"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.3.15

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

  npm install @inkeep/uikit@0.3.15

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.15/dist/embed.js"
    integrity="sha384-eW0CsSnGiRITbNF2posLIgZ3yLpG3tLjur8uyQDOmgS93YLAhd+rSCoD1S72+qwV"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.3.14

• Fix list style bug.

  npm install @inkeep/uikit@0.3.14

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.14/dist/embed.js"
    integrity="sha384-KTJnPec5ksOwzBNqB/1/HdW55HRcQUFykelYQrOvbWSyFHF08y3oXRGYotfhYaGX"
    crossorigin="anonymous"
    defer
  >
  </script>

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

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.13/dist/embed.js"
    integrity="sha384-EDSGAp6rhcaXKGssCgYgOWW6IUYvWRlDSQ1CO/8ApxDqwOVvTgjG/ac7lYDCG+zp"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.3.12

• Fix export for InkeepEvent types.

  npm install @inkeep/uikit@0.3.12

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.12/dist/embed.js"
    integrity="sha384-tS26d1BU5ihEP0oNwC7CvrUXH6Rmzvo1FivkwWOn09vukiqMtdLteeNZhtPxy7VW"
    crossorigin="anonymous"
    defer
  >
  </script>

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

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.11/dist/embed.js"
    integrity="sha384-eNRBPlulNL0ynUFNoot1+rMUpA5Aj3B47UfHxSGurhtkB4olxIAjyJoAdSpatwv9"
    crossorigin="anonymous"
    defer
  >
  </script>

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

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.10/dist/embed.js"
    integrity="sha384-VEutSDnJ8BuuVYkBRtyc4sNiJdghWHE+Ewkfp4dDqSqHP8q+eA+NGYL+WWIRn03c"
    crossorigin="anonymous"
    defer
  >
  </script>

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

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.9/dist/embed.js"
    integrity="sha384-tJ8HaC0dsMlX404eO80U7KVgBWkIjr84cuYCQDj9Bup+oiAV2CY95bNoVSQ/LsWo"
    crossorigin="anonymous"
    defer
  >
  </script>

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

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.8/dist/embed.js"
    integrity="sha384-3JVQvMaCNT/fi08RVecdp2dK0t0drimArxMVS7VeivoXNXPe2ghLq8DsIaPEHLuL"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.3.7

• Small bug fix.

  npm install @inkeep/uikit@0.3.7

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.7/dist/embed.js"
    integrity="sha384-/Rug8L+kHAeSGKz/aFPM7pfoxgU3UDiHSQEx0aMYVqUcbZaySQWpNiPRKMUguH9h"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.3.6

• Small style fix.

  npm install @inkeep/uikit@0.3.6

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.6/dist/embed.js"
    integrity="sha384-Vsa/UTFUSi59Qm7oPdRUj/ouG1iWGTUhk3c8Cf189xbKvjTIJBnAOVydZjVRRTSy"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.3.5

• Update license field.
• Small style tweak.

  npm install @inkeep/uikit@0.3.5

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.5/dist/embed.js"
    integrity="sha384-YmgEvyTk3odDpz+yvuN0IjL27JY4slw4UTO56tZgHbcPYtf86O7KyfFftyj2DL2B"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.3.4

• Minor UI improvements.

  npm install @inkeep/uikit@0.3.4

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.4/dist/embed.js"
    integrity="sha384-h9Zfhmg7H4Z5TGyTXLKLSE/dQLIiHGsRw7EaIfxG5QQUaI0b9u7Li//0UcCPzyui"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.3.1

• Minor UI improvements.

  npm install @inkeep/uikit@0.3.1

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.1/dist/embed.js"
    integrity="sha384-LWzgAnCjQxGCBq973/hByvj5dJe+s3CtBejGJpy60uETNFZzMYIOw7dJ0xMBdihj"
    crossorigin="anonymous"
    defer
  >
  </script>

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

  npm install @inkeep/uikit@0.3.0

  <script
    type="module"
    src="https://unpkg.com/@inkeep/uikit-js@0.3.0/dist/embed.js"
    integrity="sha384-8hZDIuOsAgmHWblZdK5Tz88TIZTdF7Wk24qbs4PMZIvo6GMXOZxPKwDo5HYEJQih"
    crossorigin="anonymous"
    defer
  >
  </script>

Version 0.2.289

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

  npm i @inkeep/widgets@0.2.289

  <script
    type="module"
    src="https://unpkg.com/@inkeep/widgets-embed@0.2.289/dist/embed.js"
    integrity="sha384-z/gkVz89DKokF4p2d8pnApdsNAuy8LJ1+Qotg837yQ6TX2Tr31KfROcDgT2DMdoT"
    crossorigin="anonymous"
    defer
  >
  </script>

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