Flex UI Components

Below you can find a list of UI components and their details, that can be overridden programmatically. This can be done by using add, replace and remove methods with options.

1
Flex.Component.Content.add(<MyComponent key="demo-component"/>, {options});
2
Flex.Component.Content.replace(<MyComponent key="demo-component"/>, {options});

Example

Below is an example of adding a component called AnotherMuteButton to the MainHeader component, aligned to the end (here left) and placed as the first component in front of native components MuteButton and UserControls:

1
Flex.MainHeader.Content.add(<AnotherMuteButton key="mute"/>, {
2
  sortOrder: -1, 
3
  align: “end”
4
});

Remove method allows you to remove immediate children of a programmable component by their key.

Flex.Component.Content.remove(key, {options});

Example

Below is an example of removing the AnotherMuteButton component from the MainHeader component. This component is removed by the key we set above, "mute".

Flex.MainHeader.Content.remove("mute");

Used in both add and replace methods to add conditions on which component is added or replaced.

Example

1
Flex.MainHeader.Content.add(<AnotherMuteButton key="mute"/>, {
2
  if : props => props.task.source.taskChannelUniqueName === "custom1" 
3
});

Used in add method to specify the order in which the new component is placed in relation to other children of the parent component. Native children components take priority. Sort order counter starts with 0. To always place a new component at the very start or end of the order, use large numbers like -100 or 100, depending on the direction.

Example

1
Flex.MainHeader.Content.add(<AnotherMuteButton key="mute"/>, {
2
  sortOrder: -1
3
});

Used in the add method to align new components either to the top/bottom or right/left, depending on the direction of the parent component. Possible values are:

• start - Aligns new component on the left or top
• end - aligns new component on the right or bottom

Example

1
Flex.MainHeader.Content.add(<AnotherMuteButton key="mute"/>, {
2
  align: “end”
3
});

Each immediate child of a component has a key (required for the add and replace methods) and a set of properties that will be inherited by its children. To find a component's key or explore component props, go to Flex UI API Reference.

View Full Component Reference >

Direction: Horizontal

View Full Component Reference >

Direction: Horizontal

Expand image

View Full Component Reference >

Direction: Horizontal

Expand image

View Full Component Reference >

Direction: Horizontal

Expand image

Direction: Horizontal

Customizing the NotificationsBar is described in Notifications Framework

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Horizontal

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

For details on how to configure filters for the task list, see the UI configuration page.

Expand image

View Full Component Reference >

Direction: Vertical

Add / Replace / Remove and properties of the TaskListItem are described in the Task Channel Definition API.

Expand image

Direction: Horizontal

Add / Replace / Remove and properties of the TaskListItem are described in the Task Channel Definition API.

Expand image

Examples

Adding a button to Chat type task

1
Flex.DefaultTaskChannels.Chat.addedComponents = [{
2
  target: "TaskListButtons",
3
  component: <Flex.IconButton key="eye_button" icon="Eye" />
4
}];

Adding a button to Chat type task when it is in accepted state

1
Flex.DefaultTaskChannels.Chat.addedComponents = [{
2
  target: "TaskListButtons",
3
  component: <Flex.IconButton key="eye_button" icon="Eye" />,
4
  options: { if: props.task.status === "accepted" }
5
}];
6

Removing a reject button from Chat type task

1
Flex.DefaultTaskChannels.Chat.removedComponents = [{
2
  target: "TaskListButtons",
3
  key: "reject"
4
}];

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Horizontal

Expand image

View Full Component Reference >

Direction: Horizontal

Expand image

Example

Add tabs and content

1
import { Tab } from "@twilio/flex-ui"
2

3
init(flex, manager) {
4
  const Img = <img src="http://someimage.jpg" />; 
5

6
  flex.TaskCanvasTabs.Content.add(
7
    <Tab icon={Img} iconActive={Img} key="my-new-tab">
8
      <MyNewTabComponent/>
9
    </Tab>
10
  );
11
}

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Horizontal

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Horizontal

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Horizontal

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Horizontal

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

The Worker directory contains 2 tabs by default:

• Agents - key workers
• Queues - key queues

Example: Add new custom tab

1
Flex.WorkerDirectory.Tabs.Content.add(
2
  <Flex.Tab key="my-tab" label="My Tab">
3
        <div> "Hello World"
4
        </div>
5
  </Flex.Tab>
6
);

Worker Directory Tabs Hidden Filters

WorkerDirectoryTabs accepts 2 default props:

• hiddenWorkerFilter
• hiddenQueueFilter

These filters are applied to the list in combination with the filter applied by the user typing in the search string. You can programmatically apply a filter that is hidden from the user, i.e. the user cannot disable it. You could use this feature to pre-filter the list of available transferees an agent can search and choose from, to their team members or available agents only. In the following example, we use live query to:

• filter the agents list to only show agents with a specific team_name attribute ( you can set user attributes via your SSO provider )
• filter the agents list to only show agents that are in the Available activity
• filter the queues list to only show queues with a specific queue_name attribute

