logoUrl: string
The logo URL displayed in the main top header.
For Customers building HIPAA-compliant workflows with Flex UI, Customers are required to ensure that there is no PHI in any Properties of Configuration Objects. Details on Configuration Objects and Properties can be found on the official Flex UI documentation. To learn more about building for HIPAA compliance, please visit the latest requirements here.
There are two main ways to define Flex configuration:
Flex UI's configuration allows you to control the way the overall app loads, as well as the behavior of individual Flex Components.
Flex Components can be modified in two ways:
componentProps
in the Configuration ObjectThe appConfig.js configuration object detailed below is not directly accessible when using Twilio-hosted Flex (flex.twilio.com). However, all of the same values can be set as ui_attributes
using Flex Configuration REST API.
In the configuration object, you can define the default properties of your Flex Components. You can also configure properties that are not tied to specific Components.
Example: public/assets/appConfig.js
1var appConfig = {2serviceBaseUrl: "https://dancing-owl-1234.twil.io/",3sso: {4accountSid: "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"5},6sdkOptions: {7chat: {},8insights: {},9voice: {},10worker: {}11},12logLevel: "debug",13colorTheme: {14baseName: "GreyDark",15colors: {},16light: false,17overrides: {}18},19componentProps: {20CRMContainer: {21uriCallback: (task) => task22? `https://www.bing.com/search?q=${task.attributes.name}`23: "http://bing.com"24}25},26router: {27type: "memory",28history: {29initialEntries: [ "/agent-desktop" ]30}31}32};
Some configuration options are only available through the configuration object. Below is the list of all available configuration options.
Redefines the color scheme.
1appConfig.colorTheme = {2baseName: "GreyDark",3colors: { base2: "red"},4light: true,5overrides: {6MainHeader: {7Container: {8background: "green"9}10}11}12};
Adjusts the properties of separate Flex Components. For a list of available components, see Components.
1appConfig.componentProps = {2AgentDesktopView: {3showPanel2: false4}5};
Disables conference transfers.
appConfig.disableTransfers = false;
Sets the specificity of log output. Can be either a number or a string matching:
trace
or 0
debug
or 1
info
or 2
warn
or 3
error
or 4
silent
or 5
appConfig.logLevel = 'info';
Whether to load plugins to modify the Flex UI. Provides an optional URL to override Flex's default plugins source.
1appConfig.pluginService = {2enabled: true,3url: "https://example.com/plugins-list.json"4};
Sets the use of browser or in-memory routing for Flex.
1appConfig.router = {2type: "memory",3history: {4initialEntries: [ "/agent-desktop" ]5}6};
Flex initializes four standard Twilio SDKs, which are accessible via the Flex Manager. These sdkOptions
will pass through as parameters used when initializing those SDKs. (example: Twilio.Device parameters for voice
)
1appConfig.sdkOptions = {2chat: {},3insights: {},4voice: {},5worker: {}6};
Currently not used. This value defaults to the Runtime Domain that is associated with your Twilio Account. This is a reference to Functions you may be hosting to power backend API requests.
Enables support for authentication and Single Sign-On using 3rd party Identity Providers such as Okta.
1appConfig.sso = {2accountSid: "ACxxx" // AccountSid of your Twilio project3};
Currently not used.
You may also configure default properties for components within a Plugin by using the React defaultprops
API programmatically:
componentProps: { [Component Name]: { [Prop Name]: [PropValue] } }
Example
1flex.CRMContainer2.defaultProps3.uriCallback = (task) => task4? `https://www.bing.com/search?q=${task.attributes.name}`5: "http://bing.com/";67flex.MainHeader8.defaultProps9.logoUrl = "https://static0.twilio.com/marketing/bundles/archetype.alpha/img/logo-wordmark--red.svg";
Below is the list of Flex Components and their defaultProps
that can be modified.
uri: string
The URI that is displayed in the CRM container. This URI must be generated by the uriCallback
.
uriCallback: (task: Task) => string
A callback that returns a URI to be displayed in the CRM container based on a selected task. If you want to replace the CRMContainer component entirely, use the replace method instead.
1flex.CRMContainer2.defaultProps3.uriCallback = (task) => task4? `https://www.bing.com/search?q=${task.attributes.name}`5: "http://bing.com/";
logoUrl: string
The logo URL displayed in the main top header.
logoUrl: string
The URL for the login view image (by default the Twilio Logo).
staticTaskFilter: (task: Task) => Boolean
A callback function describing a tasks' presence and order in the Flex UI. If a task returns true
(i.e., it's a static or "pinned" Task for the User's Flex UI) it will appear in the upper section of the TaskList Container.
By default, both live and incoming calls are treated as static Tasks.
itemSize: 'Small' | 'Large' | 'LargeSelected'
The task list item size. Legal values include:
Small
(default) - regular task list item sizeLarge
- all task list items are 156px bigger in height, allowing for custom info below the default task list item content via TaskExtraInfo
templateLargeSelected
- selected tasklist item is shown as Large
, others as Small
keepSideNavOpen: Boolean
Indicates whether the Sidebar preview panel should be always visible. Default is false
, which shows the preview only after the whole app is wide enough.
showNotificationBar: Boolean
If set to false
, NotificationBar notifications won't be shown. Read more about Notifications on the Notifications Framework page.
showLiveCommsBar: Boolean
Displays an incoming call bar for views different from Agent UI.
compareFunction: (task1: Task, task2: Task) => number
Callback to control how tasks should be sorted in the task list. A negative number means task1
should be above task2
. A positive number that task1
should be below task2
. 0 indicates equal priority.
showPanel2: Boolean
When set to false, will completely remove the right side area of the Agent View, where usually CRM resides, including the splitter control separating left and right side areas.
splitterOptions: object
Allows specification of the default values for the main horizontal splitter in Agent Desktop view (separates the left view from the CRM area to the right). Values can either be pixels or % values.
1{2initialFirstPanelSize?: string;3minimumFirstPanelSize?: string;4minimumSecondPanelSize?: string;5}
splitterOrientation: 'auto' | 'vertical' | 'horizontal' (Default: auto)
Determines whether the orientation of the content will be vertical
, horizontal
, or auto
(automatic) based on the content size.
tablePlaceHolder: ReactNode
The React element to display when the list of agents is empty.
initialCompareFunction: (worker1: IWorker, worker2: IWorker) => number
Callback to control how agents should be sorted in the agent list. A negative number means worker1
should be above worker2
. A positive number that worker1
should be below worker2
. 0 indicates equal priority.
showSkill: Boolean
Display the skills section for the agent details.
details: Array<WorkerProfileDetail>
Add details to the agent's profile.
icon: string | ReactNode
An image displayed in the task header of a task. If you provide an icon string, it needs to match an icon name from a list of Flex Icons.
ActionsComponent: ComponentType<{ task: ITask }>
An action component displayed in the header of a task. Defaults to an "end task" button.
titleTemplateContext: object
Context object used for rendering the task title template.
alignment: 'left' | 'center'
Defines how the tab header is aligned.
These properties apply to both the Flex Agent Desktop UI and the Twilio WebChat UI - everywhere the Chat/Messaging component is used.
avatarCallback: (identity: string) => string
Callback function to return the avatar URL of a member.
memberDisplayOptions: object
Allows overriding chat participant names, e.g. setting agent to Agent and customer to Customer.
1{2yourDefaultName?: string;3theirDefaultName?: string;4yourFriendlyNameOverride?: boolean;5theirFriendlyNameOverride?: boolean;6}
messageStyle: 'Rounded' | 'Squared' | 'Minimal'
Defines the visual style of the message area. Options are Rounded
, Squared
, Minimal
.
showReadStatus: Boolean
Controls whether to show the message read indicator.
showTypingIndicator: Boolean
Controls whether to show "[SomeOne] is typing" in chat.
showWelcomeMessage: Boolean
Controls whether to show the welcome message at the beginning of the conversation.
welcomeMessageText: string
The welcome message text to display.
showTrayOnInactive: Boolean
Displays the message tray component, indicating that the chat is no longer active whenever channel status is inactive.
useFriendlyName: Boolean
Overrides the chat participant name with a friendly name.
areaStyle: 'Bubble' | 'Line' | 'Boxed'
The visual style of the text input element. Options are Bubble
, Line
, Boxed
.
returnKeySendsMessage: Boolean
Whether pressing the return key should send a message.
showButton: Boolean
Display a 'Start new chat' button in the tray.
onButtonClick: () => void
A handler for a 'Start new chat' button click.
To configure an integration with an Identity Provider and enable Single Sign-On, set the
1appConfig.sso = {2accountSid: string; // AccountSid of your Twilio Project3loginPopup: Boolean; // whether to launch IdP login in new window4loginPopupFeatures: string; // standard window.open() features param to be applied to popup window5};
The session state in Redux Store will contain:
loginState
- state of the loginssoTokenPayload
- the token payload from the Identity Provideridentity
- user identity used for SSO procedureloginError
- an error occurred during loginloginHandler
- an object that contains parameters of the login procedureuriCallback: (task: ITask) => string
Callback function which is called every time an active task is changed. You can provide a CRM URI for that particular task or a constant URI.
1flex.CRMContainer2.defaultProps3.uriCallback = (task) => task4? `https://www.bing.com/search?q=${task.attributes.name}`5: "http://bing.com/";