UI Components Release Notes
Release notes
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 toget_help_option_clicked
event.
Version 0.3.15
- Added
pinToToolbar
prop onGetHelpCallToAction
. See here for more details. - Minor bug fixes.
Version 0.3.14
- Fix list style bug.
Version 0.3.13
- Added a prop
forceInitialDefaultView
tomodalSettings
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 tosearchSettings
. - 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 forChatButton
andCustomTrigger
component types in the embed js package.
Version 0.3.9
- Added a prop called
shouldShowCopyChatButton
toaiChatSettings
, when enabled this will show a button to allow users to copy their entire conversation as markdown. - Added
messages
andchatSessionId
as arguments to theInvokeCallbackAction
forGetHelpCallToAction
andShowEscalateToSupportButtonAction
. - 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 theSuccessConfirmationPageProps
. 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 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 theAsk AI "<query>"
card in the search results. Defaulttrue
.
Breaking changes
-
Renamed the following options for
chatButtonType
:ICON_TEXT
is nowPILL
andICON_TEXT_SHORTCUT
is nowRECTANGLE_SHORTCUT
. -
Renamed the type
InkeepWidgetBaseSettings
toInkeepBaseSettings
. -
Consolidated
chatButtonPillText
andchatButtonCommandText
into a single propchatButtonText
. -
Moved
stylesheets
andstylesheetUrls
props intotheme
(withinbaseSettings
). -
switchToChatMessage
is nowaskAILabel
and will apply to both theAsk AI "<query>"
card in the search results and to the toggle to switch to chat. -
submitOnEnterOnly
prop was removed fromsearchSettings
. -
Removed support for passing
colorMode
in thetheme
(which was deprecated in version0.2.247
),colorMode
will only be supported inbaseSettings
. -
Removed support for passing
highlighterTheme
inbaseSettings
(which was deprecated in version0.2.247
),syntaxHighlighter
will only be supported in thetheme
. -
Removed no longer used
CustomIcons
:linkIndicator
,newLine
, andenter
. -
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
andchat_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
toAIChatFunctions
so it can be triggered from outside the widget. See here for more details. - Added
closeFormAction
toFormConfig
. See here for more details.
Breaking changes
- Removed
backToChatButtonLabel
fromSuccessConfirmationPageProps
and replaced withSuccessConfirmationButton
. 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
andShowEscalateToSupportButtonAction
. 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
andguidance
toAIChatSettings
for providing dynamic information and instructions to the bot.
Version 0.2.258
- Fix copy button tooltip.
- Add default targetElement for the
ChatButton
andCustomTrigger
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
isfalse
.
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 havedata-state="inactive"
. This can be used to style the buttons differently after feedback submission.
Version 0.2.249
- Fix bug with chat button
fixedPositionXOffset
andfixedPositionYOffset
props not being applied. - Add
shrink
size variant for theSearchBarTrigger
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
toisShortcutKeyEnabled
inmodalSettings
- By default
isShortcutKeyEnabled
isfalse
for allInkeepChatButton
variants exceptICON_TEXT_SHORTCUT
, (it istrue
by default for theInkeepSearchBar
andInkeepCustomTrigger
components). - By default the
openShortcutKey
is/
for theInkeepChatButton
component (it is stillk
for theInkeepSearchBar
andInkeepCustomTrigger
components).
Version 0.2.247
- Added support for passing
colorMode
inbaseSettings
, passing incolorMode
intheme
is still supported but is deprecated. - Added support for passing
syntaxHighlighter
intheme
, passing inbaseSettings
(ashighlighterTheme
) is still supported but is deprecated. - Changed the default
chatButtonType
toICON_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
calledsubmitOnEnterOnly
which will submit search query on enter instead of onChange. Default isfalse
.
Version 0.2.243
- Added a prop to
AIChatSettings
calledchatId
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
calledshouldAnimateSwitchToChatButton
which determines whether to animate the switch to chat button on first load. Default istrue
. - Added a variant to the theme for the
SwitchToChat
button, example: