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 |
Static Properties#
Name | Description | Type |
---|---|---|
Content | Dynamic content store | DynamicContentStore.<MainHeader.MainHeaderChildrenProps> |
defaultProps | Default properties | MainHeader.MainHeaderProps |
Component Properties
logoUrl?: string
Logo URL shown in the main header.
logoAltText?: string
Logo alt text shown in the main header.
Badge?: ComponentBadgeProps.<MainHeaderProps>
Set of properties for internal Badge element.
Badge.children?: number | function
Children of internal Badge component.
isSideNavOpen?: boolean
Whether the Sidebar is open or not.
isOutboundDialerOpen?: boolean
Whether the Outbound dialer is open or not.
children?: DynamicContentStore.DynamicComponentChildren.<MainHeaderChildrenProps>
children