Skip to content

Releases: microsoft/BotFramework-WebChat

[4.15.5] - 2022-11-16

Choose a tag to compare

@compulim compulim released this 17 Nov 00:03
df55e01

Subresource Integrity

The CDN URL will be online in about a day after we completed publish to NPM.

<script
  crossorigin="anonymous"
  integrity="sha384-yZ3Ugoikjn2nnqUATWlZR3e2PfDz/fopbI/J77anxs6pnoauHENVS3hObWSAOxmr"
  src="https://cdn.botframework.com/botframework-webchat/4.15.5/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-t278QukjDZq/zQN4GdMwm+wPjb3glhiqydECL5o9le9PfgGwgACfwkARzlGj6GeI"
  src="https://cdn.botframework.com/botframework-webchat/4.15.5/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-L/K5c9oKPS2+VbgxTOXnHL/fQQg9G+agAc1eB3I3t/+XnXdGHOqs8kMB9ViQTSMQ"
  src="https://cdn.botframework.com/botframework-webchat/4.15.5/webchat-minimal.js"
></script>

Changelog

Fixed

  • Card action image alt text should use imageAltText field and fallback to text field, by @compulim in PR #4333
  • Fixes #4472. Removed role attributes for notification bar and use <div> instead of <ul>/<li>, by @compulim in PR #4475
  • Fixes #4393. Renders <section role="feed"> only if there are one or more activities contained within, by @beyackle2 and @compulim, in PR #4420
  • Fixes #4473. Bumped strip-ansi@6.0.1 for test-harness as @^7 does not support CommonJS project, by @compulim in PR #4474
  • Fixes #4476. When focus on the keyboard help screen, it should focus on the close button, by @compulim in PR #4479
  • Fixes #4442. Change the keyboard help screen string "Leave message" to "Exit message", by @compulim in PR #4479

Changed

[4.15.4] - 2022-09-15

Choose a tag to compare

@compulim compulim released this 18 Sep 02:04
2348572

Subresource Integrity

<script
  crossorigin="anonymous"
  integrity="sha384-hm7B00mbtnkFvRyz6+PZuG2yfM3JaBdEUPYw7BEPKQWZqu1s3G8KFiyOIqOMEk+v"
  src="https://cdn.botframework.com/botframework-webchat/4.15.4/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-9pDJTvPL0wLKBbhzIDeYtyOXpMQgf3VVqPMKPWKTs+p/J8oOqOEy0piRhj9Atlzz"
  src="https://cdn.botframework.com/botframework-webchat/4.15.4/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-yyVMTpA21TwmR+Cfm3ktfuYwApD/XUCxVYOSfUssIKI05H25L/2D5bJQ817fFsMp"
  src="https://cdn.botframework.com/botframework-webchat/4.15.4/webchat-minimal.js"
></script>

Changelog

Fixed

  • Fixes #4403. Patched Unicode CLDR database which caused file upload in Polish to appear blank, by @compulim, in PR #4404
  • Fixes #4412. Fixed inconsistent in packages/support/cldr-data/package.json, by @compulim, in PR #4411

Changed

[4.14.2] - 2022-09-06

Choose a tag to compare

@compulim compulim released this 07 Sep 07:05

Subresource Integrity

<script
  crossorigin="anonymous"
  integrity="sha384-TX+6Xqq20HcCfn9vFBfivPrnGantvLj6bVoeZMiRt3TDf7QL0l3y0h5NfXPHeMYD"
  src="https://cdn.botframework.com/botframework-webchat/4.14.2/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-rICoECir+m94sA3D9FN2nWP76JKfcGJA5uhCZ/nSM3JNYWtnqUk5mHCgVvgWE+if"
  src="https://cdn.botframework.com/botframework-webchat/4.14.2/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-FDtL64x1C0SfN3jynhpEExETYworgZHfADHx+04wRT4RGxeXQulwMv7u9s8gUkkZ"
  src="https://cdn.botframework.com/botframework-webchat/4.14.2/webchat-minimal.js"
></script>

Changelog

Fixed

  • QFE: Fixes #4403. Patched Unicode CLDR database which caused file upload in Polish to appear blank, by @compulim, in PR #4406

[4.15.3] - 2022-08-10

Choose a tag to compare

@compulim compulim released this 10 Aug 22:48
5cd632b

Subresource Integrity

