@anguless/angulux/popover

popover

1 declarations1 demos

import

import { PopoverModule } from '@anguless/angulux/popover';

Basic

A popover is anchored to whatever opened it and dismissed by clicking away.

<agl-button label="Show" (onClick)="op.toggle($event)" /><agl-popover #op>    <p style="margin: 0; max-width: 18rem">A popover is anchored to whatever opened it, and closes when you click away.</p></agl-popover>

API

Generated from the committed corpus, which check:corpus holds to the built library.

Popover

componentagl-popover

Popover is a container component that can overlay other components on page.

Input	Type	Default	Description
ariaLabel	string \| undefined	not documented	Defines a string that labels the input for accessibility.
ariaLabelledBy	string \| undefined	not documented	Establishes relationships between the component and label(s) where its value should be one or more element IDs.
dismissable	boolean	not documented	Enables to hide the overlay when outside is clicked.
style	{ [klass: string]: any } \| null \| undefined	not documented	Inline style of the component.
styleClass	string \| undefined	not documented	Style class of the component.
appendTo	HTMLElement \| ElementRef \| TemplateRef<any> \| 'self' \| 'body' \| null \| undefined \| any	'self'	Target element to attach the overlay, valid values are "body" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]="mydiv" for a div element having #mydiv as variable name).
autoZIndex	boolean	not documented	Whether to automatically manage layering.
ariaCloseLabel	string \| undefined	not documented	Aria label of the close icon.
baseZIndex	number	not documented	Base zIndex value to use in layering.
focusOnShow	boolean	not documented	When enabled, first button receives focus on show.
showTransitionOptions deprecated — since v21.0.0. Use `motionOptions` instead.	string	not documented	Transition options of the show animation.
hideTransitionOptions deprecated — since v21.0.0. Use `motionOptions` instead.	string	not documented	Transition options of the hide animation.
motionOptions	MotionOptions \| undefined	not documented	The motion options.

Output	Type	Description
onShow	EventEmitter<any>	Callback to invoke when an overlay becomes visible.
onHide	EventEmitter<any>	Callback to invoke when an overlay gets hidden.

Template slot	Description
<ng-template #content>	Custom content template.

Inherited from BaseComponent

inherited

Input	Type	Default	Description
dt	Object \| undefined	undefined	Defines scoped design tokens of the component.
unstyled	boolean \| undefined	undefined	Indicates whether the component should be rendered without styles.
pt	PT \| undefined	undefined	Used to pass attributes to DOM elements inside the component. TRUSTED INPUT ONLY. Whatever you put here is applied to the DOM as given: keys become attributes, and a key that names a DOM property is assigned to that property directly, with no sanitizer in between. That is what makes the API useful, and it means a value reaching it from a user, a database or a CMS can execute script. Treat it like markup you wrote yourself, not like data you received.
ptOptions	PassThroughOptions \| undefined	undefined	Used to configure passthrough(pt) options of the component.