@anguless/angulux/tieredmenu

tieredmenu

2 declarations2 demos

import

import { TieredMenuModule } from '@anguless/angulux/tieredmenu';

Basic

TieredMenu is Menu with submenus that open on their own.

<agl-tieredMenu [model]="items" />

Popup

The same menu, opened from a trigger instead of sitting inline.

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

API

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

TieredMenuSub

componentagl-tieredMenuSub, agl-tieredmenusub

Input	Type	Default
visible	boolean	not documented
items	any[]	not documented
itemTemplate	TemplateRef<TieredMenuItemTemplateContext> \| undefined	not documented
root	boolean \| undefined	not documented
autoDisplay	boolean \| undefined	not documented
autoZIndex	boolean	not documented
baseZIndex	number	not documented
popup	boolean \| undefined	not documented
menuId	string \| undefined	not documented
ariaLabel	string \| undefined	not documented
ariaLabelledBy	string \| undefined	not documented
level	number	not documented
focusedItemId	string \| undefined	not documented
activeItemPath	any[]	not documented
motionOptions	MotionOptions[] \| undefined	not documented
tabindex	number	not documented
inlineStyles	{ [klass: string]: any } \| null \| undefined	not documented

Output	Type	Description
itemClick	EventEmitter<any>
itemMouseEnter	EventEmitter<any>
menuFocus	EventEmitter<any>
menuBlur	EventEmitter<any>
menuKeydown	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.

TieredMenu

componentagl-tieredMenu, agl-tieredmenu, agl-tiered-menu

TieredMenu displays submenus in nested overlays.

Input	Type	Default	Description
model		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.
breakpoint	string	not documented	The breakpoint to define the maximum width boundary.
autoZIndex	boolean	not documented	Whether to automatically manage layering.
baseZIndex	number	not documented	Base zIndex value to use in layering.
autoDisplay	boolean \| undefined	true	Whether to show a root submenu on mouse over.
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.
id	string \| undefined	not documented	Current id state as a string.
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.
disabled	boolean	not documented	When present, it specifies that the component should be disabled.
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.

Template slot	Description
<ng-template #submenuicon>	Custom submenu icon template.
<ng-template #item>	Custom item 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.