<script
  crossorigin="anonymous"
  integrity="sha384-Va7pNFHjKGxgI1g9J4tvLCSGEhtfpZzf76PDRDDKkaI+ZZXMCz7FplIZdjUrjkxg"
  src="https://cdn.botframework.com/botframework-webchat/4.15.3/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-G/4GhuAj4f+IvvVgyTT1u6m5DjjdPI7hcrfgXmnWKC6uWtZkrI+jDkVk2MmJoclR"
  src="https://cdn.botframework.com/botframework-webchat/4.15.3/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-1CAMb60XukTImMnaUTHJvRYbYckPlkzXGVibWExFb5e8WbLsCrfkbQM+K1smVB5a"
  src="https://cdn.botframework.com/botframework-webchat/4.15.3/webchat-minimal.js"
></script>

Changelog

Breaking changes

  • Suggested actions is now a role="toolbar" and adopted roving tab index
    • TAB key will now land on the container, instead of individual button
    • While the focus is on the container, LEFT/RIGHT arrow keys are used to select different buttons (UP/DOWN for stacked layout)
    • Visual focus indicator is now two tiered. The default styling is same as the one we use in chat history
      • New style options added suggestedActionsVisualKeyboardIndicatorColor, suggestedActionsVisualKeyboardIndicatorStyle, suggestedActionsVisualKeyboardIndicatorWidth
    • Suggested actions container will be unmounted when there are no suggested action button to display
    • Suggested actions container is not longer a live region. The suggested action buttons will now be narrated by the chat history live region
  • Published NPM packages will now include /dist, /lib, and /src folders
    • The /dist folder was previously missing from our NPM packages
  • The activity.channelData.state property is being deprecated in favor of the updated activity.channelData['webchat:send-status'] property. Main differences include:
    • Previously, we would set the state property to "send failed" when the chat adapter failed to send the activity, or after passing a timeout as defined in styleOptions.sendTimeout
    • The new 'webchat:send-status' property will be set to "send failed" when the chat adapter fails to send the activity or after passing a hardcoded timeout of 5 minutes
    • See PR #4362 for details

Changed

  • Resolves #4301. Updated Dockerfile to support secure container supply chain, by @compulim in PR #4303
  • Resolves #4317. Updated package.json to allowlist /dist, /lib, /src, by @compulim in PR #4318
  • Resolves #4322. Improved error messages for sending activities, by @compulim in PR #4362
  • Resolves #4211. Added new useSendStatusByActivityKey hook to check the UI send status of an outgoing activity, by @compulim in PR #4362
    • The send status returned by this hook is designed to display different UIs that reflect the "sending", "send failed" or "sent" status of the activity
    • When modifying styleOptions.sendTimeout prop, the send status returned by this hook may transition from "send failed" to "sending", and vice versa
    • This is different from the send status provided by the chat adapter, namely activity.channelData['webchat:send-status']

Fixed

  • Fixes #4293 and #4296. Fixed accessibility issues for suggested actions, by @compulim, in PR #4314
    • Centralized live region of suggested actions into chat history live region for better live region control
    • Suggested actions container is now a role="toolbar" and uses roving tab index for multiple suggested action
  • Fixes #4319. Fixed navigation keys not working in suggested actions under IE Mode, by @compulim, in PR #4320
  • Fixes #4315. Cleaned up localization strings for suggested actions, by @compulim, in PR #4323
  • Fixes #4294. Screen reader should not read message twice when navigating in the chat history, by @compulim, in PR #4323
  • Fixes #4295. Screen reader should not read suggested actions twice when message arrive in live region, by @compulim, in PR #4323
  • Fixes #4325. aria-keyshortcuts should use modifier keys according to KeyboardEvent key values spec, by @compulim, in PR #4323
  • Fixes #4327. In Adaptive Cards, TextBlock with style="heading" should have aria-level set, by @compulim, in PR #4329
  • Fixes #3949. For accessibility reasons, buttons in Adaptive Cards should be role="button" instead of role="menubar"/role="menuitem", by @compulim, in PR #4263
  • Fixes #4211. Screen reader should read when an activity was failed to send, by @compulim, in PR #4362, also fixed:
    • The "send failed" status on the activity should show up as soon as the chat adapter failed to send the activity
  • Fixes #4312. groupActivityMiddleware returning invalid value should not throw exceptions, by @compulim, in PR #4378.
  • Fixes #4386. Clicking on Adaptive Cards should not throw exception under IE11, by @compulim, in PR #4387, also fixed:
    • Prop type warning should not be shown for <ActivityRow>

