Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Flex UI Release Notes for v1.x.x


(information)

Info

This page includes the release notes related directly to Flex UI for versions 1.x.x. You can find release notes for v 2.x.x. here and for updates on other components of Flex Platform visit the Twilio Changelog(link takes you to an external page) and select the Flex product.

For detailed description of Flex UI public interfaces with code examples for each Flex UI version, visit our Flex UI API docs(link takes you to an external page).

Changes to Sync usage in Flex UI

What has been done?

what-has-been-done page anchor

In Flex UI version 1.33 we introduced updates to some internal operations within Flex UI to no longer rely on data provided by Sync. This included Conference state management as well as Outbound calls and Transfer workflows. All of these now get data from TaskRouter SDK instead of Sync. This was done to reduce the number of dependencies in these workflows for better performance and increased resilience in the event of an incident. Flex UI versions 2.0 and above also include the same changes to Sync usage inside Flex UI.


This change only affects the internal operation of Flex UI and does not introduce any breaking changes that customers should be aware of. However, there are some UI changes that you may see.

Sync limits on data retention no longer limit the fetching of workers and queues

sync-limits-on-data-retention-no-longer-limit-the-fetching-of-workers-and-queues page anchor

Sync only stores data for 30 days since the last change to a status. This affects lists of workers (users) and queues that previously did not include workers or queues that had no change for 30 days. The parts of Flex UI that no longer use Sync can now fetch all workers and queue no matter when the last change was made.

Effect on Flex user experience

  • When transferring a call, the lists of workers and queues now show all possible workers and queues.
  • When making an outbound call, all queues are available to be selected.

Under the hood, Flex UI now receives and displays Conference information from an alternative backend service, Flex Orchestrator, rather than Sync Maps. However, the same information is still published to Sync Maps in order to enable backwards compatibility with Flex UI customizations and plugins. In cases where a Flex customization makes heavy use of Conference data for advanced call use cases, there is the potential for inconsistencies in the UI. So far we have had a report of duplicate 'Left call' participants appearing in the call canvas. This particular issue was reported for a customer plugin based on this Twilio Professional Services plugin(link takes you to an external page) that renders participants of a call. The workaround for these inconsistencies is to use the native outbound dialer now built directly into Flex.

Flex UI now fetches workers and queues from an alternative backend service, Task Router, rather than Sync Maps. Workers and queues are soft deleted from Sync Maps after 30 days of inactivity, but this is not true of Task Router. This means more workers and/or queues may appear in the transfer directory than before.

Hidden worker and queue filters

hidden-worker-and-queue-filters page anchor

The hiddenWorkerFilter and hiddenQueueFilter default props on the WorkerDirectoryTabs dynamic component(link takes you to an external page) can be used to filter the workers and queue that appear in the transfer directory.


Is Sync still used in Flex UI?

is-sync-still-used-in-flex-ui page anchor

Yes. We have only removed it from the parts of Flex UI mentioned above.

Can I still use Sync for customizations?

can-i-still-use-sync-for-customizations page anchor

Yes, Sync can still be used for building additional functionality on top of Flex. Flex is still populating Sync with the same data as it did before.

Will Sync be removed from other parts of Flex UI?

will-sync-be-removed-from-other-parts-of-flex-ui page anchor

We are currently evaluating other workflows that currently use Sync that could be improved by reducing dependencies.

What should I do if I find a difference in behavior between 1.32 and below and 1.33 or 2.0 and above?

what-should-i-do-if-i-find-a-difference-in-behavior-between-132-and-below-and-133-or-20-and-above page anchor

Please contact Support(link takes you to an external page) to report any changes between these versions.


@twilio/flex-ui@1.34.6

release date January 18, 2024


@twilio/flex-ui@1.34.5

release date November 1, 2023

  • Updated the Voice SDK to version 1.15.1 . Voice SDK 1.15.1 fixes a Chrome issue where audio is choppy when another application is also using the audio devices.

@twilio/flex-ui@1.34.4

release date September 27, 2023

  • Added support for Google Chrome's experimental Storage Partitioning feature. Previously, enabling this feature prevented users from logging in to Flex using SSO, particularly in environments using Flex inside of an iframe.

@twilio/flex-ui@1.34.3

release date August 21, 2023

  • Fixed an issue with SDK auto-reconnect if initialization fails
  • Fixed an issue where the Status Report could be opened while disabled from a notification
  • Fixed an issue with the 'Clear Issues' button on Status Reports disappearing in dark mode.
  • Fixed a broken hyperlink to Twilio marketplace in Chat Info.
  • Fixed an issue where hyperlinks for '.me' URLs were not enabled in Webchat.

@twilio/flex-ui@1.34.2

release date July 14, 2023

  • Increased timeout interval for certain SDKs to address initialization issues

@twilio/flex-ui@1.34.1

release date June 28, 2023

  • Fixed logging issues in Flex Configuration API enabling custom settings.
  • Fixed initialization issues using timeout for dependencies.

@twilio/flex-ui@1.34.0

release date Apr 20, 2023

  • Changes introduced in UI 1.33 for 'Sync removal from critical path of outbound, transfer and conference state' have been reverted and behavior present in UI 1.32 is restored. For more info on the Sync removal changes, refer to the section 'Changes to Sync usage in Flex UI' in the Flex UI release notes .
  • Added support for multiple country codes for the Dominican Republic in the Flex dialpad
  • Fixed issue around incorrect notification for missing recording when authenticated recording is enabled.
  • Fixed issue around userLoggedIn Flex event not getting triggered
  • Fixed issue around SideLink added by a plugin not getting displayed correctly
  • Fixed issue around Unhold not working correctly when agents transfer call to themselves via a queue.
  • Fixed issue around external participant name disappearing when call is put on hold for external warm transfers.

@twilio/flex-ui@1.33.3

release date Feb 21, 2023

  • Fixed issue around increased plugin load time
  • Addressed issue with Teams page not displaying the list of workers correctly when the hidden filter property is configured for filtering agents
  • We have had reports of intermittent issues with call hold state, where the actual hold state and UI hold state are inconsistent. This is being actively investigated. Please see Changes to Sync usage in Flex UI for more details.

@twilio/flex-ui@1.31.3

release date Dec 15, 2022

  • Fixed issue with token refreshment behavior

@twilio/flex-ui@1.33.2

release date Dec 14, 2022

  • Fixed issue with token refreshment behavior
  • We have had reports of intermittent issues with call hold state, where the actual hold state and UI hold state are inconsistent. This is being actively investigated. Please see Changes to Sync usage in Flex UI for more details.

@twilio/flex-ui@1.32.3

release date Dec 14, 2022

  • Fixed issue with token refreshment behavior

@twilio/flex-ui@1.33.1

release date Dec 9, 2022

  • Updated messages in Status report and Degraded mode notifications
  • We have had reports of intermittent issues with call hold state, where the actual hold state and UI hold state are inconsistent. This is being actively investigated. Please see Changes to Sync usage in Flex UI for more details.

@twilio/flex-ui@1.32.2

release date Dec 8, 2022

  • Updated messages in Status report and Degraded mode notifications

@twilio/flex-ui@1.33.0

release date Nov 21, 2022

  • Removed Sync backend from critical path of outbound, transfer and conference state.
  • Worker and Queue lists now fetch all available items and are no longer restricted to items with updates in the last 30 days.
  • Minor text updates to Status Report
  • Correct Insights dashboards are now shown based on permissions
  • Fixed an issue preventing audio constraints from being applied to the device audio
  • Disabled Degraded notification when user token has expired
  • We have had reports of intermittent issues with call hold state, where the actual hold state and UI hold state are inconsistent. This is being actively investigated. Please see Changes to Sync usage in Flex UI for more details.

@twilio/flex-ui@1.32.1

release date Nov 10, 2022

  • Fixed an issue with type definitions that prevented some customers from creating new plugins.

@twilio/flex-ui@1.32.0

release date Sep 29, 2022

  • Consume flex-sdk 0.13.0.
  • Fetch all queue stats data before updating store on initialization to improve performance.
  • Moved Debugger UI to Status Report and released to GA.
  • Resolved an issue where Hosted Flex users were not automatically logged in to Flex UI after providing their Twilio account details.
  • Users can no longer interact with Status report (formerly Debugger UI) when the token has expired.
  • Fixed a bug in Historical Reporting where segment links were not clickable in created KPI dashboards.
  • Fixed an issue where remote config loglevel was not being applied correctly to SDK logs.
  • Restore loginHandler functionality inside Flex store.
  • Add critical error parsing to provideLoginInfo.
  • The downloadable report provided by Status report now includes a summary of the user's degraded mode state and information about Twilio service status.
  • Flex UI will now wait for plugins to complete initialization after login before moving on.

@twilio/flex-ui@1.31.2

release date Jun 28, 2022

  • Fixed an issue with loginHandler session not being supported in the previous version.

@twilio/flex-ui@1.31.1

release date Jun 6, 2022

  • During login, after redirection from SSO provider, Flex will no longer ask to re-enter runtime domain for the second time.

@twilio/flex-ui@1.31.0

release date May 18, 2022

Degraded mode - now Flex UI will initialize with limited capabilities, even if some of the components like SDK's (TaskRouter, Conversations, Voice or Sync) are down. This allows users to login to Flex even during a partial disruption of services and use the unaffected functionality. Learn more about degraded mode in our docs.

  • Expired tasks will no longer be kept in redux store on worker init
  • MessageBubble will now be able to handle null message body
  • Markdown links without protocol prefix will no longer be interpreted as internal links

@twilio/flex-ui@1.28.2

release date Feb 07, 2022

  • Overlay Player support for new address format of drill down links in Flex Insights Historical Reporting.

@twilio/flex-ui@1.29.3

release date Feb 07, 2022

  • Overlay Player support for new address format of drill down links in Flex Insights Historical Reporting.

@twilio/flex-ui@1.30.2

release date Feb 03, 2022

  • Overlay Player support for new address format of drill down links in Flex Insights Historical Reporting.

@twilio/flex-ui@1.30.1

release date Jan 17, 2022

  • A fix to avoid using useState in chat channel reducer which caused Chat messages to fail to load in some instances

@twilio/flex-ui.1.30.0

  • Real Time Queue Monitoring with SLA GA. See Twilio Changelog for more details.
  • The logLevel setting in the Flex Configuration object now also applies to the underlying Flex SDKs
  • Fixed session issues related to Flex Insights Analytics Portal
  • Fixed an issue with deactivating chat channels which are created during plugin initialization

@twilio/flex-ui@1.29.2

release date Jan 19, 2022

This release contains fixes to our pilot or private beta features.


@twilio/flex-ui@1.29.1

release date Dec 01, 2021

  • Fixed bug with isCallTask handlebar helper function

