Flex UI configuration

The appConfig.js configuration object detailed in this article isn't directly accessible when using Twilio-hosted Flex (flex.twilio.com). However, you can set the same values as ui_attributes using the Flex Configuration REST API.

In the configuration object, you can define the default properties of your Flex components. You can also configure properties that aren't tied to specific components.

Example: public/assets/appConfig.js

1
var appConfig = {
2
  serviceBaseUrl: "https://dancing-owl-1234.twil.io/",
3
  sso: {
4
    accountSid: "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
5
  },
6
  sdkOptions: {
7
      chat: {},
8
      insights: {},
9
      voice: {},
10
      worker: {}
11
  },
12
  logLevel: "debug",
13
  colorTheme: {
14
    baseName: "GreyDark",
15
    colors: {},
16
    light: false,
17
    overrides: {}
18
  },
19
  componentProps: {
20
    CRMContainer: {
21
      uriCallback: (task) => task
22
        ? `https://www.bing.com/search?q=${task.attributes.name}`
23
        : "http://bing.com"
24
    }
25
  },
26
  router: {
27
    type: "memory",
28
    history: {
29
      initialEntries: [ "/agent-desktop" ]
30
    }
31
  }
32
};

Some configuration options are only available through the configuration object. The list of all available configuration options is as follows.

Redefines the color scheme.

1
appConfig.colorTheme = {
2
  baseName: "GreyDark",
3
  colors: { base2: "red"},
4
  light: true,
5
  overrides: {
6
    MainHeader: {
7
      Container: {
8
        background: "green"
9
      }
10
    }
11
  }
12
};

Adjusts the properties of separate Flex components. For a list of available components, see Flex UI 1.x.x Components.

1
appConfig.componentProps = {
2
  AgentDesktopView: {
3
    showPanel2: false
4
  }
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';

Sets whether to load plugins to modify the Flex UI. Provides an optional URL to override Flex's default plugins source.

1
appConfig.pluginService = {
2
  enabled: true,
3
  url: "https://example.com/plugins-list.json"
4
};

Sets whether to use browser or in-memory routing for Flex.

1
appConfig.router = {
2
  type: "memory",
3
  history: {
4
    initialEntries: [ "/agent-desktop" ]
5
  }
6
};

Flex initializes four standard Twilio SDKs, which are accessible via the Flex Manager. These sdkOptions pass through as parameters used when initializing those SDKs. For example, Twilio.Device parameters for voice.

1
appConfig.sdkOptions = {
2
  chat: {},
3
  insights: {},
4
  voice: {},
5
  worker: {}
6
};

Currently not used. This value defaults to the runtime domain 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 (SSO) using 3rd party identity providers like Okta.

1
appConfig.sso = { 
2
  accountSid: "ACxxx" // AccountSid of your Twilio project 
3
};

Currently not used.

You can also configure default properties for components within a plugin by using the React defaultprops API programmatically:

componentProps: { [Component Name]: { [Prop Name]: [PropValue] } }

Example

1
flex.CRMContainer
2
  .defaultProps
3
  .uriCallback = (task) => task
4
    ? `https://www.bing.com/search?q=${task.attributes.name}`
5
    : "http://bing.com/";
6

7
flex.MainHeader
8
  .defaultProps
9
  .logoUrl = "https://static0.twilio.com/marketing/bundles/archetype.alpha/img/logo-wordmark--red.svg";

The following is a list of Flex components and their defaultProps, which you can modify.

uri: string

The URI that's displayed in the CRM container. This URI must be generated by the uriCallback.

uriCallback: (task: Task) => string

A callback that returns a URI to display in the CRM container based on a selected task. If you want to replace the CRMContainer component entirely, use the replace method instead.

1
flex.CRMContainer
2
  .defaultProps
3
  .uriCallback = (task) => task
4
    ? `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 (for example, if it's a static or "pinned" task for the User's Flex UI), it appears in the upper section of the TaskList Container.

By default, Flex treats both live and incoming calls as static tasks.

itemSize: 'Small' | 'Large' | 'LargeSelected'

The task list item size. Legal values include:

• Small (default): regular task list item size
• Large: all task list items are 156px bigger in height, allowing for custom info below the default task list item content via TaskExtraInfo template
• LargeSelected: 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 isn't shown. See Notifications Framework for more information about notifications.

showLiveCommsBar: Boolean

Displays an incoming call bar for views different from Agent UI.

compareFunction: (task1: Task, task2: Task) => number

Callback to control how Flex sorts tasks in the task list. A negative number means task1 should be above task2. A positive number that task1 should be below task2. The number 0 indicates equal priority.

showPanel2: Boolean

When set to false, completely removes the right side area of the Agent View, where the CRM ususally appears, 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
{
2
  initialFirstPanelSize?: string; 
3
  minimumFirstPanelSize?: string; 
4
  minimumSecondPanelSize?: string; 
5
}

splitterOrientation: 'auto' | 'vertical' | 'horizontal' (Default: auto)

Determines whether the orientation of the content is 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 Flex sorts agents in the agent list. A negative number means worker1 should be above worker2. A positive number that worker1 should be below worker2. The number 0 indicates equal priority.

showSkill: Boolean

Displays the skills section for the agent details.

details: Array<WorkerProfileDetail>

Adds 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 UI 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, like setting agent to Agent and customer to Customer.

1
{
2
  yourDefaultName?: string;
3
  theirDefaultName?: string;
4
  yourFriendlyNameOverride?: boolean;
5
  theirFriendlyNameOverride?: 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

Sets whether pressing the return key sends a message.

showButton: Boolean

Displays 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 appConfig.sso property as described in the following code sample.

1
appConfig.sso = {
2
  accountSid: string; // AccountSid of your Twilio Project
3
  loginPopup: Boolean; // whether to launch IdP login in new window
4
  loginPopupFeatures: string; // standard window.open() features param to be applied to popup window
5
};

The session state in Redux Store contains:

• loginState - state of the login
• ssoTokenPayload: the token payload from the Identity Provider
• identity: user identity used for SSO procedure
• loginError: an error occurred during login
• loginHandler: an object that contains parameters of the login procedure

uriCallback: (task: ITask) => string

Callback function that's called every time an active task is changed. You can provide a CRM URI for that particular task or a constant URI.

1
flex.CRMContainer
2
  .defaultProps
3
  .uriCallback = (task) => task
4
    ? `https://www.bing.com/search?q=${task.attributes.name}`
5
    : "http://bing.com/";