packages/components/eui-overlay/components/eui-overlay-header/eui-overlay-header-title/eui-overlay-header-title.component.ts
Title component for eui-overlay-header that displays a labeled heading with optional count badge and close button. Provides structured title area with consistent styling and accessibility features. Automatically includes a close/hide button that emits events for overlay dismissal. Must be used within eui-overlay-header to maintain proper header structure.
| encapsulation | ViewEncapsulation.None |
| selector | eui-overlay-header-title |
| imports |
BaseStatesDirective
EUI_BADGE
EUI_ICON_BUTTON
EUI_ICON
|
| templateUrl | ./eui-overlay-header-title.component.html |
Methods |
Inputs |
Outputs |
HostBindings |
Accessors |
| headerTitleCount |
Type : string
|
Default value : null
|
|
Count value displayed as a badge next to the title. Typically shows the number of items, notifications, or related content. Rendered as a visual badge component when provided. |
| headerTitleHideLabel |
Type : string
|
Default value : null
|
|
Accessible label for the close/hide button in the header. Provides screen reader text describing the button's action. |
| headerTitleLabel |
Type : string
|
Default value : null
|
|
Primary text label displayed as the overlay header title. Provides the main heading text for the overlay content. |
| hide |
Type : EventEmitter<any>
|
|
Emitted when the close/hide button in the header is clicked. Signals that the overlay should be dismissed or hidden. No specific payload is provided. |
| class |
Type : string
|
| onHide |
onHide()
|
|
Returns :
void
|
| cssClasses |
getcssClasses()
|