The Flex UI v1
The Flex UI allows developers to build a custom user experience and custom behaviors for the Flex Agent Desktop and Flex Supervisor Desktop.
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 Twilio Client, Programmable Chat, and TaskRouter.
Overview
This documentation provides information about:
- Configure the UI or manipulate default properties for standard Flex components
- Customize themes and styles
- Control localization and templates
- Add, replace or remove components
- Take advantage of UI actions by listening, intercepting and manipulating UI events
- Customize agent desktop notifications using Notifications Framework
- Alter behavior and appearance for native channels and define custom ones with Task Channel Definition API
- Mix-in Task or Theme context to your custom components
- Leverage the Flex Manager object to get access and control underlying SDKs
- Programmatically customize 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
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