@twilio/flex-ui@1.29.0

release date Nov 10, 2021

  • Improvements to Flex Dialpad:
    • Zero key can now be long pressed to enter a +
    • Backspace now deletes last entered digit

@twilio/flex-ui@1.28.1

release date Oct 19, 2021

  • Fixed an issue where plugins were not loading correctly for customers who were hosting their own flex-ui library

@twilio/flex-ui@1.28.0

release date Sep 30, 2021

  • Flex Dialpad is now GA! This release brings improvements in quality and reliability and solves several known limitations . For more information, refer to the Flex Dialpad documentation
  • An audio device will now be checked readiness before placing the call and handle errors related to audio device errors when placing outbound calls
  • To avoid several clashing concurrent calls, placing outbound calls when having another call ongoing will now be disabled.
  • Fixed an issue where an unsupported file could be pasted to the chat
  • Fixed an issue where chat date separator was positioned incorrectly

@twilio/flex-ui@1.27.0

release date Jun 21, 2021

  • Programmable access to workspace-level queue statistics has changed since the release of Real Time Queue Monitoring with SLA Private Beta. Please review the latest programmability documentation .
  • For workers without activity changes in the last 30 days Teams View no longer shows NaN as the activity duration

@twilio/flex-ui@1.26.3

release date June 7, 2021

  • Upgraded Handlebars version to 4.7.7

@twilio/flex-ui@1.26.2

release date June 3, 2021

  • Notification for unexpected token expiry. If the user's access token is removed from local storage for whatever reason, they receive a notification to refresh the page in order to refresh their token.
  • More verbose logging around SSO login functionality for debugging purpose

@twilio/flex-ui@1.26.1