Changes

Samples

[4.15.2] - 2022-05-09

Choose a tag to compare

@compulim compulim released this 09 May 21:09
cf054a8

Subresource Integrity

<script
  crossorigin="anonymous"
  integrity="sha384-+K6Bkp3HdwB6IL/MooiD8DGF4zg7iLJbYBq+ReT+PGBXW2skSoRPvF/ArXmbFD+K"
  src="https://cdn.botframework.com/botframework-webchat/4.15.2/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-lUORlicC7NzeZQx9OQ8/uCjmblHgyo9cOV4Q4UlnTct4AXwWzNiS5+4w3rCcO/h5"
  src="https://cdn.botframework.com/botframework-webchat/4.15.2/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-M00P0dYPmEonRFUbU5QwM2ozxxgVLHHbyoeOwd/x4IDxUhTBSnzbASfa4tk2yYmc"
  src="https://cdn.botframework.com/botframework-webchat/4.15.2/webchat-minimal.js"
></script>

Changelog

Breaking changes

  • A new type WebChatActivity is introduced in the botframework-webchat-core package
    • If you are previously using the type DirectLineActivity, you may need to move to this new type
    • All Web Chat APIs will use the newer type WebChatActivity
    • The new type WebChatActivity is a well-defined type for handling activities inside Web Chat
    • The existing type DirectLineActivity will be used solely for communicating with type DirectLineJSBotConnection, a.k.a. botframework-directlinejs package

Fixed

  • Fixes #4102. Fixed cldr-data-downloader package not working properly on Windows, by @compulim in PR #4223
  • Fixes #4232. Added blob: to allowed protocol list for file attachment UI (<FileContent>), by @compulim in PR #4233
  • Fixes #4204. Sort using activity.channelData['webchat:sequence-id'] and fallback to epoch time of activity.timestamp, by @compulim, in PR #4203
  • Fixes #4264. Fixed focus trap should leave when the activity no longer contains any tabbable elements (including elements with aria-disabled="true"), by @compulim in PR #4265

Added

  • Resolves #4099, added typing indicator to live region for screen reader, by @compulim, in PR #4210

Changed

[4.15.1] - 2022-03-04

Choose a tag to compare

@compulim compulim released this 04 Mar 20:25
a6b3788

Subresource Integrity

<script
  crossorigin="anonymous"
  integrity="sha384-e2zspajCn8G7DzOMi/9M6fdAPERyN5S11E5QzrAK0HXxMwyw7a6/FHLie73RUzdD"
  src="https://cdn.botframework.com/botframework-webchat/4.15.1/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-9o6xJEK8DboSm23+cyRi/6ROyiQFbCXgSN+GkpMXVtIC0QeYRPA9lD8MlXPikyub"
  src="https://cdn.botframework.com/botframework-webchat/4.15.1/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-gy9DN+p1zEnZY24LW0HtuFhmhF17qhO8QM0vlrZupIXggEUih+uYAPZ+uGCTT1f7"
  src="https://cdn.botframework.com/botframework-webchat/4.15.1/webchat-minimal.js"
></script>

Changelog

Fixed

  • Fixes #4196. Should render/mount to a detached DOM node without errors, by @compulim, in PR #4197

[4.15.0] - 2022-03-03

Choose a tag to compare

@compulim compulim released this 03 Mar 20:20
49cfdc1

Subresource Integrity

<script
  crossorigin="anonymous"
  integrity="sha384-w3rSEnqXidJWdUi5rzyfT+ge4heH7DfPfZnzwfFPqRx5s/TxTRhFbizmbX6kQe2v"
  src="https://cdn.botframework.com/botframework-webchat/4.15.0/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-TtowdQBmshxMHrPmS4fj8c7Y1++TrzO2Z7TvQ1lF9EskDY6cchxo8RO9/JT21JTL"
  src="https://cdn.botframework.com/botframework-webchat/4.15.0/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-oQJ4itwTnOHHjD3Gkl9pUfcNMZDSG9LixGJ5H5ib50uBihBhAtWkkFzvOvUK9YPj"
  src="https://cdn.botframework.com/botframework-webchat/4.15.0/webchat-minimal.js"
></script>

Changelog

