Skip to content

Releases: microsoft/BotFramework-WebChat

[4.18.0] - 2024-07-10

11 Jul 04:10
20f73e0
Compare
Choose a tag to compare

Subresource Integrity

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

<script
  crossorigin="anonymous"
  integrity="sha384-YCF4860lf811lnrrIBL4pfZ+UqiNit+8lXEhSY3R+dSc+C1rg6UnEQR5avdOTbj0"
  src="https://cdn.botframework.com/botframework-webchat/4.18.0/webchat.js"
></script>
<script
  crossorigin="anonymous"
  integrity="sha384-RuyQM7i2h9QDvJTm5quFymi0qfuWyIZocRdsgUaPIhlZnAM/Qz1/YnUxH55Dt9Rd"
  src="https://cdn.botframework.com/botframework-webchat/4.18.0/webchat-es5.js"
></script>
<script
  crossorigin="anonymous"
  integrity="sha384-YXzfTEuq6x+8VEBZcHmPE9rM+NpSTVfRQsU1X0v4drgjp3S4F8d8rnq/anR3WLpj"
  src="https://cdn.botframework.com/botframework-webchat/4.18.0/webchat-minimal.js"
></script>

Changelog

[4.18.0] - 2024-07-10

Added

  • (Experimental) Added initial decorators support, in PR #5205, by @OEvgeny
    • Introduced internal botframework-webchat-api/decorator import, in PR #5205, by @OEvgeny
    • Added DecoratorComposer and ActivityDecorator to be used for decorating activity border, in PR #5205, by @OEvgeny

Fixed

  • Read deeper into citation objects in order to provide names, in PR #5215, by @beyackle2
  • Improved performance for useActivityWithRenderer, in PR #5172, by @OEvgeny
  • Fixes #5162. Improved performance for useActivityTreeWithRenderer, in PR #5163, by @compulim
  • Fixes #5175. PrecompiledGlobalize.js is emitted instead of .cjs, by @compulim in PR #5181
  • Improved performance for BasicTranscript, in PR #5183, by @OEvgeny
  • Fixed potential memory usage issues caused by useActivitiesWithRenderer, in PR #5183, by @OEvgeny
  • Improved performance for useMemoized, in PR #5190, by @OEvgeny
  • Fixed send box zoomed in when clicked on mobile Safari, in PR #5192, by @OEvgeny
  • Added missing support for chat history scroll with keyboard when Fluent send box is focused, in PR #5191, by @OEvgeny
  • Fixed DTMF command usage sent by telephone keypad, in PR #5198, by @OEvgeny
  • Fixed decorator import in legacy CommonJS environments, in #5231, by @OEvgeny

Changed

[4.17.0] - 2024-05-07

07 May 21:25
f03d1f0
Compare
Choose a tag to compare

Subresource Integrity

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

<script
  crossorigin="anonymous"
  integrity="sha384-JrrxPK4UiMUpQfRYck+TH35vDgpZLtot9HqkG6F/pbubNCnNyRCYEbQ0mXH2z8s2"
  src="https://cdn.botframework.com/botframework-webchat/4.17.0/webchat.js"
></script>
<script
  crossorigin="anonymous"
  integrity="sha384-N+hZt09yrG7gT/xDkupYZeFnCoFR1S4ig9v3h1liavEgPm9C+Lt4MFPv85gfBp6E"
  src="https://cdn.botframework.com/botframework-webchat/4.17.0/webchat-es5.js"
></script>
<script
  crossorigin="anonymous"
  integrity="sha384-Z6hLc33tM1RVHGaYJbzrd6XkfxUwB+q4915W9K9ogwYqpIIew3oHhDfEzCfk1JgD"
  src="https://cdn.botframework.com/botframework-webchat/4.17.0/webchat-minimal.js"
></script>

Changelog

[4.17.0] - 2024-05-06

Known issues

  • Web Chat is not loading with error Uncaught TypeError: Super constructor null of anonymous class is not a constructor

