MainHeader
This is a container for MainHeader.
Can be themed with Theme.MainHeader in Theme.
Component children#
| Key | Component | Condition | Align | Description |
|---|---|---|---|---|
| sidenav-button | styled(div) | start | A wrapper that displays the main header menu button | |
| logo | styled(img) | Visible only when logoUrl is provided as prop. | start | Container for the main header logo |
| logo | img | Visible only when logoUrl is not provided as prop. | start | Default Header logo if logoUrl is not provided as prop |
| errorui-button | React component | end | A wrapper that displays the errors thrown in the current session | |
| dialpad-button | React component | Visible when outbound calling is enabled | end | A button that opens the Dialpad when clicked |
| user-controls | React component | end | A wrapper that displays the user controls | |
| activity | React component | end | A dropdown component that enables the user to change their activity status | |
| device-manager | React component | end | A menu component that enables the user to select input/output audio device | |
| locale-selector | React component | end | A dropdown component that enables the user to select language of Flex |
Static Properties#
| Name | Type | Description |
|---|---|---|
| Content | DynamicContentStore<MainHeader.MainHeaderChildrenProps, MainHeaderChildrenKeys> | Dynamic content store |
| defaultProps | MainHeader.MainHeaderProps | Default properties |
Component Properties#
| Name | Type | Description | Optional | Default |
|---|---|---|---|---|
| logoUrl | string | Logo URL shown in the main header. | Yes | |
| logoAltText | string | Logo alt text shown in the main header. | Yes | |
| Badge | ComponentBadgeProps<MainHeaderProps> | Set of properties for internal Badge element. | Yes | |
| Badge.children | number | function | Children of internal Badge component. | Yes | |
| isSideNavOpen | boolean | Whether the Sidebar is open or not. | Yes | |
| isOutboundDialerOpen | boolean | Whether the Outbound dialer is open or not. | Yes | |
| children | DynamicContentStore.DynamicComponentChildren<MainHeaderChildrenProps> | children | Yes |
Component Children Properties#
| Name | Type | Description | Optional | Default |
|---|---|---|---|---|
| incomingTasks | boolean | Deprecated - Whether there are any incoming tasks or not. | Yes | |
| isLiveVoiceCall | boolean | Whether there is a live voice call. | Yes | |
| isLiveVoiceConnection | boolean | Deprecated: use isLiveVoiceCall. | Yes | |
| Badge | Badge.BadgeProps | Set of properties for internal Badge element. | Yes | |
| logoUrl | string | Logo URL shown in the main header. | Yes | |
| logoAltText | string | Logo alt text shown in the main header. | Yes | |
| Badge | ComponentBadgeProps<MainHeaderProps> | Set of properties for internal Badge element. | Yes | |
| Badge.children | number | function | Children of internal Badge component. | Yes | |
| isSideNavOpen | boolean | Whether the Sidebar is open or not. | Yes | |
| isOutboundDialerOpen | boolean | Whether the Outbound dialer is open or not. | Yes | |
| children | DynamicContentStore.DynamicComponentChildren<MainHeaderChildrenProps> | children | Yes |