Breaking changes

  • New Map object polyfill is required for IE11 when using NPM version of Web Chat:
    • Map object polyfill is not required when using ES5 bundle of Web Chat from our CDN (webchat-es5.js)
    • If you are seeing new errors while loading NPM version of Web Chat under IE11, please add a polyfill
    • We recommend core-js package, it can be loaded by import 'core-js/features/map'
    • Our current list of required polyfills can be found in packages/bundle/src/polyfill.ts
  • Style options are introduced to send button for improved accessibility:
    • suggestedActionBackground and suggestedActionXXXBackground are being deprecated in favor of suggestedActionBackgroundColor and suggestedActionBackgroundColorOnXXX respectively, for consistencies when porting to other platforms
    • suggestedActionDisabledXXX is being renamed to suggestedActionXXXOnDisabled, for consistencies with other style options
    • suggestedActionXXXOnActive, suggestedActionXXXOnFocus, suggestedActionXXXOnHover are introduced for styling per user gestures
    • suggestedActionKeyboardFocusIndicatorXXX are introduced for styling the "focus ring" when focused using a keyboard

Added

  • Adds eslint-plugin-security, consolidate .eslintrc.yml at project root, and treat warnings as errors, by @compulim, in PR #4079
  • Adds allowed protocol list to file attachment and OAuth card, by @compulim, in PR #4143

Fixed

  • Fixes #4018. When using TAB or SHIFT + TAB key to focus on the transcript, it should select the last activity, by @compulim, in PR #4035
  • Fixes #4020. With or without scan mode turned on, screen reader users should be able to press ENTER to focus on interactive activity, by @compulim, in PR #4041
  • Fixes #4021. For screen reader usability, suggested actions container should not render "Is empty" alt text initially, by @compulim, in PR #4041
  • Fixes #4029. Added new keyboard focus indicator for suggested actions, by @compulim, in PR #4035
    • New style options are introduced: suggestedActionXXXOnActive, suggestedActionXXXOnFocus, suggestedActionXXXOnHover, suggestedActionKeyboardFocusIndicatorXXX
    • Style options are renamed: suggestedActionDisabledXXX become suggestedActionXXXOnDisabled
  • Fixes #4028. Added new keyboard focus indicator for send box buttons, by @compulim, in PR #4035
    • New style options are introduced: sendBoxButtonXXXOnActive, sendBoxButtonXXXOnFocus, sendBoxButtonXXXOnHover, sendBoxButtonKeyboardFocusIndicatorXXX
  • Fixes #4015. Added role="heading" to titles of rich card, by @compulim, in PR #4074
  • Fixes #4081. Updated typing for StyleOptions.suggestedActionsStackedOverflow, by @compulim, in PR #4083
  • Fixes #4075. Added box-sizing: border-box to all descendants under Adaptive Cards, by @compulim, in PR #4084
  • Fixes #4104 and #4105. Fixed invalid entry in core/package-lock.json, removed playground/host, and added script to rebase URLs in package-lock.json, by @compulim, in PR #4106
  • Fixes #3933, #3934, #3994 and #4019, for various accessibility improvements, by @compulim, in PR #4108
    • Added a new keyboard help screen
    • Reduce repetitions when reading message content and briefier readings
    • Separated hints for links and interactive widgets
    • Focus trap when focus is on interactive attachments or Adaptive Cards
    • Using role="feed"/role="article" for chat history and its messages
    • Always assign a message to aria-activedescendant for chat history
    • Updated verbiage from "transcript" to "chat history"
    • Fixed overlapping hit zone causing clicking on bottom edge of message bubble may focus on the next activity instead
    • Fixed typings of useFocus and useLocalizer
  • Fixes #3165 and #4094. Allowlist aria-label for links in Markdown and skip unrecognized attributes or invalid curly brackets, by @compulim, in PR #4095
  • Fixes #4190. Recent Markdown curly bracket fix should not break IE11 due to unsupported "u" flag in RegExp, by @compulim, in PR #4191

Changed

Read more

[4.14.1] - 2021-09-08

Choose a tag to compare

@compulim compulim released this 08 Sep 19:30
1b842df

Subresource Integrity

<script
  crossorigin="anonymous"
  integrity="sha384-uJWBe8iPb6wN8/AaLQ0UKjgYEtWY9uIVgpkAID5kUNo2sV9hYmFbTDQXeRXyq7bl"
  src="https://cdn.botframework.com/botframework-webchat/4.14.1/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-R4Eevwf75H8RQkTqCaFNpvO0V9nq+heLX30jLGKNrAICynjuHUbMo7D2usohGsRu"
  src="https://cdn.botframework.com/botframework-webchat/4.14.1/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-Xyp6O3TOCrP+PVhd15I1Ehs8QTga7zqc/KYj6Idr9MbR10/SX5p6pSBhTAvAT/Sd"
  src="https://cdn.botframework.com/botframework-webchat/4.14.1/webchat-minimal.js"