Breaking changes

  • useSendMessage hook is updated to support sending attachments with a message. To reduce complexity, the useSendFiles hook is being deprecated. The hook will be removed on or after 2026-04-03
  • styleOptions.uploadThumbnailHeight and styleOptions.uploadThumbnailWidth must be a number of pixels
  • useSuggestedActions type is updated to align with its actual implementation, by @OEvgeny, in PR #5122
  • Removed deprecated code: connect*, useRenderActivity, useRenderActivityStatus, useRenderAvatar, in PR #5148, by @compulim
  • Added named exports in both CommonJS and ES Modules module format, in PR #5148, by @compulim
  • Removed deprecated useFocusSendBox() hook, please use useFocus('sendBox') instead, in PR #5150, by @OEvgeny
  • HTML-in-Markdown is now supported. To disable this feature, set styleOptions.markdownRenderHTML to false

Added

  • Resolves #5083. Added sendAttachmentOn style option to send attachments and text in a single activity, by @ms-jb and @compulim, in PR #5123
    • useSendMessage hook is updated to support sending attachments with a message
    • useSendBoxAttachments hook is added to get/set attachments in the send box
  • Resolves #5081. Added uploadAccept and uploadMultiple style options, by @ms-jb, in PR #5048
  • Added sendBoxMiddleware and sendBoxToolbarMiddleware, by @compulim, in PR #5120
  • (Experimental) Added botframework-webchat-fluent-theme package for applying Fluent UI theme to Web Chat, by @compulim and @OEvgeny
    • Initial commit, in PR #5120
    • Inherits Fluent CSS palette if available, in PR #5122
    • New send box with Fluent look-and-feel, in PR #5122
      • styleOptions.maxMessageLength to specify maximum length of the outgoing message
    • Drag-and-drop file support, in PR #5122
    • Added telephone keypad (DTMF keypad), in PR #5122
    • Fixed botframework-webchat-fluent-theme/package.json to export *.d.[m]ts and default exports, in PR #5131
    • Added support of styleOptions.hideUploadButton, in PR #5132
    • Added styleOptions.hideTelephoneKeypadButton and default to true, in PR #5132
    • Fit-and-finish on suggested actions and telephone keypad, in PR #5132
    • Fixed to keep telephone keypad on-screen on click, in PR #5132
    • Disabled send button and hid message length when telephone keypad is shown, in PR #5136
    • Added dark theme support, in PR #5138
    • Added an information message to the telephone keypad, in PR #5140
    • Added animation to focus indicator and pixel-perfected, in PR #5143
    • Integrated focus management for send box, in PR #5150, by @OEvgeny
    • Added keyboard navigation support into suggested actions, in PR #5154, by @OEvgeny
    • Fixes #5166. Fixed "attach file" button in iOS Safari should looks the same as on other platforms, in PR #5167, by @compulim
  • (Experimental) Added <LocalizeString /> component which can be used to localize strings, by @OEvgeny in PR #5140
  • Added <ThemeProvider> component to apply theme pack to Web Chat, by @compulim, in PR #5120
  • Added useMakeThumbnail hook option to create a thumbnail from the file given, by @compulim, in PR #5123 and #5122
  • Added moduleFormat and transpiler build info to <meta> tag, in PR #5148, by @compulim
  • Added support of rendering HTML-in-Markdown, in PR #5161 and PR #5164, by @compulim, @beyackle2, and @OEvgeny

Fixed

  • Fixes #5050. Fixed focus should not blur briefly after tapping on a suggested action, by @compulim, in PR #5097
  • Fixes #5111. Fixed keyboard help screen to use HTML description list, by @compulim, in PR #5116
  • Fixes #5080. Fixed dateToLocaleISOString for handling sub-hour, by @marclundgren, in PR #5114
  • Fixes #5146. Fixed chat history focus indicator should not show up on tap, by @OEvgeny, in PR #5145
  • Fixes type portability issues by exporting types from all exported code, in PR #5148, by @compulim
  • Fixes missing exports of useNotifications, in PR #5148, by @compulim
  • Fixes suggested actions keyboard navigation skips actions after suggested actions got updated, in PR #5150, by @OEvgeny
  • Fixes #5155. Fixed "Super constructor null of anonymous class is not a constructor" error in CDN bundle by bumping to [email protected], in PR #5156, by @compulim

Changed

Read more

[4.16.0] - 2023-11-16

17 Nov 23:52
ab8ab69
Compare
Choose a tag to compare

Subresource Integrity

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

