SiPopoverLegacyDirective documentation¶

selectorexported-as

[siPopoverLegacy]si-popover

Deprecated: Use SiPopoverDirective instead.

Name	Type	Default	Description
containerClass ¶	`string`	`''`	The class that will be applied to container of the popover
icon ¶	`string`		The icon to be displayed besides popover title
isOpen ¶	(`undefined` \| `boolean`)	`false`	Specify whether or not the popover is currently shown
outsideClick ¶	`boolean`	`true`	The flag determines whether to close popover on clicking outside
placement ¶	(`"auto"` \| `"end"` \| `"start"` \| `"top"` \| `"bottom"`)	`'auto'`	The placement of the popover. One of 'top', 'start', end', 'bottom'
popoverContext ¶	`unknown`		The context for the attached template
popoverTitle ¶	`string`	`''`	The title to be displayed on top for the popover
siPopoverLegacy ¶	(`string` \| `TemplateRef`<`any`>)		The popover text to be displayed
triggers ¶	`string`	`'click'`	The trigger event(s) on which the popover shall be displayed. Applications can pass multiple triggers separated by space. Supported events are 'click', 'hover' and 'focus'. Limitations: Safari browsers do not raise a 'focus' event on host element click and 'focus' on tab key has to be enabled in the advanced browser settings.

Name	Type	Description
hidden ¶	`void`	Emits an event when the popover is hidden
shown ¶	`void`	Emits an event when the popover is shown

Name	Type	Default	Description
hide() ¶	() => `void`		Hides the popover and emits 'hidden' event.
(readonly) placementInternal ¶	`Signal`<(`"auto"` \| `"end"` \| `"start"` \| `"top"` \| `"bottom"`)>	...
show() ¶	() => `void`		Displays popover and emits 'shown' event.
updatePosition() ¶	() => `void`		Updates the position of the popover based on the position strategy.

TranslatableString (`string` & `Translatable`)¶ Type alias Represents a translatable string. This can either be a translation key, e.g. `ACTIONS.EDIT` that will be automatically translated when displayed on the UI or a pre-translated string, e.g. `Edit` . Equivalent to a normal string in usage and functionality.

Translatable ¶ import imported from @siemens/element-translate-ng

implements OnDestroy¶

▶

Constructor
() => `{}`¶

Properties
The class that will be applied to container of the popover containerClass: `InputSignal`<`string`> = `''`¶
The context for the attached template context: `InputSignal`<`unknown`> = `undefined`¶
destroyer: `Subject`<`void`> = ...¶
elementRef: `ElementRef`<`any`> = ...¶
The icon to be displayed besides popover title icon: `InputSignal`<(`undefined` \| `string`)> = `undefined`¶
isOpen: `WritableSignal`<`boolean`> = ...¶
overlay: `Overlay` = ...¶
overlayref?: `OverlayRef`¶
The placement of the popover. One of 'top', 'start', end', 'bottom' placement: `InputSignal`<(`"auto"` \| `"end"` \| `"start"` \| `"top"` \| `"bottom"`)> = `'auto'`¶
placementInternal: `Signal`<(`"auto"` \| `"end"` \| `"start"` \| `"top"` \| `"bottom"`)> = ...¶
popoverCounter: `number` = ...¶
popoverId: `string` = ...¶
The popover text to be displayed siPopover: `InputSignal`<(`undefined` \| `TranslatableString` \| `TemplateRef`<`unknown`>)> = ...¶
The title to be displayed on top for the popover title: `InputSignal`<(`undefined` \| `TranslatableString`)> = `undefined`¶
Emits an event when the popover is shown/hidden visibilityChange: `OutputEmitterRef`<`void`> = ...¶
idCounter: `number` = `0`¶

Methods
Hides the popover and emits 'hidden' event. hide: () => `void`¶
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed. ngOnDestroy: () => `void` from `OnDestroy.ngOnDestroy`¶
onClick: () => `void`¶
Displays popover and emits 'shown' event. show: () => `void`¶
Updates the position of the popover based on the position strategy. updatePosition: () => `void`¶

Except where otherwise noted, content on this site is licensed under MIT License.