angulux v22.4.0 +1 unreleased

@anguless/angulux/menu

menu

2 declarations2 demos

import

import { MenuModule } from '@anguless/angulux/menu';

Popup

A popup menu is opened from a trigger by calling toggle with the event.

<agl-button label="Show" icon="pi pi-bars" (onClick)="menu.toggle($event)" /><agl-menu #menu [model]="items" [popup]="true" />

API

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

MenuItemContent

component[aglMenuItemContent]

Input	Type	Default	Description
aglMenuItemContent property item	MenuItem \| undefined	not documented
itemTemplate	any \| undefined	not documented
menuitemId	string	not documented
idx	number	not documented

Output	Type	Description
onMenuItemClick	EventEmitter<any>

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.

Menu

componentagl-menu

Menu is a navigation / command component that supports dynamic and static positioning.

Input	Type	Default	Description
model	MenuItem[] \| undefined	not documented	An array of menuitems.
popup	boolean \| undefined	not documented	Defines if menu would displayed as a popup.
style	{ [klass: string]: any } \| null \| undefined	not documented	Inline style of the component.
styleClass	string \| undefined	not documented	Style class of the component.
autoZIndex	boolean	not documented	Whether to automatically manage layering.
baseZIndex	number	not documented	Base zIndex value to use in layering.
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.
ariaLabel	string \| undefined	not documented	Defines a string value that labels an interactive element.
ariaLabelledBy	string \| undefined	not documented	Identifier of the underlying input element.
id	string \| undefined	not documented	Current id state as a string.
tabindex	number	not documented	Index of the element in tabbing order.
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).
motionOptions	MotionOptions \| undefined	not documented	The motion options.

Output	Type	Description
onShow	EventEmitter<any>	Callback to invoke when overlay menu is shown.
onHide	EventEmitter<any>	Callback to invoke when overlay menu is hidden.
onBlur	EventEmitter<Event>	Callback to invoke when the list loses focus.
onFocus	EventEmitter<Event>	Callback to invoke when the list receives focus.

Template slot	Description
<ng-template #start>	Defines template option for start.
<ng-template #end>	Defines template option for end.
<ng-template #item>	Custom item template.
<ng-template #submenuheader>	Custom submenu header 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.