<script
  crossorigin="anonymous"
  integrity="sha384-4LcbsBbx9Pr+/7Hm0HxHOuhHMFlbf4ecmHUekoAnbBRiURTJx3HaaLuo7PrP1aBD"
  src="https://cdn.botframework.com/botframework-webchat/4.16.0/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-fhdXAQj5PD+9CBeiZ3dGYjJ3mzH1DePD30cKtJKWzGxyioYiNYOaw5oRw7+AMg+e"
  src="https://cdn.botframework.com/botframework-webchat/4.16.0/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-7tv7NO7xJd/dCNFy3qBd+Nxqhbi2Zx+Voh6YuCr4BqwoIMRevb4O89giG8kshrCF"
  src="https://cdn.botframework.com/botframework-webchat/4.16.0/webchat-minimal.js"
></script>

Changelog

Breaking changes

  • Starting from 4.16.0, Internet Explorer is no longer supported
    • After more than a year of the Internet Explorer 11 officially retirement, we decided to stop supporting Internet Explorer. This will help us to bring new features to Web Chat
    • 4.15.9 is the last version which supports Internet Explorer in limited fashion
  • useTextBoxValue setter will no longer replace emoticon with emoji, in PR #4861

Fixed

  • Fixes #4865. Fixed CTRL + Z should undo correctly, by @compulim, in PR #4861
  • Fixes #4863. Disable dark theme for link references until chat history has dark theme support, by @compulim, in PR #4864
  • Fixes #4866. Citation modal show fill screen width on mobile device and various fit-and-finish, by @compulim, in PR #4867
  • Fixes #4878. createStore should return type of Redux.Store, by @compulim, in PR #4877
  • Fixes #4957. Native chevron of the accordion in citation should be hidden, by @compulim, in PR #4958

Added

[4.15.9] - 2023-08-25

26 Aug 00:37
3eeebe4
Compare
Choose a tag to compare

Subresource Integrity

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

<script
  crossorigin="anonymous"
  integrity="sha384-kr+6QqBRD45fWiraMYzQdm0CpHzmKMtNk0gRLBVqa379eQdjCHNnm8jfmAhiOQnI"
  src="https://cdn.botframework.com/botframework-webchat/4.15.9/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-04jpTOxuj3fbYmyDC2/jU3rdwhoC4OWnNbo6zh6RNEq+qvzNggRWDzdN788GnXs6"
  src="https://cdn.botframework.com/botframework-webchat/4.15.9/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-nCB7vnhkKK/wLHWq8fqOaZM5YlsR0X/6FcS31MOnl7aYmMB+qo3qPp0hacahdAbN"
  src="https://cdn.botframework.com/botframework-webchat/4.15.9/webchat-minimal.js"
></script>

Changelog

Fixed

  • Fixes #4718. In high contrast mode, Adaptive Card buttons, when pushed, should highlighted properly, by @compulim, in PR #4746
  • Fixes #4721 and #4726. Adaptive Cards TextBlock heading elements should start at level 2, by @compulim, in PR #4747
  • Fixes #3699. Correcting timestamp roundoff, by @compulim, in PR #4821

[4.15.8] - 2023-06-06

07 Jun 19:39
5922488
Compare
Choose a tag to compare

Subresource Integrity

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

<script
  crossorigin="anonymous"
  integrity="sha384-4vGD9F0KRTew8maUTxtkCq0vbJDB+o05wRdhSEP3HGU6P6Nob7gt+OG//fYfvbYL"
  src="https://cdn.botframework.com/botframework-webchat/4.15.8/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-aMT2td/gP8Wy5N+3pVTV0Wc85z8P9UoNGMZbLEHr8kqbySXFXGLJ1uzwYUGVmIQe"
  src="https://cdn.botframework.com/botframework-webchat/4.15.8/webchat-es5.js"
></script>

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

Changelog

Breaking changes

  • When activity.channelData['webchat:fallback-text'] is present but empty, it will no longer applies aria-hidden to the activity
    • The activity will not be narrated through live region. However, when navigating the transcript, it will be narrated as empty
    • To make an activity presentational or hide from screen reader, please use activityMiddleware to customize the rendering