release date May 13, 2021

  • Transfer directory hidden filters - Now you can programmatically pre filter the list of agents or queues in the transfer directory. WorkerDirectoryTabs accepts 2 new default props hiddenWorkerFilter and hiddenQueryFilter which are filters that are applied to the list together with the filter applied due to user typing in the search string. For example, you can choose to display and search only agents with available status. To learn more about Transfer directory hidden filters, go to Flex docs .
  • ApplyListFilters and ResetListFilters actions are now emitted when the apply or reset button is clicked in TeamsView filters. To learn more about Actions Framework go to our Flex UI Programmability docs .
  • Browser Notifications and Markdown for Web Chat are now Generally Available and can be turned on in Flex settings(link takes you to an external page)
  • Error reporting - Flex UI will now be reporting on errors that end-users experience. This will help us continuously improve the quality of the application and get more insights into issues that need troubleshooting. To read more about ways to troubleshoot Flex UI, including how you can opt out of error reporting, go to Flex docs
  • Deprecated unintentionally exported private interfaces Flex.ErrorManager.processError and Flex.ErrorManager.createAndProcessError
  • Fixed an issue where agent changing activity to the same one resulted in an error
  • WorkerDirectoryTabs can now be accessed directly and not just through WorkerDirectory.Tabs
  • Star rating in Conversation screen now renders correctly
  • Negative time values in Conversation Screen comment tooltip are now correctly formatted
  • Added error notification when copy to clipboard fails because Flex is embedded in iframe without copying to clipboard disabled ( allow="clipboard-write” )
  • Initiating outbound calling will now be disabled, while another outbound call is being attempted
  • Transfer directory will now be closed automatically, if the call is disconnection
  • Fixed Player waveform render issues on displays with higher pixel ratio
  • Fixed an issue where fast switching between tasks in Teams View caused uncaught exception
  • Initiate transfer button in Call Canvas now has a tooltip

@twilio/flex-ui@1.26.0

release date May 11, 2021

  • Transfer directory hidden filters - Now you can programmatically pre filter the list of agents or queues in the transfer directory. WorkerDirectoryTabs accepts 2 new default props hiddenWorkerFilter and hiddenQueryFilter which are filters that are applied to the list together with the filter applied due to user typing in the search string. For example, you can choose to display and search only agents with available status. To learn more about Transfer directory hidden filters, go to Flex docs .
  • ApplyListFilters and ResetListFilters actions are now emitted when the apply or reset button is clicked in TeamsView filters. To learn more about Actions Framework go to our Flex UI Programmability docs .
  • Browser Notifications and Markdown for Web Chat are now Generally Available and can be turned on in Flex settings(link takes you to an external page)
  • Error reporting - Flex UI will now be reporting on errors that end-users experience. This will help us continuously improve the quality of the application and get more insights into issues that need troubleshooting. To read more about ways to troubleshoot Flex UI, including how you can opt out of error reporting, go to Flex docs
  • Deprecated unintentionally exported private interfaces Flex.ErrorManager.processError and Flex.ErrorManager.createAndProcessError
  • Fixed an issue where agent changing activity to the same one resulted in an error
  • WorkerDirectoryTabs can now be accessed directly and not just through WorkerDirectory.Tabs
  • Star rating in Conversation screen now renders correctly
  • Negative time values in Conversation Screen comment tooltip are now correctly formatted
  • Added error notification when copy to clipboard fails because Flex is embedded in iframe without copying to clipboard disabled ( allow="clipboard-write” )
  • Initiating outbound calling will now be disabled, while another outbound call is being attempted
  • Transfer directory will now be closed automatically, if the call is disconnection
  • Fixed Player waveform render issues on displays with higher pixel ratio
  • Fixed an issue where fast switching between tasks in Teams View caused uncaught exception
  • Initiate transfer button in Call Canvas now has a tooltip

@twilio/flex-ui@1.25.4

release date APR 19, 2021

  • Fixed the issue in Player that prevented from playing recordings provided via custom media links in case the recordings were different for different segments within a single conversation

@twilio/flex-ui@1.25.3

release date MAR 31, 2021

  • Fixed the issue in Player causing Flex UI to crash when custom media links are provided with invalid or missing start time

@twilio/flex-ui@1.25.2

release date MAR 16, 2021

  • Increased max number of event listeners for the events of Notifications Framework that resulted in MaxListenersExceededWarning in console
  • Fixed voice client connection initiation when agent is using a sip endpoint

@twilio/flex-ui@1.25.1

release date FEB 26, 2021

  • Characters being dropped intermittently when typing in the input field of Messaging Canvas

@twilio/flex-ui@1.25.0

release date FEB 24, 2021

  • Improvements to Flex UI troubleshooting experience with release of:
    • Debugger UI allowing users of Flex UI to get error notifications and download report with full error descriptions and logs. Debugger UI can be enabled for your account via a Pre-release Feature Flag(link takes you to an external page)

      Error notifications debugging UI.
    • Flex UI programmable interfaces that provide ability to retrieve errors and logs programmatically and implement customized error monitoring and reporting


      _10
      import { Monitor } from "@twilio/flex-ui";
      _10
      _10
      Monitor.getErrors(); // returns { errors: [Monitor.FlexErrorJSON] }
      _10
      Monitor.getLogs(); // returns { logs: 'string' }

To learn more about Flex UI troubleshooting, Debugger UI and programmatic access to errors and logs, visit our Flex docs and Flex UI API Reference(link takes you to an external page).

  • Teams View advanced filters now show legacy custom filters as an additional filtering option in the side bar. You can now use Advanced Filters without losing access to filters you have defined programmatically via the WorkersDataTable.defaultProps.filters API. Learn more about advanced filters in Flex documentation and programmability guide . We encourage you to migrate to the advanced filters that provide greater flexibility for the end users.
  • Flex Insights overlay player now enables to switch between Segments of a single Conversation without need to go to Conversation Screen. So if a call was transferred you can listen to all parts of the call without leaving Flex Insights dashboards.
  • Transfers:
    • It will no longer be possible to transfer to the agent that is unavailable
    • Transfer Directory will now close automatically when switching between tasks
  • Native Dialpad:
    • Default Task Queue will now always visible in Native Dialpad Queue dropdown
    • Fixed copy for the error notifications that worker receives while attempting to make an outbound call to the disabled country
  • Fixed the markdown code element overflow bug
  • Fixed token refresh issue - invalidated sessions will no longer update the access token
  • Worker has no longer access to the incoming task content after refreshing the page

@twilio/flex-ui@1.24.3

release date FEB 15, 2021

  • More improvements to token refresh issues - invalidated sessions will no longer update the access token
  • Fixed a dependency versions conflict ( react-select and emotion ) where importing flex-ui in Jest unit tests could sometimes break

@twilio/flex-ui@1.24.2

release date JAN 25, 2021

  • An issue with refreshing of the token

@twilio/flex-ui@1.23.4

release date JAN 25, 2021

  • An issue with refreshing of the token

@twilio/flex-ui@1.24.1

release date JAN 14, 2021

  • A bug where playback speed of a recording in Conversation Player would reset after secure recording URL expiry and refresh.
  • A bug where playahead no longer briefly jumped to zero, when secure recording URL is refreshed
  • [axios] to version 0.21.1.
  • [twilio-client] to version 1.13.1.

@twilio/flex-ui@1.24.0

release date DEC 9, 2020

  • Markdown feature improvements including support for new elements (headings, ordered lists, code snippets, block quotes) and several bugfixes. Note , implementation now relies more on semantic HTML, so if you have styled generic html elements, keep an eye on how they look in chat.
  • In Outbound dialpad, in case of the default queue not being available in the queue selector, we will now leave selection empty and disable outbound call button
  • ToggleSidebar action called twice when sidebar is already collapsed
  • Improvements and fixes in Flex Insights Conversation Screen and Player
  • [twilio-taskrouter] to version 0.5.2
  • Updated @gooddata/gooddata-js to version 13.2.0

@twilio/flex-ui@1.23.3

release date DEC 2 2020

  • Fixed regression in Flex Insights that prevented users from playing some recordings stored outside of Twilio

@twilio/flex-ui@1.23.2

release date NOV 23 2020

  • Minor internal bugfixes

@twilio/flex-ui@1.23.1

release date NOV 16 2020

  • Real-time Queue Stats Public Beta can now show more than 50 queues
  • N/A answers are supported for questions with 5 star rating when assessing a conversation in Flex Insights
  • Improvements and fixes in Flex Insights Conversation Screen and Player

@twilio/flex-ui@1.23.0

release date NOV 09 2020

  • Usability improvements for Conversation Screen - now when users drill down to individual conversations they stay in the Flex UI. Former Conversation Screen is still available but will be deprecated.
  • New enableReduxLogging flag in AppConfig that will help developers to fine-tune their preferred logging level of redux action
(information)

Info

New versions of dependencies can contain changes in internal APIs that we do not document in release notes. If you're using any undocumented apis of upgraded dependencies, please review your code and update your customizations as needed. Any changes in undocumented api's are not considered breaking changes, however, if you are using them, this might break your customizations.

Example: This version of chat-sdk contains changes in internal API. To access channel attributes, channel.attributes is supported as per https://media.twiliocdn.com/sdk/js/chat/releases/3.4.0/docs/Channel.html(link takes you to an external page) and not channel.state.attributes.


@twilio/flex-ui@1.22.2

release date OCT 27 2020

  • [handlebars] upgraded to version 4.7.6
  • [twilio-chat] reverted to 3.2.4 (update to version 3.4.0 will be done in 1.23.0 release)

@twilio/flex-ui@1.22.1

release date OCT 21 2020

  • Dragging & dropping text into chat text input
  • Updated lodash transient dependency in CDN bundle to remove a security vulnerability
  • [twilio-chat] upgraded to 3.4.0
  • [twilio-sync] upgraded to 0.12.3

@twilio/flex-ui@1.22.0

release date SEP 16, 2020

  • Chat attachments are now in Public beta with new capabilities, like drag-n-drop and copy/paste, ability to send text and attachment together, read-only mode and more. Check out list of capabilities and developer guides in Chat attachment docs .
  • Retired feature flag for Real-time Queues View. Real-time Queues View is now always enabled for all accounts.
  • Vertical TaskCanvas minimum size reduced to allow splitter interaction on small screens. Now, if window height is less than 600px, there will be 20% of space left for TaskList
  • Domain links with parameters, not separated by a slash, are now recognized as links. For instance: http://flex.twilio.com?test=true .
  • Removed the legacy Real-Time Queues View implementation.

@twilio/flex-ui@1.21.1

release date SEP 15 2020

  • Fixed an issue with Teams View advanced filters. When using custom programmable filtering for agents the custom filtering was not applied after agents changed their state which led to showing agents that did not match the filtering criteria.

@twilio/flex-ui@1.21.0

release date AUG 10, 2020

  • [twilio-taskrouter] to version 0.5.2
  • Hidden Filters in the Teams View restrict which users an agent is able to view and manage. Unlike normal filters, these cannot be overridden from the UI.
  • Support 'Login with Twilio', enabling admin users and developers to access Flex without SSO for self-hosted applications
  • Flex UI API Reference(link takes you to an external page) now includes the list of component children for dynamic components (with information such as key, condition, type, alignment and description).
Flex JS Documentation.
  • Removed references to getState() from within Redux reducer methods to support custom Redux stores.
  • An incoming task notification will now be shown for unregistered task channels.
Flex Task Notifications.
  • Search, UI filters, and Hidden Filters in Teams view now work in conjunction. Teams View only displays agents that match all search and filtering criteria.

@twilio/flex-ui@1.20.1

release date JUL 1, 2020

  • Fixed "calling errorPage of undefined" error by making errorPage context-independent

@twilio/flex-ui@1.20.0

release date JUN 23, 2020

(information)

Info

This version Flex UI API Reference is available here(link takes you to an external page)

  • [twilio-client] to version 1.11.0.

Image and file sharing for Web Chat channel in Pilot

  • Agents and Customers can now share images, documents and other files during a chat conversation. You can learn more about Chat attachments here .

Hold music

  • Support for new payload properties holdMusicUrl and holdMusicMethod for HoldCall/HoldParticipant actions to configure a custom hold music
    HoldCall/UnholdCall actions will now get participantCallSid property in their payload, which indicates the voice connection sid in the conference for the participant. Flex does not take that payload into account, but customers overriding these actions can use that property to filter out custom participants. For more details on specific actions, go to Flex UI API reference(link takes you to an external page)

Error handling improvement

  • New Flex.errorPage API to render a user-friendly error message screen for errors during Flex initialization. Users will now see details of the error and they can download a report which will provide technical details for troubleshooting.
Flex-Supportability.

Notification for signal connectivity issues

  • Users will now be notified if Flex UI has lost network connectivity and is trying to reconnect. UI will show a notification when any of the SDKs detect that there is an issue with network connection. UI will also emit FlexEvent.connectionStateChanged event for both disconnect and reconnect.
Connection notification.
  • Call canvas dialpad display issue in small screens sizes

@twilio/flex-ui@1.19.0

release date APR 27, 2020

  • [twilio-taskrouter] to version 0.5.1
  • [handlebars] to version 4.7.3
(warning)

Warning

Handlebars Dependency Upgrade: Handlebars provides templating for the strings exposed by Flex UI and Flex WebChat UI. In this release we are upgrading Handlebars to 4.7.3 to fix critical security vulnerabilities exposed in previous versions of Handlebars. This may be a breaking change if you use certain undocumented Handlebars features. You can find more information about this change atthe following link(link takes you to an external page).

  • Add defaultSortColumn prop to DataTable to allow for initial sorting of the table.
  • Add sortDirection prop to DataTable.ColumnDefinition to specify how the data should be sorted first. The value is either "asc" or "desc".
  • Add theme.DataTable.Header to customize DataTable headers. You can specify the root and clickable properties.

For more information on programmable sorting in Queue Stats View visit Queues View programmability guide

  • Fixed a state issue when starting monitoring a call.
  • insightsClient can no longer be broken by incorrect sdkOptions.insights configuration.
  • Improved chat message input rendering performance by debouncing store update on keypress.
  • We restructured our internal dependencies and stopped using a bundled dependency for our internal libraries. Developers can now manage their project dependencies using yarn .
  • Minor design updates to Queues Stats view .
  • Deprecated the QueuesStats.QueuesDataTable.sortable property. The table can be sorted by any of the default columns. Find out more about Queue Stats View customizations here .
  • Deprecated TeamsView.defaultProps.filtersEnabled was removed. Custom code still attempting to use it will not work. To toggle Advance Team View Filters on/off, please use the pilot flag on the feature page https://flex.twilio.com/admin/features(link takes you to an external page) . For more info on Advanced Team View Filters, go here .

@twilio/flex-ui@1.18.1

release date APR 16, 2020

  • Fixed a state issue when starting call monitoring

@twilio/flex-ui@1.17.3

release date APR 14, 2020

  • Fixed a state issue when starting call monitoring

@twilio/flex-ui@1.18.0

release date MAR 24, 2020

(information)

Info

Release notes updated on April 16th. Added mention of Outbound Dialing and Native Dialpad Public Beta release and Browser notifications bugfix


@twilio/flex-ui@1.18.0

release date MAR 24, 2020

  • [twilio-taskrouter] updated to version 0.4.5
  • Advanced Team View filters to allow supervisor to search or filter your agents by name or activity or add your custom filter criteria like teams or skills
  • Updated: Outbound Dialing and Native Dialpad to allow Agents to place outbound calls and Developers to build Click to dial capabilities. For more details, visit our Dialpad documentation
  • Fixed an issue with fetching and updating workers during call monitoring
  • TeamsView filters now correctly applies default filter
  • Updated: Browser notifications now get triggered whenever the browser is not in focus

@twilio/flex-ui@1.17.2

release date MAR 23, 2020

  • Fixed an issue with fetching and updating workers during call monitoring
  • TeamsView filters now correctly apply default filter

@twilio/flex-ui@1.17.1

release date FEB 24, 2020

  • Fixed a race condition in receiving initialDeviceCheck from feature flag config. initialDeviceCheck in Flex UI will respect the feature flag value.

@twilio/flex-ui@1.17.0

release date FEB 20, 2020

  • Added new viewResized event. This event gets triggered once the window resizes, debounced by 100ms. This will replace selectedViewChanged for resize events in the next major release. If you rely on selectedViewChanged for detecting resize events, consider adopting viewResized .
  • Flex tries to detect a default microphone and test that it works when the application is launched or when any device changes. In some headsets this check can be heard as a glitch so initialDeviceCheck can be set to false to prevent this issue.
  • selectedViewChanged event now gets correctly triggered only once when view changes
  • Insights Overlay Player now respects a selected theme
  • Application now redirects correctly after logging in when developing on HTTPS and port 443
  • Application now doesn't crash when a new Agent activity is created while on Queue Stats screen
  • Insights Overlay Player now displays an error notification when it fails to fetch a conversation
  • After long inactivity, the Insights Overlay Player no longer loses its session token
  • Fixed hyperlink color in darker message bubbles
  • Improvements to chat performance when typing
  • Email domains in MessageBubbles are no longer converted to links
  • Triggering a deleted notification will no longer result in an exception
  • Filter on Teams View page now preserves its state when navigating away
  • Supervisor view now shows call's hold state in task card
  • selectedViewChanged event now receives a second argument: isSameViewResized . This boolean describes whether the view has actually changed or the same view has been resized. isSameViewResized will be always set to false once selectedViewChanged is deprecated for resize events.

@twilio/flex-ui@1.16.2

release date JAN 27, 2020

  • For browsers without Notification capabilities Flex logs a warning and disables browser notifications.
  • Highlight URLs in chat messages only if they are not part of another string
  • Fix Handlebars 4.7.0+ errors
  • Notify user about a new chat message only if user is a participant of that chat and not supervisor monitoring the chat

@twilio/flex-ui@1.16.1

release date JAN 14, 2020

  • Issue with WebChat messages being marked as read
  • Minor UI bugs with pilot dialpad feature
  • Removed unwanted CSS parse errors when running unit tests

@twilio/flex-ui@1.15.3

release date JAN 14, 2020

  • Minor UI bugs with pilot dialpad feature

@twilio/flex-ui@1.16.0

release date DEC 17, 2019

  • [twilio-client] to version 1.9.7

Actions Framework

  • SendDTMFDigits action to send DTMF tones to a call of a call task. Previously, UI sent those digits directly when you used the DTMF Dialpad component. Now it goes through the action and if you make a custom component that needs to dial DTMF tones, a developer can use this action. Go to Actions Framework docs for more info on Flex UI Actions

_10
Actions.invokeAction("SendDTMFDigits", {
_10
_10
sid: "WRXXXXXXXXXXXXXXXXX",
_10
_10
digits: "567"
_10
_10
});

  • HistoricalReporting
    Flex Insights action to respond to dashboard drill-downs of conversations that have media link of type Raw. The action is fired any time you drill down to a conversation or a segment. By replacing the action you can now handle drill-downs however you want - for example, if you want to display a content from a 3rd-party system. See Flex Insights documentation for custom media attached to conversations .

_10
Actions.replaceAction("HistoricalReporting:view", async (url, original) => {
_10
_10
// implement your own handling of URL or call original(url) to use the original handler
_10
_10
})

  • ReloadWindow (Insights) action to force page reload from the server, bypassing the browser HTTP cache to have a unified way to recover from unexpected states that might require full refresh.

_10
Actions.invokeAction("ReloadWindow")

Flex Insights

  • Player usability improvements - You can now listen to calls and view chats within a dashboard without opening the call in a new browser tab. Quickly skim through many calls within Flex without going back and forth. You can still open the call in a separate tab to comment on and assess it. Go to Player docs for more info
  • Chat transcripts - You can now drill down to chat transcripts from Flex Insights. You can understand the underlying conversations behind your chat-related KPIs. Your supervisors can comment on and assess chat conversations to gather feedback on the quality of agent conversations with your customers. Go to Flex Insights Conversation Screen docs for more info
  • Custom media attachments - You can view custom media attached to conversations. You can use TaskRouter attributes to reference web pages (for example internal CRM records, tickets, etc.) that you can view on drill down directly in Flex Insights. This can add more context to every conversation. Go to Flex Insights docs for more info
  • Dashboards, Analyze, and Questionnaire editor are now integrated into Flex navigation and are directly accessible from the left navigation bar. This makes Flex Insights a first-class citizen and consistent with the rest of Flex.
  • Flex Insights now displays more detailed status if it is not available or there is another issue. This will enable easier troubleshooting.
  • Fixed a bug in Flex Insights when SSO isn't enabled.
  • Fixed a bug where sometimes a permanent sidebar would be added.
  • DTMF Dialpad component will now call SendDTMFDigits`` action instead of calling Voice SDK directly.
  • QueuesDataTable headers are now localizable with: QueuesStatsHeaderQueueName, QueuesStatsHeaderActiveTasks, QueuesStatsHeaderWaitingTasks, QueuesStatsHeaderLongestWait, QueuesStatsHeaderAgentsActivity.

@twilio/flex-ui@1.15.2

release date DEC 05, 2019

  • Fixed a bug with stuck scrollbar
  • Fix a bug with incorrect number of typing members in the chat typing indicator

@twilio/flex-ui@1.15.1

release date DEC 01, 2019


@twilio/flex-ui@1.15.0

release date NOV 22, 2019

  • [twilio-taskrouter] to version 0.4.1
  • [twilio-client] to version 1.9.5
  • New Action Framework action: SetWorkerActivity , which is invoked when supervisors update a worker's status. Read more about actions here.

_10
Actions.invokeAction("SetWorkerActivity", { workerSid: "WKXXXXXXXXXXXXXXXXX", activitySid: "WAXXXXXXXXXXXXXXXXX" })

  • New variable to Task Channel Definitions API channel.templates.TaskCanvasTabs.contentTabHeader for channel specific labels in TaskCanvasTabs . Now labels of TaskCanvasTabs can be changed like any other labels. Note, that TaskTabAgentCallLabel and TaskTabAgentChatLabel strings are no longer used. Find out more about Task Channel Definition API here and strings templating here.
  • TeamsView correctly renders even if TaskRouter skills array is not defined.
  • Text in chat input box can be now correctly selected

@twilio/flex-ui@1.13.2

release date OCT 31, 2019

  • Minor bugfixes and internal refactoring

@twilio/flex-ui@1.14.1

release date OCT 30, 2019

  • Numbered List support for Markdown has been temporarily suspended due to some side effects found with the implementation. All other markdown options are still available as part of the released feature. Find out more about Markdown support here
  • Teams View crashed if TaskRouter skills array was not defined properly. Now an error will be logged and Teams View will still be rendered.

@twilio/flex-ui@1.13.1

release date OCT 08, 2019

  • Using SFDC Identity provider, login flow was stuck at the redirect to pop-up dialog

@twilio/flex-ui@1.14.0

release date OCT 07, 2019

  • [twilio-client] to version ~1.9

Notifications

  • We introduced browser notification capabilities:

    • Agent will be notified about new task or new message in an active messaging task with a browser notifications if Flex is not in focus
new message browser notification.
    • Agent will be requested for browser notification permissions on each login or page refresh if they have not yet made a choice whether to allow or block browser notifications.
browser notification permissions request.
    • Developer will be able to register custom browser notifications for Flex
  • Improvements to Notifications Framework:

    • NotificationBar can now be given clickable actions
Notification bar clickable actions.

Browser notifications can be enabled via a feature flag. Go toversioning page in Flex Admin UI(link takes you to an external page) to turn browser notifications on or off.

Browser notifications feature flag.

Find out more about these and other capabilities of Flex Notifications Framework here

Customer presence

  • Agent and supervisor will now be able to see an indicator of a WebChat customer reachability. It will show a green icon in the task canvas header and the task list item if the customer is online, and a grey one if offline.
indicator of a WebChat customer reachability.
  • You can customize the templates TaskHeaderWebChatStatusAccepted and/or TaskLineWebChatAssigned . For these templates, you can access the reachability status via helper.chat.isCustomerOnline .

Typing indicator improvements

  • Default template for second line of TaskListItem of WebChat tasks now includes string "typing ..." if there are participants typing in that chat.
typing indicator webchat task.
  • Typing indicator in WebChat MessagingCanvas now shows count of people typing if that number is above 1.
Webchat messaging canvas multiple participants typing indicator.

Unread message count and badges

  • TaskListItem and SideNav now has supports for showing Badges.

    • TaskListItem will show a badge with count if there are unread messages in the task
    • SideNav will show a badge without a count if there are new unaccepted tasks or unread messages in any of the active messaging tasks in Agent Desktop View
New unread messages sidenav badge.
New unaccepted tasks sidenav badge.
  • The content of these badges is TaskChannel dependent and can be customised by updating its componentProps.TaskListItem.Badge.children property. If the content equal to zero or undefined, no badge is going to be shown.

_10
myTaskChannelDefinition.componentProps.TaskListItem.Badge.children = (
_10
appState: AppState,
_10
context: TaskListItemProps & TaskContextProps
_10
) => {
_10
const badgeContent: number = applyCustomLogic(appState, context); // just an example
_10
return badgeContent;
_10
};

  • SideNav has 2 new static properties ( AgentDesktop & Teams ) which represents link components for each view. It can be accessed to change the default Badge property.

_10
Flex.SideNav.AgentDesktop.defaultProps.Badge = {
_10
children: 2
_10
};

Markdown

(information)

Info

As of version 1.14.1 of Flex UI, numbered list support for Markdown has been temporarily suspended

Markdown

  • Flex UI now has basic markdown support for WebChat tasks. A user can use Flex standard markdown syntax when typing a WebChat message and it will be displayed to agent and WebChat user as formatted text
markdown support for WebChat tasks in input field.
Formatted Markdown message in webchat.
  • Messages with using markdown syntax can also be sent with Programmable Chat REST API into the chat channel using the same Flex markdown syntax and they will displayed for Flex and WebChat users as formatted text.
  • WebChat user must be using WebChat V2.2 or later
  • Flex standard markdown syntax:
OptionsSyntax
Bold**Bold**
Italic*Italic*
Strikethrough~Strikethrough~
Bullet list* List

* List

* List
Numbered list1. One

2. Two

3. Three
  • Find out more about Markdown support here

Other

  • Introduced ChatChannelHelper class to wrap all Chat Channel specific helper methods. An instance of a task can be obtained from TaskHelper.chat property. TaskHelper.lastChatMessage method was deprecated, use ChatChannelHelper.lastMessage instead. Now a developer can get access to Task last message, customer presence and typers (array of members who are typing in the channel). Available properties for this class:

    • isCustomerOnline - Returns true if customer is online, false if not
    • lastMessage - Gets helper for last chat message
    • typers - Gets all channel members which are currently typing (except you)
  • Function withTaskContext now returns a correctly typed component instead of any. Therefore it may not be used as a class decorator anymore, but it must be called. This change may also result in new TypeScript errors surfacing incorrect prop types or similar issues.
  • Content of localization strings changed:

    • TaskHeaderStatusAccepted - this string is no longer used for WebChat tasks. A new string has been introduced for that TaskHeaderWebChatStatusAccepted
    • TaskLineChatAssigned - this string is no longer used for WebChat tasks. A new string has been introduced for that TaskLineWebChatAssigned
  • "Login with Twilio" link on the Login View will open a Twilio login in a new window if Flex is rendered in an iframe element.
  • Improvements to Action Framework error handling:

    • invokeAction now returns an Error when the Promise is rejected
    • ToggleMute , HoldCall , UnholdCall and HangupCall to throw an Error instance instead of just an error string in case of a failure. This will allow to provide more detailed error description in the future and improves error tracing down the stack and identify which SDK the error came from.
  • The useLocalState prop of MessageInput is enabled by default for performance improvement
  • Update 'How to configure' CRM docs link url
  • Message Input now supports Input Method Editor, allowing to use characters and symbols that are not directly represented on the keyboard itself (like Chinese characters).

@twilio/flex-ui@1.13.0

release date AUG 29, 2019

  • Custom Task Channel Definitions for Chat tasks which were not using chat as TaskRouter task channel, could have caused Flex not to load and initialize the chat channels for accepted tasks in previous sessions.
  • All failures that occur during a call transfer will now be shown to a user as notifications
  • UI performance improvements

    • We will now unmount WorkersDataTable when user navigates away from Teams View. This allows us to avoid performance consuming updates on Teams View, if user does not have it opened.

@twilio/flex-ui@1.12.1

release date AUG 15, 2019

  • Resolved @types/uuid package causing issues with npm install command on Windows platform

@twilio/flex-ui@1.12.0

release date AUG 14, 2019

  • We have added an AudioPlayerManager API, which makes it easier to add sound playback to your custom code when extending Flex UI. Read about it here .
  • ChatOrchestrator object now supports setting orchestrations based on a task. This will allow you to decide how to handle chat based tasks on per task basis.

_10
const orchestrationsCallback = (task: ITask) => {
_10
if (task.sid === "WT12345") {
_10
return [];
_10
}
_10
};
_10
Flex.ChatOrchestrator.setOrchestrations("accepted", orchestrationsCallback);

  • We have added ability to send DTMF tones during a voice call to all parties on the call. This includes:

    • A new button to call toolbar to display DTMF Dialpad
DTMF dialpad.
DTMF dialpad.
  • A reusable Dialpad UI component
DTMF dialpad.

_10
export type DialpadButtonClickCallback = (value: string) => void;
_10
export interface DialpadProps {
_10
onClick: DialpadButtonClickCallback;
_10
}

  • 2 new actions are introduced:

    • An action ToggleDTMFDialpad to open and closed Dialpad in the CallCanvas.
    • An Action SetDTMFDialpadDigits to set digits in the DTMF

Go to Actions Framework page for more details on actions and their payload.

  • IncomingTaskCanvas action buttons are now a programmable component IncomingTaskCanvasActions. You can now add, replace or remove these using programmable components content property or Task Channel Definitions API.
IncomingTaskCanvas action buttons.

Example: Add an eye-iconed button to the end of the list of incoming task canvas actions using content property


_10
Flex.IncomingTaskCanvasActions.Content.add(<IconButton key="hi" icon="Eye" />);

Example: Add an eye-iconed button to the end of the list of incoming task canvas actions using Task Channel Definitions API


_10
Flex.DefaultTaskChannels.Call.addedComponents = [{
_10
target: "IncomingTaskCanvasActions",
_10
component: <IconButton key="hi" icon="Eye" />,
_10
}];

  • Add new exports to refer to workers instead of agents: WorkersDataTable, WorkerListFilterSelect, WorkersDataTable, WorkersDataTableProps and WorkerListFilter .
  • Aria props properties to the following components to support accessibility:

    • MessageInput:

      • sendButtonAriaProps • AriaProps • Send button aria props ( { ariaLabel: "Send Message" } by default).
      • textAreaAriaProps • AriaProps • Text area aria props ( { ariaLabel: "Enter your message here to get help" } by default)
    • MessageList:

      • listContainerAriaProps • AriaProps • List container aria props ( { ariaLive: AriaLive.Off } by default).
    • EntryPoint:

      • collapsedIconAriaProps • AriaProps • Collapsed icon aria props ( {ariaLabel: "Click here to open Web Chat and get help."} by default).
      • openedIconAriaProps • AriaProps • Opened icon aria props ( {ariaLabel: "Hide Chat"} by default).

Example on how to set aria attributes:


_10
FlexWebChat.MessageInput.defaultProps.sendButtonAriaProps = {
_10
ariaLabel: "Send Message",
_10
ariaLive: FlexWebChat.AriaLive.Polite
_10
};
_10
_10
FlexWebChat.MessageInput.defaultProps.textAreaAriaProps = {
_10
ariaLabel: "Enter your message here to get help",
_10
ariaLive: FlexWebChat.AriaLive.Assertive
_10
};

  • Chat "Send message" button can now be themed with theme.Chat.MessageInput.Button and allows adding text
Chat.MessageInput.Button.

Example on how to change the icon for a text:


_21
appConfig = {
_21
<...>
_21
colorTheme: {
_21
overrides: {
_21
Chat: {
_21
MessageInput: {
_21
Button: {
_21
borderRadius: "5px",
_21
width: "100px",
_21
fontSize: "10px",
_21
svg: {
_21
display: "none"
_21
},
_21
":after": {
_21
content: '"Send"'
_21
}
_21
}
_21
}
_21
}
_21
}
_21
<...>

  • Facebook channel definition now expects channel type to be Facebook
  • Workers in Team View WorkersDataTable will now be correctly sorted and will maintain its proper position
  • Team View performance improvements

    • Fixed a bug that upon network reconnect started calling for Teams View info twice for every time needed resulting in deteriorating experience.
    • Removed the need for all components that showed animating time to have its own timers which consumed resources and hit performance.
    • Resolved root cause of occasional crashes that surfaced when user was trying to show more than 200 workers.
    • Introduced throttling Sync queries for tasks and workers
  • Fixed exception thrown when rendering table rows
  • IconButton now has default hover tone dependent on whether theme is dark or light.
  • Fixed chat crashing when media message is received. MessageBubble now displays MediaMessageError string on such message.
  • Notifications.dismissNotificationById will now dismiss ALL notifications by that ID

release date AUG 6, 2019

The Flex Plugin Builder v3 is now in Beta. This release enables you to build and deploy your plugins directly from the CLI by leveraging the Functions & Assets API. You can integrate the release of your hosted Flex plugins within a CI/CD pipeline.

To opt into the newest version, check our upgrade guide for using the Plugin Builder.


@twilio/flex-ui@1.11.2

release date JULY 4, 2019

  • Agents in Team View now get correctly sorted and keep position.

@twilio/flex-ui@1.11.1

release date JULY 1, 2019

  • Fixed issues with Twilio.Flex.runDefault() removing search string from query path.

@twilio/flex-ui@1.11.0

release date JUNE 25, 2019

  • [twilio-taskrouter] to version 0.4.0
  • Voice warm transfers - now an agent can have a consult call a conference call with a customer and another agent, and transfer the call to another agent. You can read more about voice warm transfers here . Warm transfers are released in public beta with an option of opt in/out via a feature flag. Go to versioning page in Flex Admin UI(link takes you to an external page) to turn warm transfer on or off.
Warm transfer feature flag.
  • A legacy property to ContextProvider component. This resolves conflicts between multiple react-redux versions for self-hosted applications. We suggest not to use multiple react-redux versions, but if you need to use multiple versions, pass legacy={true}, then Flex ContextProvider instance will be rendered even with custom Redux store.
  • A theme.FormComponents.Select to Theme to customize the Select input item
  • A new property useSeparateInputStore introduced in the payload for action SetInputText . Setting it to true , will store the message text in separate state and improves performance of typing in Chat/Messaging/SMS dialog when handling a task. From the next major release of Flex, this prop will be defaulted to true . This can be changed by setting the new default property useSeparateInputStore of MessageInput.

_10
Flex.MessageInput.defaultProps.useSeparateInputStore = true;

  • Added tasksA and tasksB arguments to AgentsDataTable.defaultProps.initialCompareFunction . This will allow to sort the list of agents based on task attributes rather than worker attributes. For example, you can do initial sort of the agents based on longest duration of the task.

Example:


_10
Flex.AgentsDataTable.defaultProps.initialCompareFunction = (a: Flex.IWorker, b: Flex.IWorker, tasksA: Array<Flex.ITask>, tasksB: Array<Flex.ITask>) => {
_10
return tasksA.length - tasksB.length;
_10
}

  • Flex now loads only those chat channels that a worker is a member of and has an associated task with to optimize the loading time.
  • Call task canvas will now go to new list mode if participants would not otherwise fit.
Call task canvas.

In order to change ParticipantCanvas when it is in list mode, developer will need to use ParticipantCanvas.ListItem.

Example: Adding a button to the bottom of the normal participant


_10
Flex.ParticipantCanvas.Content.add(<button key="key">Hi</button>);

Example: Adding a button to the end of participant that is shown in a list


_10
Flex.ParticipantCanvas.ListItem.Content.add(<button key="key">Hi</button>);

  • theme.FormComponents.TextArea now applies to the textarea container, not directly to the element itself. This is to enforce consistency between form item.
  • Components properly inherit font property of the RootContainer , thus allowing to change font consistently in whole application:

Example: How to set custom font for the whole Flex application


_10
appConfig = {
_10
<...>
_10
colorTheme: {
_10
baseName: "FlexLight",
_10
overrides: {
_10
RootContainer: {
_10
"font-family": "MyCustomFont"
_10
}
_10
}
_10
}

  • Removed cols support for text area.
  • Removed export of connect function which did not connect to correct Redux store.
  • Removed optional configuration URLs from TypeScript Config interface.

@twilio/flex-ui@1.10.0

release date JUNE 05, 2019

  • CallCanvasActions component that is a set of buttons in the call canvas is now programmable. Now you can add, replace or remove buttons from the Call Canvas. This will allow you to add custom actions to live calls or remove actions you don't want users to take on a live call.
Call canvas programmable buttons.

You can add and remove buttons using Content objectadd and remove methods or using Task Channel Definition API

Example: Add an eye-iconed button using Content object


_10
Flex.CallCanvasActions.Content.add(<IconButton key="hi" icon="Eye" />)

Example: Add an eye-iconed button using Task Channel Definition API


_10
Flex.DefaultTaskChannels.Call.addedComponents = [{
_10
target: "CallCanvasActions",
_10
component: <IconButton key="hi" icon="Eye" />,
_10
}];

  • Supervisor.TaskCanvas.Header and Supervisor.WorkerCanvas.SectionCaption components were missing keys to override their themes. Now you can style TaskCanvas header and sub section header in WorkerCanvas respectively using Theme object
Taskcanvas header and sub section header.

Supervisor.WorkerCanvas.SectionCaption

Supervisor worker canvas section caption.

Supervisor.TaskCanvas.Header


@twilio/flex-ui@1.9.2

release date JUNE 03, 2019

  • Resolves a situation that could result in an error when initiating supervisor monitoring
  • Hold button was displayed in the opposite state to the actual call hold state

@twilio/flex-ui@1.9.1

release date MAY 28, 2019

  • initialFirstPanelSize can be set within Configuration for the AgentDesktopView.Panel1 component

@twilio/flex-ui@1.9.0

release date MAY 20, 2019

  • [twilio-chat] to version 3.2.3
  • [twilio-client] to version 1.7.2
  • [twilio-sync] to version 0.11.0
  • [twilio-taskrouter] to version 0.3.1
  • [@material-ui/core] to version 3.9.3

Setting component state

A new action SetComponentState has been added. This action alters the current state of the component. Component states is a componentName => key/value pairs dictionary in Redux store that this action manipulates. Read more about this action in Actions Framework.

Additional reducers

We have added 2 new methods to support adding additional reducers:

  • Store enhancer flexStoreEnhancer to support adding additional reducers.

Example:


_10
const myReduxStore = createStore(
_10
reducers,
_10
compose(
_10
applyFlexMiddleware(),
_10
flexStoreEnhancer // <-- Add enhancer part of compose
_10
)
_10
);

  • addReducer api to manager.store to add additional reducer.

Example:


_10
manager.store.addReducer("new", newReducer);

Chat Orchestration

ChatOrchestrator object can now be used to disable default chat orchestration.

  • There are three chat orchestrations that are supported and enabled by default:

    • AddToChatChannel - Request agent to be added to the chat channel (by default runs on the accepted event from Reservation )
    • DeactivateChatChannel - Mark chat channel status as INACTIVE (by default runs on WrapupTask and CompleteTask actions and on the wrapup and completed event from Reservation object if it was not done already)
    • LeaveChatChannel - Remove agent from the chat channel (by default runs on CompleteTask action and on the completed event from Reservation object if it was not done already)
  • Orchestrations can be disabled completely by invoking ChatOrchestrator.clearAllOrchestrations() .
  • Orchestrations can be enabled or disabled by Reservation events (accepted, wrapup, completed) which affects corresponding actions as well. For example:

    • Disable orchestrations for accepted event: Flex.ChatOrchestrator.setOrchestrations("accepted", []);
    • Disable marking chats channels as inactive: Flex.ChatOrchestrator.setOrchestrations("wrapup", []);
    • Enable removing agent on completed event: Flex.ChatOrchestrator.setOrchestrations("completed", ["LeaveChatChannel"]);

Setting activity state

Agents can move to an unavailable activity state even if they have pending reservations, and supervisors can set agents with pending reservations to an unavailable state. This capability can be disabled by setting the configuration option rejectPendingReservations to false or overriding it in the SetActivity action payload:


_10
Actions.addListener("beforeSetActivity", (payload) => {
_10
payload.options.rejectPendingReservations = true;
_10
});

  • AgentDesktopView.Panel1 got a new default property splitterOrientation that determines whether orientation of the content will be vertical, horizontal or automatic ( "auto" ) based on content size.
  • New localization strings added

    • TaskTabSupervisorCallLabel - Call task tab label in Supervisor task canvas.
    • TaskTabSupervisorChatLabel - Chat task tab label in Supervisor task canvas.
    • TaskHeaderStatusPending - Describes task that is in pending state. It's used in TaskCanvasHeader.
    • TaskHeaderGroupCallAccepted - Describes conference call task that is in accepted state. It's used in TaskCanvasHeader.
    • TaskHeaderStatusAccepted - Describes task that is in accepted state. It's used in TaskCanvasHeader.
    • TaskHeaderStatusWrapup - Describes task that is in wrapup state. It's used in TaskCanvasHeader.
    • TaskHeaderStatusCompleted - Describes task that is in completed state. It's used in TaskCanvasHeader.
  • TaskCanvasHeader now accepts a new prop secondLineTemplateCode . By default it describes the status of the task.
  • Added callSid to Participant object in Conferences state.
  • Chat orchestration failure now can prevent action invocations:

    • If chat orchestration fails to mark the chat channel inactive, then WrapupTask action will fail.
    • If chat orchestration fails to remove agent from chat channel, then CompleteTask action will fail.
  • Chat orchestration will update chat channels as inactive on the Reservation wrapup event (if it did not happen in WrapupTask action already)
  • Custom components are encouraged to use withTheme decorators to inject theme prop
  • Following type definitions are changed for consistency:

    • CallCanvasProps renamed to CallCanvasChildrenProps
    • TaskCanvasProps renamed to TaskCanvasChildrenProps
    • NoTaskCanvasProps renamed to NoTaskCanvasChildrenProps
    • ParticipantsCanvasProps split in a ParticipantsCanvasProps subset and ParticipantsCanvasChildrenProps
    • TaskCanvasHeaderProps split in a TaskCanvasHeaderProps subset and TaskCanvasHeaderChildrenProps
    • TaskCanvasTabsProps split in a TaskCanvasTabsProps subset and TaskCanvasTabsChildrenProps
    • TaskInfoPanelProps split in a TaskInfoPanelProps subset and TaskInfoPanelChildrenProps
    • MainHeaderProps split in a MainHeaderProps subset and MainHeaderChildrenProps
    • AgentDesktopViewProps split in a AgentDesktopViewProps subset and AgentDesktopViewChildrenProps
    • LoginViewProps split in a LoginViewProps subset and LoginViewChildrenProps
    • TeamsViewProps split in a TeamsViewProps subset and TeamsViewChildrenProps
    • CRMContainerProps split in a CRMContainerProps subset and CRMContainerChildrenProps
    • LiveCommsBarProps renamed in LiveCommsBarChildrenProps
    • MainContainerProps split in a MainContainerProps subset and MainContainerChildrenProps
    • MuteButtonProps split in a MuteButtonProps subset and MuteButtonImplProps
    • RootContainerProps renamed in RootContainerChildrenProps
    • SideNavProps split in a SideNavProps subset and SideNavImplProps
    • TaskListButtonsProps renamed in TaskListButtonsChildrenProps
    • ViewCollectionProps split in a ViewCollectionProps subset and ViewCollectionImplProps
  • SupervisorTaskCanvas tabs title changed from "Overview" to "Call" or "Chat" based on the type of task.

@twilio/flex-ui@1.8.2

release date MAY 8, 2019

  • Resolves a situation that could cause Flex to error while logging in

@twilio/flex-ui@1.8.1

release date MAY 6, 2019

  • Hold/Unhold buttons on CallCanvas correctly call HoldCall / UnholdCall Actions

@twilio/flex-ui@1.8.0

release date APR 26, 2019

  • TaskListButtons component that is the set of buttons in a tasklist item is now programmable (buttons can be added/removed). Example that shows a button as the last button for call tasks that have status as "accepted":

_10
const shouldShow = (props) => {
_10
return props.task.status == "accepted";
_10
};
_10
_10
Flex.DefaultTaskChannels.Call.addedComponents = [{
_10
target: "TaskListButtons",
_10
component: <IconButton key="eye_button" icon="Eye" />,
_10
options: {if: shouldShow}}];

  • Action buttons will be disabled after user click until the action execution is finished to prevent users from invoking the action twice.
  • Actions ToggleSidebar are introduced with following payload:

_10
{
_10
open?: boolean; // used to explicitly open or close the sidebar.
_10
}

  • Restored backwards compatibility with the first versions of the Dialpad plugin
  • General Flex UI styles (like headers, paragraphs or links) are now applied only to HTML elements that have a class starting with Twilio or their direct descendants without any class. The CSS attributes that are meant to be inherited are now under the Twilio-CommonStyles class.

@twilio/flex-ui@1.7.4

release date MAY 8, 2019

  • Resolves a situation that could cause Flex to error while logging in

@twilio/flex-ui@1.7.3

release date MAY 6, 2019

  • Resolves JS error when a messaging task is accepted
  • Hold/Unhold buttons on CallCanvas correctly call HoldCall / UnholdCall Actions

@twilio/flex-ui@1.7.2

release date APR 26, 2019

  • Restored backwards compatibility with the first versions of the outbound dialer plugin

@twilio/flex-ui@1.7.1

release date APR 5, 2019

  • New template TaskLineTitle used for default task channel in IncomingTaskCanvas
  • Incoming task canvas failed to render for generic/custom task channels

@twilio/flex-ui@1.7.0

release date MAR 29, 2019

This release contains several minor fixes, some internal refactoring and foundational work for Warm Transfers


@twilio/flex-ui@1.6.2

release date APR 26, 2019

  • Restored backwards compatibility with the first versions of the outbound dialer plugin

@twilio/flex-ui@1.6.1

release date MAR 28, 2019

  • Breaking issues with history package imports (affected the self-hosted builds)
  • Mitigation for multiple reservation events after connection drops

@twilio/flex-ui@1.6.0

release date MAR 12, 2019

  • Call monitor works on calls delivered to agents on non-client endpoints, like hardphone or SIP
  • Visual update for voice call stage

@twilio/flex-ui@1.5.0

release date FEB 18, 2019

  • WFO identity client integrated and exposed through Twilio.Flex.Wfo.Identity
  • New 'untrustedDomain' exception on login attempts from non-whitelisted domains
  • TaskSid and ReservationSid are added to Task Info Panel for easier troubleshooting
  • Flex now requires <meta name="referrer" content="no-referrer"> element to be present in <head> section of HTML. If such element does not exists then Flex will issue additional browser redirect in login flow after returning from IdP (and token is present in the URL).
  • Deprecated Reserved and Assigned keys in TaskStatusBasedTypeBase for task channel definitions. Use new Accepted key for reservation accepted state.
  • On logout, try to detect 'Offline' activity by "sid" ( serviceConfiguration.attributes.taskrouter_offline_activity_sid and, if that's not provided, fallback to the name. You can now change the name of the 'Offline' activity and users will still be set that activity on logout, or choose a completely different activity that users should be set to on logout, by changing serviceConfiguration.attributes.taskrouter_offline_activity_sid in the Configuration Service
  • Use Pending task based status key from task channel definition if both Pending and Reserved were defined for TaskStatusBasedTypeBase
  • Agent status in Agent Profile of Teams View now updates correctly, even if Agent is no longer shown in the list

@twilio/flex-ui@1.4.1

release date FEB 6, 2019

  • "Active Agents" filter on the Teams View will find all agents in any activity that is available

@twilio/flex-ui@1.4.0

release date JAN 11, 2019

  • Transfers call disconnect issue has now been fixed. Call Tasks will now be accepted with endConferenceOnExit set to true , so when agent ends the call the call will be ended for the customer as well. There is no reason anymore to override the acceptTask action to achieve this.
  • Supervisor will now be able to change any agent's activity state in the Teams View
  • Agent activity duration will now be shown for the agent in the Main Header of the app and for supervisor in the Teams view
  • Plugin service will now be enabled by default

@twilio/flex-ui@1.3.3

release date JAN 10, 2019

  • When clicking in the middle of the entered text in the chat input field, cursor automatically jumped to the end
  • Started consuming v0.2.15 of TaskRouter JS SDK

@twilio/flex-ui@1.3.2

release date JAN 9, 2019

  • Insert global Flex styles into the head of the document even if other styles are not there
  • When loginPopup is configured, two SSOLoginHandlers become active, which cause side effects for logout action and token updates

@twilio/flex-ui@1.3.1

release date DEC 20, 2018

  • Race condition that resulted in "no-current-call" error when accepting a call

@twilio/flex-ui@1.3.0

release date DEC 19, 2018

Voice

  • Global mute button indicated muted state even after the call had ended.

Messaging

  • Fixed UI issues with Chat input when shift+enter is pressed.

Plugins

  • New FlexEvent FlexEvents.pluginsLoaded that fires after all plugins have finished loading.
  • Exposed common dependencies like React , ReactDOM , Redux and ReactRedux to window object for plugins to depend on.

Actions

  • MonitorCall action payload got a new param extraParams that is the equally named TR SDK param for Reservation.monitor call. It is optional and UI does not set it, but developer can alter it via programmability if need be.
  • Error notification when browser is unable to access microphone.
  • New option isolate for router configuration section: whenever set to true, Flex will ignore any navigation action (including URL change) except for internal.
  • Registered a beforeSendMessage action to check if the message exceeds the limit and handle it accordingly.
  • Support for promises to Actions framework. Now, if a before-action listener returns a Promise, the Actions framework will wait for it to be resolved before completing the action. This change is back-compatible, so a lister can still return return nothing.
  • SendMessage action got optional messageAttributes property to its payload that, if specified, will be used as the equally named property of the Chat SDK sendMessage call.

Views and routing

  • Default route may now be changed via componentProps by setting defaultLocation property for ViewCollection .
  • Flex navigation action type is exposed through FLEX_LOCATION_CHANGE constant. It can be used to listen to Flex navigation actions or do dispatch Flex-specific navigation actions.

Voice

  • disableBrowserVoice option for configuration. When specified Twilio Client SDK (for Browser voice capability) will not be initialized. Attempting to accept a task that is voice and with worker's contact_uri not pointing to a phone number, the attempt is blocked and warning is shown.

Messaging

  • Character limit added to messages sent by agent. Character count indicator will be shown below text input when agent exceeds the limit. Character limits per channel:

    • SMS - 1600 characters
    • Web chat - 32768 characters (32 kB)
    • Channels (Facebook, Line, WhatsApp) - 4000 characters
  • Character limit information added to Task Channel Definition API as a new prop charLimit

SSO login

  • SSO login in pop-up window support added. config.sso.loginPopup = true can be set to enable it. To gracefully handle blocked popups, new LoginFormView React component or provideLoginInfo or tryLogin Twilio.Flex API function can be used to launch it. Additionally pop-up window features for window.open() function can be set in config.sso.loginPopupFeatures configuration variable as string.
  • New API functions to run or log user in to Flex using Twilio.Flex interface:

_33
/**
_33
* Runs Flex with default setup.
_33
* It will show loader and prompts for login information
_33
* if it is not provided in configuration object.
_33
*
_33
* @param [config] configuration object
_33
* @param [nodeOrSelector] DOM node or selector string where to render Flex
_33
* @returns {Promise<void>}
_33
*/
_33
export function runDefault(config: Config = {}, nodeOrSelector: string | Element = "body"): Promise<void>;
_33
_33
/**
_33
* Tries to log user in to Flex.
_33
* Can redirect the current browser window to the IdP URL or
_33
* open a new window to navigate to IdP URL if config.loginPopup is set.
_33
*
_33
* @param [config] SSO configuration object
_33
* @return {Promise<boolean>} true if there is valid token and user can be logged in.
_33
*/
_33
function tryLogin(config: SSOConfig = {}): Promise<boolean>;
_33
_33
/**
_33
* Helper function to provide additional account and user info if it is not set.
_33
* Updates the provided config object.
_33
*
_33
* Renders a LoginFormView component if accountSid is not provided or there are problems with signing user in.
_33
*
_33
* @param [config] configuration object
_33
* @param [nodeOrSelector] DOM node or selector string where to render the component
_33
* @returns {Promise<void>} if resolved, then Flex instance can be created with
_33
* provided config object.
_33
*/
_33
function provideLoginInfo(config: Config = {}, nodeOrSelector: string | Element = "body"): Promise<void>;

  • New LoginFormView React component to be used to provide account / user info with the following props:

_10
interface LoginFormViewProps {
_10
onSuccess: (determinedConfig: Config) => any;
_10
userConfig: Config;
_10
}

  • New strings for LoginFormView component:

_14
LoginContinue: "Continue anyway",
_14
LoginLaunch: "Launch",
_14
LoginTitle: "Twilio Flex",
_14
LoginErrorDomain: "Oops! Your runtime domain is incorrect.",
_14
LoginErrorDomainDetails: "Find your runtime domain " +
_14
"<a href='https://www.twilio.com/console/runtime/overview'>here</a>",
_14
LoginErrorSso: "Hmm, Single Sign-On has not been configured.",
_14
LoginErrorSsoDetails: "Find out how to configure Single Sign-On " +
_14
"<a href='https://www.twilio.com/console/flex/users/single-sign-on'>here</a>",
_14
LoginErrorPopupBlocked: "Sorry, pop-ups are blocked.",
_14
LoginErrorPopupBlockedDetails: "Find out how to enable pop-ups in your browser",
_14
LoginErrorGeneric: "Oops! Well, that didn't work :( Please double check your configuration.",
_14
LoginIsAdmin: "Flex Admin?",
_14
LoginWithTwilio: "Login with Twilio.",

Views and routing

  • View now has multiple route path support. By default name prop is taken as string to be added to the path of the specified View . One can add alternative routes with route prop.

Example:


_10
<View key="teams" name="teams" route={{ path: "/supervisor" }}> // both http:/domain/teams and http://domain/supervisor will work
_10
_10
<View key="teams" name="teams" route={{ path: ["/supervisor", "something"] }}> // both http:/domain/teams and http://domain/supervisor and http://domain/something will work

  • ViewCollection was not using DynamicComponent properly so all manipulations of it other than add via programmability did not work.

Voice

  • Global mute button will be disabled if there are no active calls.
  • Moved reset CSS to top of head to allow any custom CSS to override it.

@twilio/flex-ui@1.2.0

release date NOV 22, 2018

  • Use react and react-dom version 16.5.2
  • Performance optimization for Teams view
  • baseNames theme names changed
Deprecated nameNew Theme name
DarkThemeGreyDark
MediumThemeGreyLight
BlueMediumThemeFlexLight
BlueDarkThemeFlexDark
  • "Active agents" filter is set as default in Teams View
  • Switch from icon to label in Tab label components in agent TaskCanvasTabs and supervisor TaskCanvas
  • New localization strings for TaskTabAgentIncomingLabel, TaskTabAgentCallLabel, TaskTabAgentChatLabel, TaskTabAgentInfoLabel, TaskTabSupervisorInfoLabel and TaskTabSupervisorOverviewLabel

_10
export interface Strings<T = string> extends FrameStrings<T> {
_10
...
_10
TaskTabAgentIncomingLabel?: T;
_10
TaskTabAgentCallLabel?: T;
_10
TaskTabAgentChatLabel?: T;
_10
TaskTabAgentInfoLabel?: T;
_10
TaskTabSupervisorInfoLabel?: T;
_10
TaskTabSupervisorOverviewLabel?: T;
_10
}

  • Views of ViewCollection got a new prop mountRule . If specified, keepMounted prop value is ignored. Definition of the prop is as follows:

_10
export enum ViewMountRule {
_10
Always = "Always", // View is mounted from the start of the application and never unmounted
_10
WhenActive = "WhenActive", // Views is mounted when activated and unmounted when deactivated
_10
WhenHasBeenActive = "WhenHasBeenActive" // View is mounted when first activated and never umounted
_10
}


@twilio/flex-ui@1.1.0

release date NOV 6, 2018

  • TypeScript definitions of the package were referencing some missing files
  • Regular agents were not able to open up directory button for transfers
  • MainHeader now again accepts changing logoUrl default property
  • CRMContainer and MessagingCanvas did not pass props down to their custom children
  • Issues with broken UI when using custom store
  • Ability to transfer calls to a Queue from Directory Component (previously only workers were present there)
  • Action TransferTask was introduced. As with all other Task specific actions, if calling it, either task or sid must be specified, the other is autofilled then accordingly. When tapping into the action either with events or task replacement, both will be filled at execution time. Payload of the action:

_10
{
_10
sid?: string; // sid of the ITask to transfer
_10
task?: ITask; // ITask object representing the Reservation being transferred
_10
targetSid: string; // sid of the Worker or Queue where the task should be transferred to
_10
options?: Object // options passed over to TaskRouter SDK transfer call. Refer to TaskRouter SDK documentation on Task.transfer option values.
_10
}

  • Add optional label property to the Tab component. When provided, it will display a label into the Tab element. If the value matches a code in language strings array, the contents of the language string is used as template. Otherwise the value is used as just string. If label is not provided, icon property is considered and used.
  • Add optional alignment property to Tabs . When provided, it will change the tabs alignment. Possible values are left or center . Default is center .

(information)

Info

New GA version of Flex UI has been released and are now available on NPM

  • @twilio/flex-ui@1.0

@twilio/frame-ui@0.15.0

twilioframe-ui0150 page anchor
  • Tasks can now be transferred to another available agent from Call Canvas via new Worker Directory.
  • To enable call transfers, calls will be currently accepted with endConferenceOnExit set to false , meaning that the call will not stop for customer when agent stops the call.
  • As alternative to the above, disableTransfers config options was created. By default false , if set to true, the endConferenceOnExit will be enabled but transfers to other agents will not be available.
  • Agent Skilling. Can be disabled by setting WorkerCanvas component prop showSkills to false .
  • public_identity from worker attributes gets set to agent's chat user friendly name. If that is not set, then full_name attribute is used.
  • Call recording can be enabled from configuration service.
  • All actions that had taskSid in payload will now expect sid instead. Potential breaking change!!!
  • Task object in Actions framework got new field sourceObject which will be pointing to the actual SDK object. Reservation in case of TaskRouter, InsightsObject in case of Insights (Supervisor views). source is still there but is deprecated.
  • Some actions got changed payload

    • SetActivity can now be called with just activityName in the payload.
    • SelectTaskInSupervisor now expects/provides object as payload in form of {task?: ITask, taskSid?: string} . Providing either will autofill the other also so both will be available for whoever taps into the action via Actions framework.
    • SelectWorkerInSupervisor now expects/provides object as payload in form of {worker?: ITask, workerSid?: string} . Providing either will autofill the other also so both will be available for whoever taps into the action via Actions framework.
    • MonitorCall now expects/provides object as payload in form of {task?: ITask, taskSid?: string} . Providing either will autofill the other also so both will be available for whoever taps into the action via Actions framework.
  • Chat channels need to be created by channel orchestration service for agent to be able to join them.
  • Templates and channel definitions use channelType attribute from task to detect chat channel type.

  • Styling
  • Avatar callback

@twilio/flex-agent-frame-sample@0.14.0

twilioflex-agent-frame-sample0140 page anchor

Changed

  • Consume @twilio/flex-ui@0.14.0

@twilio/flex-ui@0.14.0

twilioflex-ui0140 page anchor

Changed

  • SetActivity action now has payload in the form of {activitySid: string; activityName?: string; activityAvailable?: boolean} . Only activitySid is used in default implementation and are required when invoking the action by user, but other two are filled for better context for users who override the action and need more information on what the new activity will be.
  • Property task type changed to ITask for task based components. Previously TaskState interface was used which had only source and reservation properties. Properties source and reservation stay the same as they used to, but now attributes and other task properties can be accessed from task object itself. For example this.props.task.attributes can be used where applicable and there should be no need to use source sub property anymore which is referring to Task Router SDK object.
  • Consume TR 0.2.8 with Reservation based task completion. Special account flag needed for everything to work properly.
  • Tasks in store are referenced by reservation sid now

Added

  • Components can be removed using Task Channels API:

_11
export type TaskChannelComponentRemoveRequest = {
_11
target: keyof FlexComponents;
_11
key: React.Key;
_11
options?: RemoveComponentCallOptions;
_11
};
_11
TaskChannelDefinition.removedComponents?: Array<TaskChannelComponentRemoveRequest>;
_11
_11
// For example:
_11
myOwnChatChannel.removedComponents = [
_11
{ target: "TaskCanvasTabs", key: "info" }
_11
];

  • TaskContext - Flex sets up Task Context using React Context API where it knows about an active or selected task. If Task has been selected in Agent Desktop View or Teams View then it can be obtained from Context. Interface of the TaskContext is shown below. Also withTaskContext helper function has been added that creates a HOC which adds the properties to the wrapped component.

_10
export interface TaskContextProps {
_10
task?: ITask; // Task we are referring to, undefined if there is no task in context
_10
call?: PhoneCallState; // Call state that current task if related to, undefined if there is no task in context or there is no call for a task
_10
chatChannel?: ChatChannelState.ChannelState; // Chat channel state that current task if related to, undefined if there is no task in context or there is no chat for a task
_10
channelDefinition?: TaskChannelDefinition; // Matched task channel definition for a task, undefined if there is no task in context
_10
}

  • Using TaskContext.Consumer :

_10
import { withTaskContext } from "@twilio/flex-ui";
_10
_10
const MyComponent: (props) => {
_10
return (
_10
<div>{props.task.attributes.someAttribute}</div>
_10
);
_10
}
_10
_10
const MyComponentWithTask = withTaskContext(MyComponent);
_10
// Register MyComponentWithTask component to Flex instead of MyComponent

  • Using withTaskContext :

_10
import { withTaskContext } from "@twilio/flex-ui";
_10
_10
const MyComponent: (props) => {
_10
return (
_10
<div>{props.task.attributes.someAttribute}</div>
_10
);
_10
}
_10
_10
const MyComponentWithTask = withTaskContext(MyComponent);
_10
// Register MyComponentWithTask component to Flex instead of MyComponent


@twilio/frame-ui@0.14.0

twilioframe-ui0140 page anchor

Added

Component.Content.remove to allow removing components from dynamic component children (both native and programmatically added ones).

Syntax:

Component.Content.remove(key: string, options: {if?: (props: any) => boolean})

where

  • key - key of the component to be removed
  • if - boolean expression that decides at any given moment whether the removal should be active. props parameter is the object of all properties passed by the main component to children.

Example: removes avatar from the canvas that shows "you have no tasks", but only if the user's name is not Bob.


_10
Flex.NoTasksCanvas.Content.remove("avatar", {if: props => props.worker.attributes.full_name !== "Bob"});


@twilio/flex-agent-frame-sample@0.13.0

twilioflex-agent-frame-sample0130 page anchor

Changed

  • Consume @twilio/flex-ui@0.13.0

@twilio/flex-ui@0.13.0

twilioflex-ui0130 page anchor

Removed

  • Individual module files in the NPM module removed. All sources bundled into a single module bundle file referenced by the main field in package.json.
  • Components TaskListChatItem and TaskListCallItem - can be customized not using Task Channels API. Or use TaskListItem to use them all.
  • Theme property AltContainer and IconArea ; and component property alternateColors removed from TaskListItem component.
  • Theme property colors.channelColors removed. Channel colors are defined in Task Channel now.

Changed

  • Rendering tasks from all channels now in TaskList using default task channel definition.
  • All channels are defined by Task Channels API.

Added

  • Incoming call notification bar
  • In case of pending tasks Nav Bar is going to show red dot on top of main and agent-view button
  • Task Channels API. See below for more detailed description and information about usage,

All task channels that Flex handles are defined and registered by Task Channels API. Flex registers its default Task Channel definitions (see below), but users and plugins can register their own. When Flex task based components are rendered, the first matching channel definition for a given task will be used. If there is more than one channel definition match for a task, then most recently registered definition will be used (so that you can register more specific channel definition).

See below interface TaskChannelDefinition for what can be set up. All parameters are optional meaning that ones from Default task channel definition will be used if not specified. The The most important property of a task channel definition is isApplicable callback function. The callback receives a task as argument and must return boolean true if this definition can be used to handle given task.

In a task channel definition you can specify:

  • callback to determine which tasks are applicable
  • strings (templates) to use in different Flex components based on task status
  • colors to be used in task list based on task status
  • icons to be shown in task list, tabs and canvases based on task status
  • custom components to be added to task based components if channel is applicable
  • custom components to be replaced in task based components if channel is applicable

Predefined Task Channels definitions are available via Twilio.Flex.DefaultTaskChannels objects for reference. Channels that are defined by default:

  • Call - Twilio.Flex.DefaultTaskChannels.Call
  • Chat - Twilio.Flex.DefaultTaskChannels.Chat
  • Chat SMS - Twilio.Flex.DefaultTaskChannels.ChatSMS
  • Chat Line - Twilio.Flex.DefaultTaskChannels.ChatLine
  • Chat Messenger - Twilio.Flex.DefaultTaskChannels.ChatMessenger
  • Chat WhatsApp - Twilio.Flex.DefaultTaskChannels.ChatWhatsApp
  • Default - Twilio.Flex.DefaultTaskChannels.Default

It is not recommended to change Twilio.Flex.DefaultTaskChannels them at runtime. You should create your own definition and register it instead.

Flex has the following helper functions to create channel definitions with default values for chat, call and generic: Chat channel creation with default chat templates:


_10
Flex.DefaultTaskChannels.createChatTaskChannel(name: string, isApplicable: TaskChannelApplicableCb,
_10
icon: string | React.ReactNode = "Message", iconActive: string | React.ReactNode = "MessageBold", color: string = defaultChannelColors.chat): TaskChannelDefinition

Call channel creation with default templates. Call channel definition uses callbacks to determine the icon and colors (based on call state and destination to render):


_10
Flex.DefaultTaskChannels.createCallTaskChannel(name: string, isApplicable: TaskChannelApplicableCb):: TaskChannelDefinition

Default channel creation with default templates.


_10
Flex.DefaultTaskChannels.createDefaultTaskChannel(name: string, isApplicable: TaskChannelApplicableCb, icon: string | React.ReactNode = "GenericTask", iconActive: string | React.ReactNode = "GenericTaskBold", color: string = defaultChannelColors.custom): TaskChannelDefinition

To register a task channel definition use Flex.TaskChannels.register(definition: TaskChannelDefinition, mergeWithDefaultChannel = true). You must register your channel definitions before Flex starts up.

Example:


_10
const myOwnChatChannel = Flex.DefaultTaskChannels.createChatTaskChannel("myChat",
_10
(task) => task.taskChannelUniqueName === "chat" && task.attributes.somethingSpecial === "mycCustom");
_10
// can modify myOwnChatChannel here
_10
_10
Flex.TaskChannels.register(myOwnChatChannel);

Also new the following API exists: Flex.TaskChannels.unregister(myOwnChatChannel); - to unregister previously registered channel Flex.TaskChannels.getRegistered(); - to get all registered task channelsFlex.TaskChannels.getForTask(task: ITask); - to get a matching task channel definition for a task

Interface of TaskChannelDefinition:


_126
export enum TaskChannelCapability {
_126
Info = "Info", // whether channel has info panel
_126
Call = "Call", // whether channel has call canvas capabilities
_126
Chat = "Chat", // whether channel has chat canvas capabilities
_126
Video = "Video", // whether channel has video calling capabilities
_126
Wrapup = "Wrapup" // whether channel needs to go to Wrapup state before can be completed
_126
}
_126
_126
export type TaskCallbackType<T> = (task: ITask, componentType: React.ComponentType, ...args) => T;
_126
export type TaskStatusBasedTypeBase<T> = {
_126
Reserved: T;
_126
Assigned: T;
_126
Wrapping: T;
_126
Completed: T;
_126
Canceled: T;
_126
Pending: T;
_126
};
_126
export type TaskStatusBasedType<T = string> = T | TaskCallbackType<T> | TaskStatusBasedTypeBase<T>;
_126
export type TaskChannelApplicableCb = (task: ITask) => boolean;
_126
_126
export type TaskChannelComponentRegistration = {
_126
target: keyof FlexComponents;
_126
component: React.ReactChild;
_126
options?: ContentFragmentProps;
_126
};
_126
_126
/**
_126
* Defines a task channel
_126
*
_126
* @export
_126
* @interface TaskChannelDefinition
_126
*/
_126
export interface TaskChannelDefinition {
_126
_126
name: string;
_126
_126
/**
_126
* Used in TaskList, TaskCard, Canvases
_126
*/
_126
colors?: {
_126
main?: TaskStatusBasedType<string>;
_126
};
_126
_126
/**
_126
* Returns whether this task channel is applicable for a given task.
_126
* @param task task instance to evaluate the channel for
_126
*/
_126
isApplicable: TaskChannelApplicableCb;
_126
_126
/**
_126
* Icons to render to the task channel
_126
*/
_126
icons?: {
_126
/**
_126
* List icon to be used in TaskList and TaskCardList
_126
*/
_126
list?: TaskStatusBasedType<string | React.ReactNode>;
_126
/**
_126
* Icon to be used in Tab headers if tab is not selected
_126
*/
_126
main?: TaskStatusBasedType<string | React.ReactNode>;
_126
/**
_126
* Icon to be used in Tab headers if tab is selected and in Task Canvases as the main icon
_126
*/
_126
active?: TaskStatusBasedType<string | React.ReactNode>;
_126
};
_126
_126
/**
_126
* Templates for components
_126
*/
_126
templates?: {
_126
IncomingTaskCanvas?: {
_126
firstLine?: TaskStatusBasedType<string>;
_126
secondLine?: TaskStatusBasedType<string>;
_126
};
_126
CallCanvas?: {
_126
firstLine?: TaskStatusBasedType<string>;
_126
secondLine?: TaskStatusBasedType<string>;
_126
};
_126
TaskListItem?: {
_126
firstLine?: TaskStatusBasedType<string>;
_126
secondLine?: TaskStatusBasedType<string>;
_126
extraInfo?: TaskStatusBasedType<string>;
_126
};
_126
TaskCanvasHeader?: {
_126
title?: TaskStatusBasedType<string>;
_126
endButton?: TaskStatusBasedType<string>;
_126
};
_126
TaskCard?: {
_126
firstLine?: TaskStatusBasedType<string>;
_126
secondLine?: TaskStatusBasedType<string>;
_126
};
_126
TaskInfoPanel?: {
_126
content: TaskStatusBasedType<string>;
_126
};
_126
Supervisor?: {
_126
TaskCanvasHeader?: {
_126
title?: TaskStatusBasedType<string>;
_126
endButton?: TaskStatusBasedType<string>;
_126
};
_126
TaskInfoPanel?: {
_126
content: TaskStatusBasedType<string>;
_126
};
_126
TaskOverviewCanvas: {
_126
firstLine?: TaskStatusBasedType<string>;
_126
secondLine?: TaskStatusBasedType<string>;
_126
}
_126
}
_126
};
_126
_126
/**
_126
* Set of capabilities, used to render Tabs
_126
*/
_126
capabilities: Set<TaskChannelCapability>;
_126
_126
/**
_126
* Custom components to be added for this task channel. E.g. custom Tabs. Supports only components that have a static "Content" property
_126
*/
_126
addedComponents?: Array<TaskChannelComponentRegistration>;
_126
_126
/**
_126
* Custom components to be replaced for this task channel. Supports only components that have a static "Content" property
_126