></script>

Changelog

Fixed

Changed

[4.14.0] - 2021-07-09

Choose a tag to compare

@compulim compulim released this 09 Jul 23:08
af70aaa

Subresource Integrity

<script
  crossorigin="anonymous"
  integrity="sha384-hXz10Qsp8m3FpR+4hxcQCYezS77mZKSB/k/G62JsQqdgIAn23zLkarnuK+5Qrjz2"
  src="https://cdn.botframework.com/botframework-webchat/4.14.0/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-apZcViyYAeDhjrDJ0l1qVdlGkejY0+pIk8wsQBGc8xN1OqbWbDTjRbY2AlvgJMQW"
  src="https://cdn.botframework.com/botframework-webchat/4.14.0/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-Zj/ZWIYzMSTk+hREAhqE9Jq2whlhUh3jtWC11HH8w6KMdmAuZtJKmdvzMDLfNqDa"
  src="https://cdn.botframework.com/botframework-webchat/4.14.0/webchat-minimal.js"
></script>

Changelog

Breaking changes

  • A new style option scrollToEndButtonBehavior is introduced to control when the scroll to end button should show (formerly "new messages" button):
    • styleOptions.hideScrollToEndButton has been deprecated. To hide the scroll to end button, set styleOptions.scrollToEndButtonBehavior to false;
    • styleOptions.newMessageButtonFontSize has been renamed to styleOptions.scrollToEndButtonFontSize to better reflect its purpose.

Added

  • Cleanup repo URLs to point to main branch, by @corinagum, in PR #3870
  • Resolves #3557 and #3736. Improved test harness and added browser pooling, by @compulim, in PR #3871
  • Resolves #3788. Added localTimestamp and localTimezone (if available) to all outgoing activities, by @compulim, in PR #3896
  • Resolves #3925. Added scrollToEndButtonBehavior to control when the scroll to end button should show, removed hideScrollToEndButton, and renamed newMessagesButtonFontSize to scrollToEndButtonFontSize, by @compulim, in PR #3926.
    • Values for scrollToEndButtonBehavior:
      • If unset, will maintain same behavior as previous versions, same as "unread";
      • "unread" will show when there are any unread and offscreen messages (default);
      • "any" will show when there are any offscreen messages;
      • false will always hide the button.
    • Added new scrollToEndButtonMiddleware to customize the appearance of the scroll to end button.
  • Resolves #3752. Added typings (*.d.ts) for all public interfaces, by @compulim, in PR #3931 and #3946
  • Resolves #2316. Added blessing/priming of AudioContext when clicking on microphone button, by @compulim, in PR #3974

Fixed

Changed

Read more

[4.13.0] - 2021-04-05

Choose a tag to compare

@corinagum corinagum released this 05 Apr 20:38
585da0a

Visual breaking changes for 4.13.0

  • PR #3817
    • Markdown anchors will now include an icon and accessibility label indicating that the link will send to an external resource.

Subresource Integrity

<script
  crossorigin="anonymous"
  integrity="sha384-Xm4uX5+AacO2cl3ffEKrytyC+iHBSsNvXrJTTzodBhgkiuxIS0YWHGq1KFcf0Rr+"
  src="https://cdn.botframework.com/botframework-webchat/4.13.0/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-wwdw+KudAKGhnGV4ewfJL1KE1dqx8DgQ6TrY3z4hIHXc1GHjuI/HwoEx4p5VOGx1"
  src="https://cdn.botframework.com/botframework-webchat/4.13.0/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-WoHYVO0be3nxbYXAhMO3COEoH9aBH2TGHj/LkphxECLKvlDDsobF2v8LOzeKvGSV"
  src="https://cdn.botframework.com/botframework-webchat/4.13.0/webchat-minimal.js"
></script>

Changelog

Added

  • Resolves #3087. External links in Markdown will now be appended with an "open in new window" icon and accessibility label, by @compulim in PR #3817
  • Resolves #2100. Add types declarations for Style Options in api bundle, by @corinagum, in PR #3818

Changed

Samples