On this page

Flex UI 1.x.x

(information)

This page applies to Flex UI 1.x.x.

For the Flex UI 2.x.x version of this content, see The Flex UI.

The Flex UI allows developers to build a custom user experience and custom behaviors for the Flex Agent Desktop and Flex Supervisor Desktop.

(information)

Info

Auto-Generated Documentation for the Flex UI is now available as a public beta distribution. The auto-generated documentation is accurate and comprehensive, and so may differ from what you see in the official Flex UI documentation.

The Flex UI Component Library is built in React and published on NPM. @twilio/flex-ui is a node package that provides all the individual elements of the UI at the component level. It also provides a high-level API to interact with bundled SDKs such as the Voice JavaScript SDK, Programmable Chat, and TaskRouter.

Overview

This documentation provides information about:

Configuring the UI or customizing default properties for standard Flex components
Customizing themes and styles
Controling localization and templates
Adding, replacing, or removing components
Taking advantage of UI actions to listen for, receive, and customize UI events
Customizing agent desktop notifications using the Notifications Framework
Modifying the behavior and appearance of native channels and defining custom channels with Task Channel Definition API
Adding task or theme context to your custom components
Leveraging the Flex Manager object to get access and control underlying SDKs
Programmatically customizing the UI using Plugin Builder

Building with plugins

If you're building with the Flex UI, chances are you're also using Flex Plugins. The Flex UI documentation will provide you with the programming interfaces and best practices you need to augment the Flex UI. The Plugin docs will explain the development environment, and help set you up to take advantage of the Flex UI's programmability.

Next steps

Build your first React-based Flex plugin
Explore how the Flex UI uses Redux, a state management tool
Discover the various components of the Flex UI