1
// Filter Agents by Worker Attributes or activity_name
2
Flex.WorkerDirectoryTabs.defaultProps.hiddenWorkerFilter = 'data.attributes.team_name CONTAINS "sales"'
3
Flex.WorkerDirectoryTabs.defaultProps.hiddenWorkerFilter = 'data.activity_name CONTAINS "Available"'
4

5
// Filter Queues by queue_name or queue_sid
6
Flex.WorkerDirectoryTabs.defaultProps.hiddenQueueFilter = 'data.queue_name CONTAINS "sales"'

The hidden filter feature is only available in @twilio/flex-ui@1.26.0 and later. Starting in 1.33.3, the hiddenWorkerFilter has been changed to queueFilter which takes a predicate function.

Flex.WorkerDirectoryTabs.defaultProps.queueFilter = (queue) => queue.queueName.includes("HR")

View Full Component Reference >

Direction: Horizontal

ParticipantsCanvas is a responsive component and will switch between regular mode and list mode depending on the size of the container its placed in. Regular mode and list mode contain different children - ParticipantCanvas and ParticipantCanvasListItem respectively. When customizing ParticipantsCanvas children, like adding an additional button, remember to do customization to both children components

Regular mode

Expand image

List mode

Expand image

View Full Component Reference >

Direction: Horizontal

Expand image

Direction: Vertical

Expand image

WorkersDataTable is a programmable component. It is a Material UI table styled to the Flex theme with data from the Insights SDK.

View Full Component Reference >

By default, WorkersDataTable contains the following rows:

• Agent - UserCard component

  • SupervisorUserCardFirstLine - default value retrieves the full name of the worker if it exists, and the identity if not. Variables provided to the template: worker
  • SupervisorUserCardSecondLine - default value shows the availability of the worker. Variables provided to the template: worker
  • The first and second row are template strings with names.
• Calls - TaskCardList component , showing tasks of the voice channel in assigned and wrapping state
• Other tasks - TaskCardList component , showing tasks of all channels (apart from voice) in assigned and wrapping state

Columns can be added to the table programmatically. Columns cannot be removed yet (the ability to do that is coming soon). You can add columns with different types of content:

• TaskCardList component
• Any custom component
• String

TaskCardList

1
import { TaskCardList, ColumnDefinition } from "@twilio/flex-ui";
2

3
Flex.WorkersDataTable.Content.add(
4
       <ColumnDefinition key="calls" header={"My Custom Header"} content={(items, context) => <TaskCardList tasks={items.tasks} />} />);

TaskCardList also has a filter prop which can be used here, and which is optional. If the filter prop is not set, all tasks in the list will be rendered:

1
export interface TaskCardListProps {
2
   compareFunction?: (a: TaskData, b: TaskData) => number;
3
   filter?: (task: TaskData) => boolean;
4
   tasks: TaskData[];
5
}

Any custom component

1
import { ColumnDefinition } from "@twilio/flex-ui";
2

3
Flex.WorkersDataTable.Content.add(<ColumnDefinition key="hello" header={"Helloxxx"} content={<div>hello</div>}/>);

String

You can use Worker attributes as follows:

1
import { ColumnDefinition } from "@twilio/flex-ui";
2

3
Flex.WorkersDataTable.Content.add(<ColumnDefinition key="team" header={"Team"} content={item => item.worker.attributes.team_name}/>);

By default, WorkersDataTable has 2 filters:

• All agents
• Active agents - worker with current activity state set of type available

Filters for the Workers Table can be programmatically changed, by defining filters property of WorkersDataTable component

Example of creating a filter to show workers with activity "Break"

With configuration object

1
   componentProps: {
2
        WorkersDataTable: {
3
            filters: [
4
                {
5
                    query: 'data.activity_name == "Break"',
6
                    text: "Workers on break"
7
                }
8
            ]
9
        }
10
    },...

With defaultProps API

1
Flex.WorkersDataTable.defaultProps.filters = [
2
                {
3
                    query: 'data.activity_name == "Break"',
4
                    text: "Workers on break"
5
                },...
6
            ]

Query data schema

data object in the query refers to TaskRouter worker resource. The following attributes on a worker can be used for filters query:

Query operators

WorkersDataTable is powered by Twilio Sync and we use Twilio Sync Live Query for filtering of the workers. See Live Query docs for supported query operators.

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Horizontal

Expand image

Direction: Horizontal

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Horizontal

Expand image

Worker directory contains 2 tabs by default:

• Overview - key overview. Overview Tab has dynamic content based on the type of task

  • For standard conference based voice tasks - ParticipantsCanvas
  • For messaging tasks - MessagingCanvas
• Info - key info . Info tab Contains SupervisorTaskInfoPanel

Examples

Adding tabs and content

1
Flex.Supervisor.TaskCanvasTabs.Content.add(
2
  <Flex.Tab key="my-tab" label="My Tab">
3
        <div> "Hello World"
4
        </div>
5
  </Flex.Tab>
6
);

View Full Component Reference >

Direction: Horizontal

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

Expand image

View Full Component Reference >

Direction: Vertical

Expand image