packages/eui/packages/components/eui-dimmer/dimmer.component.ts
EuiDimmerComponent provides a dimming overlay on the page.
The dimmer can be manually activated by setting isDimmerActive
to true,
or automatically controlled via browser navigation events.
changeDetection | ChangeDetectionStrategy.Default |
encapsulation | ViewEncapsulation.None |
selector | eui-dimmer |
styleUrls | ./dimmer.scss |
Properties |
Inputs |
HostBindings |
Accessors |
constructor()
|
Creates an instance of EuiDimmerComponent. Listens to router navigation events to handle dimmer state during navigation, particularly when the user navigates back in browser history. |
e2eAttr |
Type : string
|
Default value : 'eui-dimmer'
|
E2E testing attribute for the component. |
isDimmerActive |
Type : boolean
|
Gets the active state of the dimmer. |
class |
Type : string
|
Gets the CSS classes to apply to the host element. Adds the 'eui-dimmer--active' class when the dimmer is active. |
asService |
Default value : inject(EuiAppShellService)
|
isDimmerActive | ||||||||
getisDimmerActive()
|
||||||||
Gets the active state of the dimmer.
Returns :
boolean
|
||||||||
setisDimmerActive(value: BooleanInput)
|
||||||||
Sets the active state of the dimmer.
Parameters :
Returns :
void
|
cssClasses |
getcssClasses()
|
Gets the CSS classes to apply to the host element. Adds the 'eui-dimmer--active' class when the dimmer is active.
Returns :
string
|