Added

  • Resolved #4643. Decoupling botframework-directlinejs from business logic of Web Chat for better tree-shaking, by @compulim, in PR #4645 and PR #4648
  • Resolved #4650. Added automated accessibility check using axe-core
    • Add axe-core in end-to-end tests, by @compulim, in PR #4704
    • HTML test: using <main> for the root container, by @compulim, in PR #4684 and PR #4704
    • HTML test: changed contrast ratio in tests that use different background colors, by @compulim, in PR #4686 and PR #4704
    • Added ponyfill prop to <ReactWebChat>/<Composer> and createStoreWithOptions, by @compulim, in PR #4662
      • This is for development scenarios where fake timer is needed and will only applies to Web Chat only
    • HTML test: fix accessibility issues on HTML file, by @compulim, in PR #4685
    • HTML test: ensure all images has alternate text, by @compulim, in PR #4704
    • Adaptive Cards: always set role attribute, by @compulim, in PR #4704
    • Adaptive Cards: update host config to use lighter color for disabled inputs, by @compulim, in PR #4704
    • Keyboard help screen: remove <header> container, by @compulim, in PR #4704
    • Live region: added <label> for input fields in Adaptive Cards, by @compulim, in PR #4704

Fixed

  • Fixes #4557. Flipper buttons in carousels and suggested actions is now renamed to "next/previous" from "left/right", by @compulim, in PR #4646
  • Fixes #4652. Keyboard help screen, activity focus traps, and chat history terminator should not be hidden behind aria-hidden because they are focusable, by @compulim, in PR #4659
  • Fixes #4665. Updated development server with latest ESBuild API, by @compulim, in PR #4662.
  • Fixes #4706. Send button and ENTER key should function after reconnected, by @compulim, in PR #4707.
  • Fixes #4708. Should function properly in browsers without setImmediate or without passing store prop, by @compulim, in PR #4709.

Changed

Read more

v4.15.7

16 Feb 01:33
5b1b942
Compare
Choose a tag to compare

Subresource Integrity

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

<script
  crossorigin="anonymous"
  integrity="sha384-fUKSEwGc3/WXaZ4SN0Mm5DglQXbtPJFIgeN79b369v6duzoU3wP1Ix9zdxugfDBR"
  src="https://cdn.botframework.com/botframework-webchat/4.15.7/webchat.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-1T+LvOs6/1ShG/+c7tarxIR/J0dUIjrba2M9SbyOv9Ls8ElcnhLZFnLGdiVf/u4W"
  src="https://cdn.botframework.com/botframework-webchat/4.15.7/webchat-es5.js"
></script>

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

Changelog

Added

  • Added function to emit status change telemetry event for activities, by @Erli-ms, in PR #4631
  • Added ability for developers to customize Web Chat by extending the default UI without having to re-implement existing components, by @dawolff-ms, in PR #4539

Fixed

  • Fixes #4558. In high contrast mode, "Retry" link button should use link color as defined by CSS System Colors, by @beyackle2 in PR #4537
  • Fixes #4566. For YouTube and Vimeo <iframe>, add sandbox="allow-same-origin allow-scripts", by @compulim in PR #4567
  • Fixes #4561. Header title of keyboard help dialog should be the aria-labelledby of the dialog and close button should be the first element of the header, by @compulim in PR #4609
  • Fixes #4559. Keyboard help screen should be scrollable and its close button should appear correctly in light-themed high contrast mode, by @compulim in PR #4619
  • Fixes #4623. Screen reader should read error when failed to send an empty message or offline, by @compulim in PR #4637

Changed

[4.15.6] - 2022-12-01

02 Dec 03:55
0af2437
Compare
Choose a tag to compare

Subresource Integrity

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

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

<script
  crossorigin="anonymous"
  integrity="sha384-Ik2jNknNTBCaI/NP3GRMfDCWKnApGSdYMcdA6EtEJkL1LtUZEdNdjeNkfZZk3UlS"
  src="https://cdn.botframework.com/botframework-webchat/4.15.6/webchat-es5.js"
></script>

<script
  crossorigin="anonymous"
  integrity="sha384-PH82AmArERnsV9DCQozdeAUGwiuy/1cchDvHaQmgdS9+/qvWqX2lY3rwz7aPpCYN"
  src="https://cdn.botframework.com/botframework-webchat/4.15.6/webchat-minimal.js"
></script>

Changelog

Fixed

  • Fixes #4501. Outgoing activities restored from chat service should be marked as sent, by @compulim in PR #4532

Changed

[4.15.5] - 2022-11-16

17 Nov 00:03
df55e01
Compare
Choose a tag to compare

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 [email protected] 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

18 Sep 02:04
2348572
Compare
Choose a tag to compare

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

07 Sep 07:05
Compare
Choose a tag to compare

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