# Angulux — full API

> Angulux is an Angular 22 UI component library, forked from the last MIT release of PrimeNG (21.1.9). Selectors are `agl-*` and entry points are `@anguless/angulux/<module>` — code written against PrimeNG's `p-*` selectors will not work. This index covers 64 supported modules, 165 components and directives, 1205 inputs, of which 69 are deprecated. Every page is generated from the library's own source, so an input absent here does not exist.

# api

```ts
import { … } from '@anguless/angulux/api';
```

This module declares no component or directive. It is internal infrastructure that other
modules depend on, and there is nothing here to use directly.

# autofocus

```ts
import { … } from '@anguless/angulux/autofocus';
```

## AutoFocus

`[aglAutoFocus]` — directive

AutoFocus manages focus on focusable element on load.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `autofocus` | `boolean` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |

# avatar

```ts
import { … } from '@anguless/angulux/avatar';
```

## Avatar

`agl-avatar` — component

Avatar represents people using icons, labels and images.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `label` | `string \| undefined` | _not documented_ | Defines the text to display. |
| `icon` | `string \| undefined` | _not documented_ | Defines the icon to display. |
| `image` | `string \| undefined` | _not documented_ | Defines the image to display. |
| `size` | `'normal' \| 'large' \| 'xlarge' \| undefined` | _not documented_ | Size of the element. |
| `shape` | `'square' \| 'circle' \| undefined` | _not documented_ | Shape of the element. |
| `styleClass` | `string \| undefined` | _not documented_ | Class of the element. **Deprecated:** since v20.0.0, use `class` instead. |
| `ariaLabel` | `string \| undefined` | _not documented_ | Establishes a string value that labels the component. |
| `ariaLabelledBy` | `string \| undefined` | _not documented_ | Establishes relationships between the component and label(s) where its value should be one or more element IDs. |

| Output | Type | Description |
| --- | --- | --- |
| `onImageError` | `EventEmitter<Event>` | This event is triggered if an error occurs while loading an image file. |

# avatargroup

```ts
import { … } from '@anguless/angulux/avatargroup';
```

## AvatarGroup

`agl-avatarGroup, agl-avatar-group, agl-avatargroup` — component

AvatarGroup is a helper component for Avatar.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component |
| `style` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the component. |

# badge

```ts
import { … } from '@anguless/angulux/badge';
```

## BadgeDirective

`[aglBadge]` — directive

Badge Directive is directive usage of badge component.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `ptBadgeDirective` | `BadgePassThrough \| undefined` | `undefined` | Used to pass attributes to DOM elements inside the Badge component. **Deprecated:** use pBadgePT instead. |
| `pBadgePT` | `BadgePassThrough \| undefined` | `undefined` | Used to pass attributes to DOM elements inside the Badge component. |
| `pBadgeUnstyled` | `boolean \| undefined` | `undefined` | Indicates whether the component should be rendered without styles. |
| `disabled` | `boolean` | _not documented_ | When specified, disables the component. |
| `badgeSize` | `'large' \| 'xlarge' \| 'small' \| null \| undefined` | _not documented_ | Size of the badge, valid options are "large" and "xlarge". |
| `size` | `` | _not documented_ | Size of the badge, valid options are "large" and "xlarge". **Deprecated:** use badgeSize instead. |
| `severity` | `'secondary' \| 'info' \| 'success' \| 'warn' \| 'danger' \| 'contrast' \| null \| undefined` | _not documented_ | Severity type of the badge. |
| `value` | `string \| number` | _not documented_ | Value to display inside the badge. |
| `badgeStyle` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the element. |
| `badgeStyleClass` | `string` | _not documented_ | Class of the element. |

## Badge

`agl-badge` — component

Badge is a small status indicator for another element.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `styleClass` | `string` | _not documented_ | Class of the element. **Deprecated:** since v20.0.0, use `class` instead. |
| `badgeSize` | `'small' \| 'large' \| 'xlarge' \| null` | _not documented_ | Size of the badge, valid options are "large" and "xlarge". |
| `size` | `'small' \| 'large' \| 'xlarge' \| null` | _not documented_ | Size of the badge, valid options are "large" and "xlarge". |
| `severity` | `'secondary' \| 'info' \| 'success' \| 'warn' \| 'danger' \| 'contrast' \| null` | _not documented_ | Severity type of the badge. |
| `value` | `string \| number \| null` | _not documented_ | Value to display inside the badge. |
| `badgeDisabled` | `boolean` | _not documented_ | When specified, disables the component. |

# base

```ts
import { … } from '@anguless/angulux/base';
```

This module declares no component or directive. It is internal infrastructure that other
modules depend on, and there is nothing here to use directly.

# basecomponent

```ts
import { … } from '@anguless/angulux/basecomponent';
```

## BaseComponent

`` — directive

| 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. |
| `ptOptions` | `PassThroughOptions \| undefined` | `undefined` | Used to configure passthrough(pt) options of the component. |

# baseeditableholder

```ts
import { … } from '@anguless/angulux/baseeditableholder';
```

## BaseEditableHolder

`` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `required` | `` | `false` | There must be a value (if set). |
| `invalid` | `` | `false` | When present, it specifies that the component should have invalid state style. |
| `disabled` | `` | `false` | When present, it specifies that the component should have disabled state style. |
| `name` | `string \| undefined` | `undefined` | When present, it specifies that the name of the input. |

# baseinput

```ts
import { … } from '@anguless/angulux/baseinput';
```

## BaseInput

`` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `fluid` | `` | `false` | Spans 100% width of the container when enabled. |
| `variant` | `'filled' \| 'outlined' \| undefined` | `'outlined'` | Specifies the input variant of the component. |
| `size` | `'large' \| 'small' \| undefined` | `undefined` | Specifies the size of the component. |
| `inputSize` | `number \| null \| undefined` | `undefined` | Specifies the visible width of the input element in characters. |
| `pattern` | `string \| null \| undefined` | `undefined` | Specifies the value must match the pattern. |
| `min` | `number \| null \| undefined` | `undefined` | The value must be greater than or equal to the value. |
| `max` | `number \| null \| undefined` | `undefined` | The value must be less than or equal to the value. |
| `step` | `number \| null \| undefined` | `undefined` | Unless the step is set to the any literal, the value must be min + an integral multiple of the step. |
| `minlength` | `number \| null \| undefined` | `undefined` | The number of characters (code points) must not be less than the value of the attribute, if non-empty. |
| `maxlength` | `number \| null \| undefined` | `undefined` | The number of characters (code points) must not exceed the value of the attribute. |

# basemodelholder

```ts
import { … } from '@anguless/angulux/basemodelholder';
```

## BaseModelHolder

`` — directive

# bind

```ts
import { … } from '@anguless/angulux/bind';
```

## Bind

`[aglBind]` — directive

Bind directive provides dynamic attribute, property, and event listener binding functionality.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `aglBind` | `{ [key: string]: any } \| undefined` | _not documented_ | Dynamic attributes, properties, and event listeners to be applied to the host element. |

# button

```ts
import { … } from '@anguless/angulux/button';
```

## ButtonLabel

`[aglButtonLabel]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `ptButtonLabel` | `any` | `undefined` | Used to pass attributes to DOM elements inside the aglButtonLabel. **Deprecated:** use pButtonLabelPT instead. |
| `pButtonLabelPT` | `any` | `undefined` | Used to pass attributes to DOM elements inside the aglButtonLabel. |
| `pButtonLabelUnstyled` | `boolean \| undefined` | `undefined` | Indicates whether the component should be rendered without styles. |

## ButtonIcon

`[aglButtonIcon]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `ptButtonIcon` | `any` | `undefined` | Used to pass attributes to DOM elements inside the aglButtonIcon. **Deprecated:** use pButtonIconPT instead. |
| `pButtonIconPT` | `any` | `undefined` | Used to pass attributes to DOM elements inside the aglButtonIcon. |
| `pButtonUnstyled` | `boolean \| undefined` | `undefined` | Indicates whether the component should be rendered without styles. |

## ButtonDirective

`[aglButton]` — directive

Button directive is an extension to button component.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `ptButtonDirective` | `ButtonPassThrough` | `undefined` | Used to pass attributes to DOM elements inside the Button component. **Deprecated:** use pButtonPT instead. |
| `pButtonPT` | `ButtonPassThrough` | `undefined` | Used to pass attributes to DOM elements inside the Button component. |
| `pButtonUnstyled` | `boolean \| undefined` | `undefined` | Indicates whether the component should be rendered without styles. |
| `hostName` | `any` | _not documented_ |  |
| `text` | `boolean` | _not documented_ | Add a textual class to the button without a background initially. |
| `plain` | `boolean` | _not documented_ | Add a plain textual class to the button without a background initially. |
| `raised` | `boolean` | _not documented_ | Add a shadow to indicate elevation. |
| `size` | `'small' \| 'large' \| undefined` | _not documented_ | Defines the size of the button. |
| `outlined` | `boolean` | _not documented_ | Add a border class without a background initially. |
| `rounded` | `boolean` | _not documented_ | Add a circular border radius to the button. |
| `iconPos` | `ButtonIconPosition` | _not documented_ | Position of the icon. |
| `loadingIcon` | `string \| undefined` | _not documented_ | Icon to display in loading state. |
| `fluid` | `` | `undefined` | Spans 100% width of the container when enabled. |
| `label` | `string \| undefined` | _not documented_ | Text of the button. **Deprecated:** use aglButtonLabel directive instead. |
| `icon` | `string` | _not documented_ | Name of the icon. **Deprecated:** use aglButtonIcon directive instead |
| `loading` | `boolean` | _not documented_ | Whether the button is in loading state. |
| `buttonProps` | `ButtonProps` | _not documented_ | Used to pass all properties of the ButtonProps to the Button component. **Deprecated:** assign props directly to the button element. |
| `severity` | `ButtonSeverity` | _not documented_ | Defines the style of the button. |

## Button

`agl-button` — component

Button is an extension to standard button element with icons and theming.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `hostName` | `any` | _not documented_ |  |
| `type` | `string` | _not documented_ | Type of the button. |
| `badge` | `string \| undefined` | _not documented_ | Value of the badge. |
| `disabled` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should be disabled. |
| `raised` | `boolean` | _not documented_ | Add a shadow to indicate elevation. |
| `rounded` | `boolean` | _not documented_ | Add a circular border radius to the button. |
| `text` | `boolean` | _not documented_ | Add a textual class to the button without a background initially. |
| `plain` | `boolean` | _not documented_ | Add a plain textual class to the button without a background initially. |
| `outlined` | `boolean` | _not documented_ | Add a border class without a background initially. |
| `link` | `boolean` | _not documented_ | Add a link style to the button. |
| `tabindex` | `number \| undefined` | _not documented_ | Add a tabindex to the button. |
| `size` | `'small' \| 'large' \| undefined` | _not documented_ | Defines the size of the button. |
| `variant` | `'outlined' \| 'text' \| undefined` | _not documented_ | Specifies the variant of the component. |
| `style` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the element. |
| `styleClass` | `string \| undefined` | _not documented_ | Class of the element. |
| `badgeClass` | `string \| undefined` | _not documented_ | Style class of the badge. **Deprecated:** use badgeSeverity instead. |
| `badgeSeverity` | `'success' \| 'info' \| 'warn' \| 'danger' \| 'help' \| 'primary' \| 'secondary' \| 'contrast' \| null \| undefined` | `secondary` | Severity type of the badge. |
| `ariaLabel` | `string \| undefined` | _not documented_ | Used to define a string that autocomplete attribute the current element. |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |
| `iconPos` | `ButtonIconPosition` | _not documented_ | Position of the icon. |
| `icon` | `string \| undefined` | _not documented_ | Name of the icon. |
| `label` | `string \| undefined` | _not documented_ | Text of the button. |
| `loading` | `boolean` | _not documented_ | Whether the button is in loading state. |
| `loadingIcon` | `string \| undefined` | _not documented_ | Icon to display in loading state. |
| `severity` | `ButtonSeverity` | _not documented_ | Defines the style of the button. |
| `buttonProps` | `ButtonProps` | _not documented_ | Used to pass all properties of the ButtonProps to the Button component. |
| `fluid` | `` | `undefined` | Spans 100% width of the container when enabled. |

| Output | Type | Description |
| --- | --- | --- |
| `onClick` | `EventEmitter<MouseEvent>` | Callback to execute when button is clicked. This event is intended to be used with the <agl-button> component. Using a regular <button> element, use (click). |
| `onFocus` | `EventEmitter<FocusEvent>` | Callback to execute when button is focused. This event is intended to be used with the <agl-button> component. Using a regular <button> element, use (focus). |
| `onBlur` | `EventEmitter<FocusEvent>` | Callback to execute when button loses focus. This event is intended to be used with the <agl-button> component. Using a regular <button> element, use (blur). |

# card

```ts
import { … } from '@anguless/angulux/card';
```

## Card

`agl-card` — component

Card is a flexible container component.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `header` | `string \| undefined` | _not documented_ | Header of the card. |
| `subheader` | `string \| undefined` | _not documented_ | Subheader of the card. |
| `style` | `` | _not documented_ | Inline style of the element. |
| `styleClass` | `string \| undefined` | _not documented_ | Class of the element. **Deprecated:** since v20.0.0, use `class` instead. |

# chart

```ts
import { … } from '@anguless/angulux/chart';
```

## UIChart

`agl-chart` — component

Chart groups a collection of contents in tabs.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `type` | `'bar' \| 'line' \| 'scatter' \| 'bubble' \| 'pie' \| 'doughnut' \| 'polarArea' \| 'radar' \| undefined` | _not documented_ | Type of the chart. |
| `plugins` | `any[]` | _not documented_ | Array of per-chart plugins to customize the chart behaviour. |
| `width` | `string \| undefined` | _not documented_ | Width of the chart. |
| `height` | `string \| undefined` | _not documented_ | Height of the chart. |
| `responsive` | `boolean` | _not documented_ | Whether the chart is redrawn on screen size change. |
| `ariaLabel` | `string \| undefined` | _not documented_ | Used to define a string that autocomplete attribute the current element. |
| `ariaLabelledBy` | `string \| undefined` | _not documented_ | Establishes relationships between the component and label(s) where its value should be one or more element IDs. |
| `data` | `any` | _not documented_ | Data to display. |
| `options` | `any` | _not documented_ | Options to customize the chart. |

| Output | Type | Description |
| --- | --- | --- |
| `onDataSelect` | `EventEmitter<any>` | Callback to execute when an element on chart is clicked. |

# checkbox

```ts
import { … } from '@anguless/angulux/checkbox';
```

## Checkbox

`agl-checkbox, agl-checkBox, agl-check-box` — component

Checkbox is an extension to standard checkbox element with theming.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `hostName` | `any` | _not documented_ |  |
| `value` | `any` | _not documented_ | Value of the checkbox. |
| `binary` | `boolean \| undefined` | _not documented_ | Allows to select a boolean value instead of multiple values. |
| `ariaLabelledBy` | `string \| undefined` | _not documented_ | Establishes relationships between the component and label(s) where its value should be one or more element IDs. |
| `ariaLabel` | `string \| undefined` | _not documented_ | Used to define a string that labels the input element. |
| `tabindex` | `number \| undefined` | _not documented_ | Index of the element in tabbing order. |
| `inputId` | `string \| undefined` | _not documented_ | Identifier of the focus input to match a label defined for the component. |
| `inputStyle` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the input element. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `inputClass` | `string \| undefined` | _not documented_ | Style class of the input element. |
| `indeterminate` | `boolean` | _not documented_ | When present, it specifies input state as indeterminate. |
| `formControl` | `FormControl \| undefined` | _not documented_ | Form control value. |
| `checkboxIcon` | `string \| undefined` | _not documented_ | Icon class of the checkbox icon. |
| `readonly` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component cannot be edited. |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |
| `trueValue` | `any` | _not documented_ | Value in checked state. |
| `falseValue` | `any` | _not documented_ | Value in unchecked state. |
| `variant` | `'filled' \| 'outlined' \| undefined` | `undefined` | Specifies the input variant of the component. |
| `size` | `'large' \| 'small' \| undefined` | `undefined` | Specifies the size of the component. |

| Output | Type | Description |
| --- | --- | --- |
| `onChange` | `EventEmitter<CheckboxChangeEvent>` | Callback to invoke on value change. |
| `onFocus` | `EventEmitter<Event>` | Callback to invoke when the receives focus. |
| `onBlur` | `EventEmitter<Event>` | Callback to invoke when the loses focus. |

# chip

```ts
import { … } from '@anguless/angulux/chip';
```

## Chip

`agl-chip` — component

Chip represents people using icons, labels and images.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `label` | `string \| undefined` | _not documented_ | Defines the text to display. |
| `icon` | `string \| undefined` | _not documented_ | Defines the icon to display. |
| `image` | `string \| undefined` | _not documented_ | Defines the image to display. |
| `alt` | `string \| undefined` | _not documented_ | Alt attribute of the image. |
| `styleClass` | `string \| undefined` | _not documented_ | Class of the element. **Deprecated:** since v20.0.0, use `class` instead. |
| `disabled` | `boolean \| undefined` | _not documented_ | When present, it specifies that the element should be disabled. |
| `removable` | `boolean \| undefined` | _not documented_ | Whether to display a remove icon. |
| `removeIcon` | `string \| undefined` | _not documented_ | Icon of the remove element. |
| `chipProps` | `ChipProps \| undefined` | _not documented_ | Used to pass all properties of the chipProps to the Chip component. |

| Output | Type | Description |
| --- | --- | --- |
| `onRemove` | `EventEmitter<MouseEvent>` | Callback to invoke when a chip is removed. |
| `onImageError` | `EventEmitter<Event>` | This event is triggered if an error occurs while loading an image file. |

# colorpicker

```ts
import { … } from '@anguless/angulux/colorpicker';
```

## ColorPicker

`agl-colorPicker, agl-colorpicker, agl-color-picker` — component

ColorPicker groups a collection of contents in tabs.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `showTransitionOptions` | `string` | _not documented_ | Transition options of the show animation. **Deprecated:** since v21.0.0, use `motionOptions` instead. |
| `hideTransitionOptions` | `string` | _not documented_ | Transition options of the hide animation. **Deprecated:** since v21.0.0, use `motionOptions` instead. |
| `inline` | `boolean \| undefined` | _not documented_ | Whether to display as an overlay or not. |
| `format` | `'hex' \| 'rgb' \| 'hsb'` | _not documented_ | Format to use in value binding. |
| `tabindex` | `string \| undefined` | _not documented_ | Index of the element in tabbing order. |
| `inputId` | `string \| undefined` | _not documented_ | Identifier of the focus input to match a label defined for the dropdown. |
| `autoZIndex` | `boolean` | _not documented_ | Whether to automatically manage layering. |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |
| `defaultColor` | `string \| undefined` | _not documented_ | Default color to display initially when model value is not present. |
| `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). |
| `overlayOptions` | `OverlayOptions \| undefined` | _not documented_ | Whether to use overlay API feature. The properties of overlay API can be used like an object in it. |
| `motionOptions` | `MotionOptions \| undefined` | _not documented_ | The motion options. |

| Output | Type | Description |
| --- | --- | --- |
| `onChange` | `EventEmitter<ColorPickerChangeEvent>` | Callback to invoke on value change. |
| `onShow` | `EventEmitter<any>` | Callback to invoke on panel is shown. |
| `onHide` | `EventEmitter<any>` | Callback to invoke on panel is hidden. |

# config

```ts
import { … } from '@anguless/angulux/config';
```

This module declares no component or directive. It is internal infrastructure that other
modules depend on, and there is nothing here to use directly.

# confirmdialog

```ts
import { … } from '@anguless/angulux/confirmdialog';
```

## ConfirmDialog

`agl-confirmDialog, agl-confirmdialog, agl-confirm-dialog` — component

ConfirmDialog uses a Dialog UI that is integrated with the Confirmation API.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `header` | `string \| undefined` | _not documented_ | Title text of the dialog. |
| `icon` | `string \| undefined` | _not documented_ | Icon to display next to message. |
| `message` | `string \| undefined` | _not documented_ | Message of the confirmation. |
| `style` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the element. |
| `styleClass` | `string \| undefined` | _not documented_ | Class of the element. |
| `maskStyleClass` | `string \| undefined` | _not documented_ | Specify the CSS class(es) for styling the mask element |
| `acceptIcon` | `string \| undefined` | _not documented_ | Icon of the accept button. |
| `acceptLabel` | `string \| undefined` | _not documented_ | Label of the accept button. |
| `closeAriaLabel` | `string \| undefined` | _not documented_ | Defines a string that labels the close button for accessibility. |
| `acceptAriaLabel` | `string \| undefined` | _not documented_ | Defines a string that labels the accept button for accessibility. |
| `acceptVisible` | `boolean` | _not documented_ | Visibility of the accept button. |
| `rejectIcon` | `string \| undefined` | _not documented_ | Icon of the reject button. |
| `rejectLabel` | `string \| undefined` | _not documented_ | Label of the reject button. |
| `rejectAriaLabel` | `string \| undefined` | _not documented_ | Defines a string that labels the reject button for accessibility. |
| `rejectVisible` | `boolean` | _not documented_ | Visibility of the reject button. |
| `acceptButtonStyleClass` | `string \| undefined` | _not documented_ | Style class of the accept button. |
| `rejectButtonStyleClass` | `string \| undefined` | _not documented_ | Style class of the reject button. |
| `closeOnEscape` | `boolean` | _not documented_ | Specifies if pressing escape key should hide the dialog. |
| `dismissableMask` | `boolean \| undefined` | _not documented_ | Specifies if clicking the modal background should hide the dialog. |
| `blockScroll` | `boolean` | _not documented_ | Determines whether scrolling behavior should be blocked within the component. |
| `rtl` | `boolean` | _not documented_ | When enabled dialog is displayed in RTL direction. |
| `closable` | `boolean` | _not documented_ | Adds a close icon to the header to hide the dialog. |
| `appendTo` | `HTMLElement \| ElementRef \| TemplateRef<any> \| 'self' \| 'body' \| null \| undefined \| any` | `'body'` | 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). |
| `key` | `string \| undefined` | _not documented_ | Optional key to match the key of confirm object, necessary to use when component tree has multiple confirm dialogs. |
| `autoZIndex` | `boolean` | _not documented_ | Whether to automatically manage layering. |
| `baseZIndex` | `number` | _not documented_ | Base zIndex value to use in layering. |
| `transitionOptions` | `string` | _not documented_ | Transition options of the animation. |
| `focusTrap` | `boolean` | _not documented_ | When enabled, can only focus on elements inside the confirm dialog. |
| `defaultFocus` | `'accept' \| 'reject' \| 'close' \| 'none'` | _not documented_ | Element to receive the focus when the dialog gets visible. |
| `breakpoints` | `any` | _not documented_ | Object literal to define widths per screen size. |
| `modal` | `boolean` | _not documented_ | Defines if background should be blocked when dialog is displayed. |
| `visible` | `any` | _not documented_ | Current visible state as a boolean. |
| `position` | `'center' \| 'top' \| 'bottom' \| 'left' \| 'right' \| 'topleft' \| 'topright' \| 'bottomleft' \| 'bottomright'` | _not documented_ | Allows getting the position of the component. |
| `draggable` | `boolean` | _not documented_ | Enables dragging to change the position using header. |

| Output | Type | Description |
| --- | --- | --- |
| `onHide` | `EventEmitter<ConfirmEventType>` | Callback to invoke when dialog is hidden. |

# datepicker

```ts
import { … } from '@anguless/angulux/datepicker';
```

## DatePicker

`agl-datePicker, agl-datepicker, agl-date-picker` — component

DatePicker is a form component to work with dates.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `iconDisplay` | `'input' \| 'button'` | _not documented_ |  |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `inputStyle` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the input field. |
| `inputId` | `string \| undefined` | _not documented_ | Identifier of the focus input to match a label defined for the component. |
| `inputStyleClass` | `string \| undefined` | _not documented_ | Style class of the input field. |
| `placeholder` | `string \| undefined` | _not documented_ | Placeholder text for the input. |
| `ariaLabelledBy` | `string \| undefined` | _not documented_ | Establishes relationships between the component and label(s) where its value should be one or more element IDs. |
| `ariaLabel` | `string \| undefined` | _not documented_ | Defines a string that labels the input for accessibility. |
| `iconAriaLabel` | `string \| undefined` | _not documented_ | Defines a string that labels the icon button for accessibility. |
| `dateFormat` | `string \| undefined` | _not documented_ | Format of the date which can also be defined at locale settings. |
| `multipleSeparator` | `string` | _not documented_ | Separator for multiple selection mode. |
| `rangeSeparator` | `string` | _not documented_ | Separator for joining start and end dates on range selection mode. |
| `inline` | `boolean` | _not documented_ | When enabled, displays the datepicker as inline. Default is false for popup mode. |
| `showOtherMonths` | `boolean` | _not documented_ | Whether to display dates in other months (non-selectable) at the start or end of the current month. To make these days selectable use the selectOtherMonths option. |
| `selectOtherMonths` | `boolean \| undefined` | _not documented_ | Whether days in other months shown before or after the current month are selectable. This only applies if the showOtherMonths option is set to true. |
| `showIcon` | `boolean \| undefined` | _not documented_ | When enabled, displays a button with icon next to input. |
| `icon` | `string \| undefined` | _not documented_ | Icon of the datepicker button. |
| `readonlyInput` | `boolean \| undefined` | _not documented_ | When specified, prevents entering the date manually with keyboard. |
| `shortYearCutoff` | `any` | _not documented_ | The cutoff year for determining the century for a date. |
| `hourFormat` | `string` | _not documented_ | Specifies 12 or 24 hour format. |
| `timeOnly` | `boolean \| undefined` | _not documented_ | Whether to display timepicker only. |
| `stepHour` | `number` | _not documented_ | Hours to change per step. |
| `stepMinute` | `number` | _not documented_ | Minutes to change per step. |
| `stepSecond` | `number` | _not documented_ | Seconds to change per step. |
| `showSeconds` | `boolean` | _not documented_ | Whether to show the seconds in time picker. |
| `showOnFocus` | `boolean` | _not documented_ | When disabled, datepicker will not be visible with input focus. |
| `showWeek` | `boolean` | _not documented_ | When enabled, datepicker will show week numbers. |
| `startWeekFromFirstDayOfYear` | `boolean` | _not documented_ | When enabled, datepicker will start week numbers from first day of the year. |
| `showClear` | `boolean` | _not documented_ | When enabled, a clear icon is displayed to clear the value. |
| `dataType` | `string` | _not documented_ | Type of the value to write back to ngModel, default is date and alternative is string. |
| `selectionMode` | `'single' \| 'multiple' \| 'range' \| undefined` | _not documented_ | Defines the quantity of the selection, valid values are "single", "multiple" and "range". |
| `maxDateCount` | `number \| undefined` | _not documented_ | Maximum number of selectable dates in multiple mode. |
| `showButtonBar` | `boolean \| undefined` | _not documented_ | Whether to display today and clear buttons at the footer |
| `todayButtonStyleClass` | `string \| undefined` | _not documented_ | Style class of the today button. |
| `clearButtonStyleClass` | `string \| undefined` | _not documented_ | Style class of the clear button. |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |
| `autoZIndex` | `boolean` | _not documented_ | Whether to automatically manage layering. |
| `baseZIndex` | `number` | _not documented_ | Base zIndex value to use in layering. |
| `panelStyleClass` | `string \| undefined` | _not documented_ | Style class of the datetimepicker container element. |
| `panelStyle` | `any` | _not documented_ | Inline style of the datetimepicker container element. |
| `keepInvalid` | `boolean` | _not documented_ | Keep invalid value when input blur. |
| `hideOnDateTimeSelect` | `boolean` | _not documented_ | Whether to hide the overlay on date selection. |
| `touchUI` | `boolean \| undefined` | _not documented_ | When enabled, datepicker overlay is displayed as optimized for touch devices. |
| `timeSeparator` | `string` | _not documented_ | Separator of time selector. |
| `focusTrap` | `boolean` | _not documented_ | When enabled, can only focus on elements inside the datepicker. |
| `showTransitionOptions` | `string` | _not documented_ | Transition options of the show animation. **Deprecated:** since v21.0.0, use `motionOptions` instead. |
| `hideTransitionOptions` | `string` | _not documented_ | Transition options of the hide animation. **Deprecated:** since v21.0.0, use `motionOptions` instead. |
| `tabindex` | `number \| undefined` | _not documented_ | Index of the element in tabbing order. |
| `minDate` | `Date \| undefined \| null` | _not documented_ | The minimum selectable date. |
| `maxDate` | `Date \| undefined \| null` | _not documented_ | The maximum selectable date. |
| `disabledDates` | `Date[]` | _not documented_ | Array with dates that should be disabled (not selectable). |
| `disabledDays` | `number[]` | _not documented_ | Array with weekday numbers that should be disabled (not selectable). |
| `showTime` | `boolean` | _not documented_ | Whether to display timepicker. |
| `responsiveOptions` | `DatePickerResponsiveOptions[]` | _not documented_ | An array of options for responsive design. |
| `numberOfMonths` | `number` | _not documented_ | Number of months to display. |
| `firstDayOfWeek` | `number` | _not documented_ | Defines the first of the week for various date calculations. |
| `view` | `DatePickerTypeView` | _not documented_ | Type of view to display, valid values are "date" for datepicker and "month" for month picker. |
| `defaultDate` | `Date \| null` | _not documented_ | Set the date to highlight on first opening if the field is blank. |
| `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 |
| --- | --- | --- |
| `onFocus` | `EventEmitter<Event>` | Callback to invoke on focus of input field. |
| `onBlur` | `EventEmitter<Event>` | Callback to invoke on blur of input field. |
| `onClose` | `EventEmitter<HTMLElement>` | Callback to invoke when date panel closed. |
| `onSelect` | `EventEmitter<Date>` | Callback to invoke on date select. |
| `onClear` | `EventEmitter<any>` | Callback to invoke when input field cleared. |
| `onInput` | `EventEmitter<any>` | Callback to invoke when input field is being typed. |
| `onTodayClick` | `EventEmitter<Date>` | Callback to invoke when today button is clicked. |
| `onClearClick` | `EventEmitter<any>` | Callback to invoke when clear button is clicked. |
| `onMonthChange` | `EventEmitter<DatePickerMonthChangeEvent>` | Callback to invoke when a month is changed using the navigators. |
| `onYearChange` | `EventEmitter<DatePickerYearChangeEvent>` | Callback to invoke when a year is changed using the navigators. |
| `onClickOutside` | `EventEmitter<any>` | Callback to invoke when clicked outside of the date panel. |
| `onShow` | `EventEmitter<HTMLElement>` | Callback to invoke when datepicker panel is shown. |

# dialog

```ts
import { … } from '@anguless/angulux/dialog';
```

## Dialog

`agl-dialog` — component

Dialog is a container to display content in an overlay window.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `hostName` | `string` | _not documented_ |  |
| `header` | `string \| undefined` | _not documented_ | Title text of the dialog. |
| `draggable` | `boolean` | _not documented_ | Enables dragging to change the position using header. |
| `resizable` | `boolean` | _not documented_ | Enables resizing of the content. |
| `contentStyle` | `any` | _not documented_ | Style of the content section. |
| `contentStyleClass` | `string \| undefined` | _not documented_ | Style class of the content. |
| `modal` | `boolean` | _not documented_ | Defines if background should be blocked when dialog is displayed. |
| `closeOnEscape` | `boolean` | _not documented_ | Specifies if pressing escape key should hide the dialog. |
| `dismissableMask` | `boolean` | _not documented_ | Specifies if clicking the modal background should hide the dialog. |
| `rtl` | `boolean` | _not documented_ | When enabled dialog is displayed in RTL direction. |
| `closable` | `boolean` | _not documented_ | Adds a close icon to the header to hide the dialog. |
| `breakpoints` | `any` | _not documented_ | Object literal to define widths per screen size. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. |
| `maskStyleClass` | `string \| undefined` | _not documented_ | Style class of the mask. |
| `maskStyle` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Style of the mask. |
| `showHeader` | `boolean` | _not documented_ | Whether to show the header or not. |
| `blockScroll` | `boolean` | _not documented_ | Whether background scroll should be blocked when dialog is visible. |
| `autoZIndex` | `boolean` | _not documented_ | Whether to automatically manage layering. |
| `baseZIndex` | `number` | _not documented_ | Base zIndex value to use in layering. |
| `minX` | `number` | _not documented_ | Minimum value for the left coordinate of dialog in dragging. |
| `minY` | `number` | _not documented_ | Minimum value for the top coordinate of dialog in dragging. |
| `focusOnShow` | `boolean` | _not documented_ | When enabled, first focusable element receives focus on show. |
| `maximizable` | `boolean` | _not documented_ | Whether the dialog can be displayed full screen. |
| `keepInViewport` | `boolean` | _not documented_ | Keeps dialog in the viewport. |
| `focusTrap` | `boolean` | _not documented_ | When enabled, can only focus on elements inside the dialog. |
| `transitionOptions` | `string` | _not documented_ | Transition options of the animation. **Deprecated:** since v21.0.0. Use `motionOptions` instead. |
| `maskMotionOptions` | `MotionOptions \| undefined` | _not documented_ | The motion options for the mask. |
| `motionOptions` | `MotionOptions \| undefined` | _not documented_ | The motion options. |
| `closeIcon` | `string \| undefined` | _not documented_ | Name of the close icon. |
| `closeAriaLabel` | `string \| undefined` | _not documented_ | Defines a string that labels the close button for accessibility. |
| `closeTabindex` | `string` | _not documented_ | Index of the close button in tabbing order. |
| `minimizeIcon` | `string \| undefined` | _not documented_ | Name of the minimize icon. |
| `maximizeIcon` | `string \| undefined` | _not documented_ | Name of the maximize icon. |
| `closeButtonProps` | `ButtonProps` | _not documented_ | Used to pass all properties of the ButtonProps to the Button component. |
| `maximizeButtonProps` | `ButtonProps` | _not documented_ | Used to pass all properties of the ButtonProps to the Button component. |
| `visible` | `boolean` | _not documented_ | Specifies the visibility of the dialog. |
| `style` | `any` | _not documented_ | Inline style of the component. |
| `position` | `'center' \| 'top' \| 'bottom' \| 'left' \| 'right' \| 'topleft' \| 'topright' \| 'bottomleft' \| 'bottomright'` | _not documented_ | Position of the dialog. |
| `role` | `string` | _not documented_ | Role attribute of html element. |
| `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). |
| `headerTemplate` | `TemplateRef<void> \| undefined` | _not documented_ | Header template. |
| `contentTemplate` | `TemplateRef<void> \| undefined` | _not documented_ | Content template. |
| `footerTemplate` | `TemplateRef<void> \| undefined` | _not documented_ | Footer template. |
| `closeIconTemplate` | `TemplateRef<void> \| undefined` | _not documented_ | Close icon template. |
| `maximizeIconTemplate` | `TemplateRef<void> \| undefined` | _not documented_ | Maximize icon template. |
| `minimizeIconTemplate` | `TemplateRef<void> \| undefined` | _not documented_ | Minimize icon template. |
| `headlessTemplate` | `TemplateRef<void> \| undefined` | _not documented_ | Headless template. |

| Output | Type | Description |
| --- | --- | --- |
| `onShow` | `EventEmitter<any>` | Callback to invoke when dialog is shown. |
| `onHide` | `EventEmitter<any>` | Callback to invoke when dialog is hidden. |
| `visibleChange` | `EventEmitter<boolean>` | This EventEmitter is used to notify changes in the visibility state of a component. |
| `onResizeInit` | `EventEmitter<MouseEvent>` | Callback to invoke when dialog resizing is initiated. |
| `onResizeEnd` | `EventEmitter<MouseEvent>` | Callback to invoke when dialog resizing is completed. |
| `onDragEnd` | `EventEmitter<DragEvent>` | Callback to invoke when dialog dragging is completed. |
| `onMaximize` | `EventEmitter<any>` | Callback to invoke when dialog maximized or unmaximized. |

# divider

```ts
import { … } from '@anguless/angulux/divider';
```

## Divider

`agl-divider` — component

Divider is used to separate contents.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `layout` | `'horizontal' \| 'vertical' \| undefined` | _not documented_ | Specifies the orientation. |
| `type` | `'solid' \| 'dashed' \| 'dotted' \| undefined` | _not documented_ | Border style type. |
| `align` | `'left' \| 'center' \| 'right' \| 'top' \| 'bottom' \| undefined` | _not documented_ | Alignment of the content. |

# dom

```ts
import { … } from '@anguless/angulux/dom';
```

This module declares no component or directive. It is internal infrastructure that other
modules depend on, and there is nothing here to use directly.

# drawer

```ts
import { … } from '@anguless/angulux/drawer';
```

## Drawer

`agl-drawer` — component

Sidebar is a panel component displayed as an overlay at the edges of the screen.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `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. |
| `blockScroll` | `boolean` | _not documented_ | Whether to block scrolling of the document when drawer is active. |
| `style` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the component. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. |
| `ariaCloseLabel` | `string \| undefined` | _not documented_ | Aria label of the close icon. |
| `autoZIndex` | `boolean` | _not documented_ | Whether to automatically manage layering. |
| `baseZIndex` | `number` | _not documented_ | Base zIndex value to use in layering. |
| `modal` | `boolean` | _not documented_ | Whether an overlay mask is displayed behind the drawer. |
| `closeButtonProps` | `ButtonProps` | _not documented_ | Used to pass all properties of the ButtonProps to the Button component. |
| `dismissible` | `boolean` | _not documented_ | Whether to dismiss drawer on click of the mask. |
| `showCloseIcon` | `boolean` | _not documented_ | Whether to display the close icon. **Deprecated:** use 'closable' instead. |
| `closeOnEscape` | `boolean` | _not documented_ | Specifies if pressing escape key should hide the drawer. |
| `transitionOptions` | `string` | _not documented_ | Transition options of the animation. **Deprecated:** since v21.0.0. Use `motionOptions` instead. |
| `visible` | `boolean` | `false` | The visible property is an input that determines the visibility of the component. |
| `position` | `'left' \| 'right' \| 'bottom' \| 'top' \| 'full'` | `'left'` | Specifies the position of the drawer, valid values are "left", "right", "bottom" and "top". |
| `fullScreen` | `boolean` | `false` | Adds a close icon to the header to hide the dialog. |
| `header` | `string \| undefined` | _not documented_ | Title content of the dialog. |
| `maskStyle` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Style of the mask. |
| `closable` | `boolean` | `true` | Whether to display close button. |

| Output | Type | Description |
| --- | --- | --- |
| `onShow` | `EventEmitter<any>` | Callback to invoke when dialog is shown. |
| `onHide` | `EventEmitter<any>` | Callback to invoke when dialog is hidden. |
| `visibleChange` | `EventEmitter<boolean>` | Callback to invoke when dialog visibility is changed. |

# fileupload

```ts
import { … } from '@anguless/angulux/fileupload';
```

## FileContent

`[aglFileContent]` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `files` | `any` | _not documented_ |  |
| `badgeSeverity` | `'secondary' \| 'info' \| 'success' \| 'warn' \| 'danger' \| 'contrast'` | _not documented_ |  |
| `badgeValue` | `string` | _not documented_ |  |
| `previewWidth` | `number` | _not documented_ |  |
| `fileRemoveIconTemplate` | `any` | _not documented_ |  |

| Output | Type | Description |
| --- | --- | --- |
| `onRemove` | `any` |  |

## FileUpload

`agl-fileupload, agl-fileUpload` — component

FileUpload is an advanced uploader with dragdrop support, multi file uploads, auto uploading, progress tracking and validations.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `name` | `string \| undefined` | _not documented_ | Name of the request parameter to identify the files at backend. |
| `url` | `string \| undefined` | _not documented_ | Remote url to upload the files. |
| `method` | `'post' \| 'put' \| undefined` | _not documented_ | HTTP method to send the files to the url such as "post" and "put". |
| `multiple` | `boolean \| undefined` | _not documented_ | Used to select multiple files at once from file dialog. |
| `accept` | `string \| undefined` | _not documented_ | Comma-separated list of pattern to restrict the allowed file types. Can be any combination of either the MIME types (such as "image/*") or the file extensions (such as ".jpg"). |
| `disabled` | `boolean \| undefined` | _not documented_ | Disables the upload functionality. |
| `auto` | `boolean \| undefined` | _not documented_ | When enabled, upload begins automatically after selection is completed. |
| `withCredentials` | `boolean \| undefined` | _not documented_ | Cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates. |
| `maxFileSize` | `number \| undefined` | _not documented_ | Maximum file size allowed in bytes. |
| `invalidFileSizeMessageSummary` | `string` | _not documented_ | Summary message of the invalid file size. |
| `invalidFileSizeMessageDetail` | `string` | _not documented_ | Detail message of the invalid file size. |
| `invalidFileTypeMessageSummary` | `string` | _not documented_ | Summary message of the invalid file type. |
| `invalidFileTypeMessageDetail` | `string` | _not documented_ | Detail message of the invalid file type. |
| `invalidFileLimitMessageDetail` | `string` | _not documented_ | Detail message of the invalid file type. |
| `invalidFileLimitMessageSummary` | `string` | _not documented_ | Summary message of the invalid file type. |
| `style` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the element. |
| `styleClass` | `string \| undefined` | _not documented_ | Class of the element. |
| `previewWidth` | `number` | _not documented_ | Width of the image thumbnail in pixels. |
| `chooseLabel` | `string \| undefined` | _not documented_ | Label of the choose button. Defaults to AnguluxConfig Locale configuration. |
| `uploadLabel` | `string \| undefined` | _not documented_ | Label of the upload button. Defaults to AnguluxConfig Locale configuration. |
| `cancelLabel` | `string \| undefined` | _not documented_ | Label of the cancel button. Defaults to AnguluxConfig Locale configuration. |
| `chooseIcon` | `string \| undefined` | _not documented_ | Icon of the choose button. |
| `uploadIcon` | `string \| undefined` | _not documented_ | Icon of the upload button. |
| `cancelIcon` | `string \| undefined` | _not documented_ | Icon of the cancel button. |
| `showUploadButton` | `boolean` | _not documented_ | Whether to show the upload button. |
| `showCancelButton` | `boolean` | _not documented_ | Whether to show the cancel button. |
| `mode` | `'advanced' \| 'basic' \| undefined` | _not documented_ | Defines the UI of the component. |
| `headers` | `HttpHeaders \| undefined` | _not documented_ | HttpHeaders class represents the header configuration options for an HTTP request. |
| `customUpload` | `boolean \| undefined` | _not documented_ | Whether to use the default upload or a manual implementation defined in uploadHandler callback. Defaults to AnguluxConfig Locale configuration. |
| `fileLimit` | `number \| undefined` | _not documented_ | Maximum number of files that can be uploaded. |
| `uploadStyleClass` | `string \| undefined` | _not documented_ | Style class of the upload button. |
| `cancelStyleClass` | `string \| undefined` | _not documented_ | Style class of the cancel button. |
| `removeStyleClass` | `string \| undefined` | _not documented_ | Style class of the remove button. |
| `chooseStyleClass` | `string \| undefined` | _not documented_ | Style class of the choose button. |
| `chooseButtonProps` | `ButtonProps` | _not documented_ | Used to pass all properties of the ButtonProps to the choose button inside the component. |
| `uploadButtonProps` | `ButtonProps` | _not documented_ | Used to pass all properties of the ButtonProps to the upload button inside the component. |
| `cancelButtonProps` | `ButtonProps` | _not documented_ | Used to pass all properties of the ButtonProps to the cancel button inside the component. |
| `files` | `` | _not documented_ |  |

| Output | Type | Description |
| --- | --- | --- |
| `onBeforeUpload` | `EventEmitter<FileBeforeUploadEvent>` | Callback to invoke before file upload is initialized. |
| `onSend` | `EventEmitter<FileSendEvent>` | An event indicating that the request was sent to the server. Useful when a request may be retried multiple times, to distinguish between retries on the final event stream. |
| `onUpload` | `EventEmitter<FileUploadEvent>` | Callback to invoke when file upload is complete. |
| `onError` | `EventEmitter<FileUploadErrorEvent>` | Callback to invoke if file upload fails. |
| `onClear` | `EventEmitter<Event>` | Callback to invoke when files in queue are removed without uploading using clear all button. |
| `onRemove` | `EventEmitter<FileRemoveEvent>` | Callback to invoke when a file is removed without uploading using clear button of a file. |
| `onSelect` | `EventEmitter<FileSelectEvent>` | Callback to invoke when files are selected. |
| `onProgress` | `EventEmitter<FileProgressEvent>` | Callback to invoke when files are being uploaded. |
| `uploadHandler` | `EventEmitter<FileUploadHandlerEvent>` | Callback to invoke in custom upload mode to upload the files manually. |
| `onImageError` | `EventEmitter<Event>` | This event is triggered if an error occurs while loading an image file. |
| `onRemoveUploadedFile` | `EventEmitter<RemoveUploadedFileEvent>` | This event is triggered if an error occurs while loading an image file. |

# fluid

```ts
import { … } from '@anguless/angulux/fluid';
```

## Fluid

`agl-fluid` — component

Fluid is a layout component to make descendant components span full width of their container.

# focustrap

```ts
import { … } from '@anguless/angulux/focustrap';
```

## FocusTrap

`[aglFocusTrap]` — directive

Focus Trap keeps focus within a certain DOM element while tabbing.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `aglFocusTrapDisabled` | `boolean` | _not documented_ | When set as true, focus wouldn't be managed. |

# iconfield

```ts
import { … } from '@anguless/angulux/iconfield';
```

## IconField

`agl-iconfield, agl-iconField, agl-icon-field` — component

IconField wraps an input and an icon.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `hostName` | `any` | _not documented_ |  |
| `iconPosition` | `'right' \| 'left'` | _not documented_ | Position of the icon. |
| `styleClass` | `string` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |

# icons

```ts
import { … } from '@anguless/angulux/icons';
```

## AngleDoubleDownIcon

`[data-p-icon="angle-double-down"]` — component

## AngleDoubleLeftIcon

`[data-p-icon="angle-double-left"]` — component

## AngleDoubleRightIcon

`[data-p-icon="angle-double-right"]` — component

## AngleDoubleUpIcon

`[data-p-icon="angle-double-up"]` — component

## AngleDownIcon

`[data-p-icon="angle-down"]` — component

## AngleLeftIcon

`[data-p-icon="angle-left"]` — component

## AngleRightIcon

`[data-p-icon="angle-right"]` — component

## AngleUpIcon

`[data-p-icon="angle-up"]` — component

## ArrowDownIcon

`[data-p-icon="arrow-down"]` — component

## ArrowDownLeftIcon

`[data-p-icon="arrow-down-left"]` — component

## ArrowDownRightIcon

`[data-p-icon="arrow-down-right"]` — component

## ArrowLeftIcon

`[data-p-icon="arrow-left"]` — component

## ArrowRightIcon

`[data-p-icon="arrow-right"]` — component

## ArrowUpIcon

`[data-p-icon="arrow-up"]` — component

## BanIcon

`[data-p-icon="ban"]` — component

## BarsIcon

`[data-p-icon="bars"]` — component

## BaseIcon

`` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `spin` | `boolean` | _not documented_ |  |

## BlankIcon

`[data-p-icon="blank"]` — component

## CalendarIcon

`[data-p-icon="calendar"]` — component

## CaretLeftIcon

`[data-p-icon="caret-left"]` — component

## CaretRightIcon

`[data-p-icon="caret-right"]` — component

## CheckIcon

`[data-p-icon="check"]` — component

## ChevronDownIcon

`[data-p-icon="chevron-down"]` — component

## ChevronLeftIcon

`[data-p-icon="chevron-left"]` — component

## ChevronRightIcon

`[data-p-icon="chevron-right"]` — component

## ChevronUpIcon

`[data-p-icon="chevron-up"]` — component

## ExclamationTriangleIcon

`[data-p-icon="exclamation-triangle"]` — component

## EyeIcon

`[data-p-icon="eye"]` — component

## EyeSlashIcon

`[data-p-icon="eyeslash"]` — component

## FilterIcon

`[data-p-icon="filter"]` — component

## FilterFillIcon

`[data-p-icon="filter-fill"]` — component

## FilterSlashIcon

`[data-p-icon="filter-slash"]` — component

## HomeIcon

`[data-p-icon="home"]` — component

## InfoCircleIcon

`[data-p-icon="info-circle"]` — component

## MinusIcon

`[data-p-icon="minus"]` — component

## PencilIcon

`[data-p-icon="pencil"]` — component

## PlusIcon

`[data-p-icon="plus"]` — component

## RefreshIcon

`[data-p-icon="refresh"]` — component

## SearchIcon

`[data-p-icon="search"]` — component

## SearchMinusIcon

`[data-p-icon="search-minus"]` — component

## SearchPlusIcon

`[data-p-icon="search-plus"]` — component

## SortAltIcon

`[data-p-icon="sort-alt"]` — component

## SortAmountDownIcon

`[data-p-icon="sort-amount-down"]` — component

## SortAmountUpAltIcon

`[data-p-icon="sort-amount-up-alt"]` — component

## SpinnerIcon

`[data-p-icon="spinner"]` — component

## StarIcon

`[data-p-icon="star"]` — component

## StarFillIcon

`[data-p-icon="star-fill"]` — component

## ThLargeIcon

`[data-p-icon="th-large"]` — component

## TimesIcon

`[data-p-icon="times"]` — component

## TimesCircleIcon

`[data-p-icon="times-circle"]` — component

## TrashIcon

`[data-p-icon="trash"]` — component

## UndoIcon

`[data-p-icon="undo"]` — component

## UploadIcon

`[data-p-icon="upload"]` — component

## WindowMaximizeIcon

`[data-p-icon="window-maximize"]` — component

## WindowMinimizeIcon

`[data-p-icon="window-minimize"]` — component

# inputicon

```ts
import { … } from '@anguless/angulux/inputicon';
```

## InputIcon

`agl-inputicon, agl-inputIcon` — component

InputIcon displays an icon.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `hostName` | `any` | _not documented_ |  |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the element. **Deprecated:** since v20.0.0, use `class` instead. |

# inputnumber

```ts
import { … } from '@anguless/angulux/inputnumber';
```

## InputNumber

`agl-inputNumber, agl-inputnumber, agl-input-number` — component

InputNumber is an input component to provide numerical input.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `showButtons` | `boolean` | _not documented_ | Displays spinner buttons. |
| `format` | `boolean` | _not documented_ | Whether to format the value. |
| `buttonLayout` | `string` | _not documented_ | Layout of the buttons, valid values are "stacked" (default), "horizontal" and "vertical". |
| `inputId` | `string \| undefined` | _not documented_ | Identifier of the focus input to match a label defined for the component. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `placeholder` | `string \| undefined` | _not documented_ | Advisory information to display on input. |
| `tabindex` | `number \| undefined` | _not documented_ | Specifies tab order of the element. |
| `title` | `string \| undefined` | _not documented_ | Title text of the input text. |
| `ariaLabelledBy` | `string \| undefined` | _not documented_ | Specifies one or more IDs in the DOM that labels the input field. |
| `ariaDescribedBy` | `string \| undefined` | _not documented_ | Specifies one or more IDs in the DOM that describes the input field. |
| `ariaLabel` | `string \| undefined` | _not documented_ | Used to define a string that labels the input element. |
| `ariaRequired` | `boolean \| undefined` | _not documented_ | Used to indicate that user input is required on an element before a form can be submitted. |
| `autocomplete` | `string \| undefined` | _not documented_ | Used to define a string that autocomplete attribute the current element. |
| `incrementButtonClass` | `string \| undefined` | _not documented_ | Style class of the increment button. |
| `decrementButtonClass` | `string \| undefined` | _not documented_ | Style class of the decrement button. |
| `incrementButtonIcon` | `string \| undefined` | _not documented_ | Style class of the increment button. |
| `decrementButtonIcon` | `string \| undefined` | _not documented_ | Style class of the decrement button. |
| `readonly` | `boolean \| undefined` | _not documented_ | When present, it specifies that an input field is read-only. |
| `allowEmpty` | `boolean` | _not documented_ | Determines whether the input field is empty. |
| `locale` | `string \| undefined` | _not documented_ | Locale to be used in formatting. |
| `localeMatcher` | `any` | _not documented_ | The locale matching algorithm to use. Possible values are "lookup" and "best fit"; the default is "best fit". See Locale Negotiation for details. |
| `mode` | `string \| any` | _not documented_ | Defines the behavior of the component, valid values are "decimal" and "currency". |
| `currency` | `string \| undefined` | _not documented_ | The currency to use in currency formatting. Possible values are the ISO 4217 currency codes, such as "USD" for the US dollar, "EUR" for the euro, or "CNY" for the Chinese RMB. There is no default value; if the style is "currency", the currency property must be provided. |
| `currencyDisplay` | `string \| undefined \| any` | _not documented_ | How to display the currency in currency formatting. Possible values are "symbol" to use a localized currency symbol such as €, ü"code" to use the ISO currency code, "name" to use a localized currency name such as "dollar"; the default is "symbol". |
| `useGrouping` | `boolean` | _not documented_ | Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators. |
| `minFractionDigits` | `number \| undefined` | _not documented_ | The minimum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number and percent formatting is 0; the default for currency formatting is the number of minor unit digits provided by the ISO 4217 currency code list (2 if the list doesn't provide that information). |
| `maxFractionDigits` | `number \| undefined` | _not documented_ | The maximum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number formatting is the larger of minimumFractionDigits and 3; the default for currency formatting is the larger of minimumFractionDigits and the number of minor unit digits provided by the ISO 4217 currency code list (2 if the list doesn't provide that information). |
| `prefix` | `string \| undefined` | _not documented_ | Text to display before the value. |
| `suffix` | `string \| undefined` | _not documented_ | Text to display after the value. |
| `inputStyle` | `any` | _not documented_ | Inline style of the input field. |
| `inputStyleClass` | `string \| undefined` | _not documented_ | Style class of the input field. |
| `showClear` | `boolean` | _not documented_ | When enabled, a clear icon is displayed to clear the value. |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |

| Output | Type | Description |
| --- | --- | --- |
| `onInput` | `EventEmitter<InputNumberInputEvent>` | Callback to invoke on input. |
| `onFocus` | `EventEmitter<Event>` | Callback to invoke when the component receives focus. |
| `onBlur` | `EventEmitter<Event>` | Callback to invoke when the component loses focus. |
| `onKeyDown` | `EventEmitter<KeyboardEvent>` | Callback to invoke on input key press. |
| `onClear` | `EventEmitter<void>` | Callback to invoke when clear token is clicked. |

# inputtext

```ts
import { … } from '@anguless/angulux/inputtext';
```

## InputText

`[aglInputText]` — directive

InputText directive is an extension to standard input element with theming.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `hostName` | `any` | _not documented_ |  |
| `ptInputText` | `InputTextPassThrough` | `undefined` | Used to pass attributes to DOM elements inside the InputText component. **Deprecated:** use pInputTextPT instead. |
| `pInputTextPT` | `InputTextPassThrough` | `undefined` | Used to pass attributes to DOM elements inside the InputText component. |
| `pInputTextUnstyled` | `boolean \| undefined` | `undefined` | Indicates whether the component should be rendered without styles. |
| `aglSize` | `'large' \| 'small' \| undefined` | _not documented_ | Defines the size of the component. |
| `variant` | `'filled' \| 'outlined' \| undefined` | `undefined` | Specifies the input variant of the component. |
| `fluid` | `` | `undefined` | Spans 100% width of the container when enabled. |
| `invalid` | `` | `false` | When present, it specifies that the component should have invalid state style. |

# menu

```ts
import { … } from '@anguless/angulux/menu';
```

## MenuItemContent

`[aglMenuItemContent]` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `item` | `MenuItem \| undefined` | _not documented_ |  |
| `itemTemplate` | `any \| undefined` | _not documented_ |  |
| `menuitemId` | `string` | _not documented_ |  |
| `idx` | `number` | _not documented_ |  |

| Output | Type | Description |
| --- | --- | --- |
| `onMenuItemClick` | `EventEmitter<any>` |  |

## Menu

`agl-menu` — component

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` | `string` | _not documented_ | Transition options of the show animation. **Deprecated:** since v21.0.0, use `motionOptions` instead. |
| `hideTransitionOptions` | `string` | _not documented_ | Transition options of the hide animation. **Deprecated:** since v21.0.0, use `motionOptions` instead. |
| `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. |

# message

```ts
import { … } from '@anguless/angulux/message';
```

## Message

`agl-message` — component

Message groups a collection of contents in tabs.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `severity` | `'success' \| 'info' \| 'warn' \| 'error' \| 'secondary' \| 'contrast' \| undefined \| null` | `'info'` | Severity level of the message. |
| `text` | `string \| undefined` | _not documented_ | Text content. **Deprecated:** since v20.0.0. Use content projection instead '<agl-message>Content</agl-message>'. |
| `escape` | `boolean` | _not documented_ | Whether displaying messages would be escaped or not. **Deprecated:** since v20.0.0. Use content projection instead '<agl-message>Content</agl-message>'. |
| `style` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the component. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. |
| `closable` | `boolean` | `false` | Whether the message can be closed manually using the close icon. |
| `icon` | `string \| undefined` | `undefined` | Icon to display in the message. |
| `closeIcon` | `string \| undefined` | `undefined` | Icon to display in the message close button. |
| `life` | `number \| undefined` | `undefined` | Delay in milliseconds to close the message automatically. |
| `showTransitionOptions` | `string` | `'300ms ease-out'` | Transition options of the show animation. **Deprecated:** since v21.0.0, use `motionOptions` instead. |
| `hideTransitionOptions` | `string` | `'200ms cubic-bezier(0.86, 0, 0.07, 1)'` | Transition options of the hide animation. **Deprecated:** since v21.0.0, use `motionOptions` instead. |
| `size` | `'large' \| 'small' \| undefined` | _not documented_ | Defines the size of the component. |
| `variant` | `'outlined' \| 'text' \| 'simple' \| undefined` | _not documented_ | Specifies the input variant of the component. |
| `motionOptions` | `MotionOptions \| undefined` | _not documented_ | The motion options. |

| Output | Type | Description |
| --- | --- | --- |
| `onClose` | `EventEmitter<{ originalEvent: Event }>` | Emits when the message is closed. |

# motion

```ts
import { … } from '@anguless/angulux/motion';
```

## Motion

`agl-motion` — component

Motion component is a container to apply motion effects to its content.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `visible` | `boolean` | _not documented_ | Whether the element is visible or not. |
| `mountOnEnter` | `boolean` | _not documented_ | Whether to mount the element on enter. |
| `unmountOnLeave` | `boolean` | _not documented_ | Whether to unmount the element on leave. |
| `name` | `MotionOptions['name']` | _not documented_ | The name of the motion. It can be a predefined motion name or a custom one. phases:     [name]-enter     [name]-enter-active     [name]-enter-to     [name]-leave     [name]-leave-active     [name]-leave-to |
| `type` | `MotionOptions['type']` | _not documented_ | The type of the motion, valid values 'transition' and 'animation'. |
| `safe` | `MotionOptions['safe']` | _not documented_ | Whether the motion is safe. |
| `disabled` | `MotionOptions['disabled']` | _not documented_ | Whether the motion is disabled. |
| `appear` | `MotionOptions['appear']` | _not documented_ | Whether the motion should appear. |
| `enter` | `MotionOptions['enter']` | _not documented_ | Whether the motion should enter. |
| `leave` | `MotionOptions['leave']` | _not documented_ | Whether the motion should leave. |
| `duration` | `MotionOptions['duration']` | _not documented_ | The duration of the motion. |
| `hideStrategy` | `'display' \| 'visibility'` | _not documented_ | The hide strategy of the motion, valid values 'display' and 'visibility'. |
| `enterFromClass` | `ClassNameOptions['from']` | _not documented_ | The enter from class of the motion. |
| `enterToClass` | `ClassNameOptions['to']` | _not documented_ | The enter to class of the motion. |
| `enterActiveClass` | `ClassNameOptions['active']` | _not documented_ | The enter active class of the motion. |
| `leaveFromClass` | `ClassNameOptions['from']` | _not documented_ | The leave from class of the motion. |
| `leaveToClass` | `ClassNameOptions['to']` | _not documented_ | The leave to class of the motion. |
| `leaveActiveClass` | `ClassNameOptions['active']` | _not documented_ | The leave active class of the motion. |
| `options` | `MotionOptions` | _not documented_ | The motion options. |

| Output | Type | Description |
| --- | --- | --- |
| `onBeforeEnter` | `MotionEvent \| undefined` | Callback fired before the enter transition/animation starts. |
| `onEnter` | `MotionEvent \| undefined` | Callback fired when the enter transition/animation starts. |
| `onAfterEnter` | `MotionEvent \| undefined` | Callback fired after the enter transition/animation ends. |
| `onEnterCancelled` | `MotionEvent \| undefined` | Callback fired when the enter transition/animation is cancelled. |
| `onBeforeLeave` | `MotionEvent \| undefined` | Callback fired before the leave transition/animation starts. |
| `onLeave` | `MotionEvent \| undefined` | Callback fired when the leave transition/animation starts. |
| `onAfterLeave` | `MotionEvent \| undefined` | Callback fired after the leave transition/animation ends. |
| `onLeaveCancelled` | `MotionEvent \| undefined` | Callback fired when the leave transition/animation is cancelled. |

## MotionDirective

`[aglMotion]` — directive

Motion Directive is directive to apply motion effects to elements.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `visible` | `boolean` | _not documented_ | Whether the element is visible or not. |
| `name` | `MotionOptions['name']` | _not documented_ | The name of the motion. It can be a predefined motion name or a custom one. phases:     [name]-enter     [name]-enter-active     [name]-enter-to     [name]-leave     [name]-leave-active     [name]-leave-to |
| `type` | `MotionOptions['type']` | _not documented_ | The type of the motion, valid values 'transition' and 'animation'. |
| `safe` | `MotionOptions['safe']` | _not documented_ | Whether the motion is safe. |
| `disabled` | `MotionOptions['disabled']` | _not documented_ | Whether the motion is disabled. |
| `appear` | `MotionOptions['appear']` | _not documented_ | Whether the motion should appear. |
| `enter` | `MotionOptions['enter']` | _not documented_ | Whether the motion should enter. |
| `leave` | `MotionOptions['leave']` | _not documented_ | Whether the motion should leave. |
| `duration` | `MotionOptions['duration']` | _not documented_ | The duration of the motion. |
| `hideStrategy` | `'display' \| 'visibility'` | _not documented_ | The hide strategy of the motion, valid values 'display' and 'visibility'. |
| `enterFromClass` | `ClassNameOptions['from']` | _not documented_ | The enter from class of the motion. |
| `enterToClass` | `ClassNameOptions['to']` | _not documented_ | The enter to class of the motion. |
| `enterActiveClass` | `ClassNameOptions['active']` | _not documented_ | The enter active class of the motion. |
| `leaveFromClass` | `ClassNameOptions['from']` | _not documented_ | The leave from class of the motion. |
| `leaveToClass` | `ClassNameOptions['to']` | _not documented_ | The leave to class of the motion. |
| `leaveActiveClass` | `ClassNameOptions['active']` | _not documented_ | The leave active class of the motion. |
| `options` | `MotionOptions` | _not documented_ | The motion options. |

| Output | Type | Description |
| --- | --- | --- |
| `onBeforeEnter` | `MotionEvent \| undefined` | Callback fired before the enter transition/animation starts. |
| `onEnter` | `MotionEvent \| undefined` | Callback fired when the enter transition/animation starts. |
| `onAfterEnter` | `MotionEvent \| undefined` | Callback fired after the enter transition/animation ends. |
| `onEnterCancelled` | `MotionEvent \| undefined` | Callback fired when the enter transition/animation is cancelled. |
| `onBeforeLeave` | `MotionEvent \| undefined` | Callback fired before the leave transition/animation starts. |
| `onLeave` | `MotionEvent \| undefined` | Callback fired when the leave transition/animation starts. |
| `onAfterLeave` | `MotionEvent \| undefined` | Callback fired after the leave transition/animation ends. |
| `onLeaveCancelled` | `MotionEvent \| undefined` | Callback fired when the leave transition/animation is cancelled. |

# multiselect

```ts
import { … } from '@anguless/angulux/multiselect';
```

## MultiSelectItem

`li[aglMultiSelectItem]` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `option` | `any` | _not documented_ |  |
| `selected` | `boolean \| undefined` | _not documented_ |  |
| `label` | `string \| undefined` | _not documented_ |  |
| `disabled` | `boolean \| undefined` | _not documented_ |  |
| `itemSize` | `number \| undefined` | _not documented_ |  |
| `focused` | `boolean \| undefined` | _not documented_ |  |
| `ariaPosInset` | `string \| undefined` | _not documented_ |  |
| `ariaSetSize` | `string \| undefined` | _not documented_ |  |
| `variant` | `'outlined' \| 'filled'` | _not documented_ |  |
| `template` | `TemplateRef<MultiSelectItemTemplateContext> \| undefined` | _not documented_ |  |
| `checkIconTemplate` | `TemplateRef<MultiSelectItemCheckboxIconTemplateContext> \| undefined` | _not documented_ |  |
| `itemCheckboxIconTemplate` | `TemplateRef<MultiSelectItemCheckboxIconTemplateContext> \| undefined` | _not documented_ |  |
| `highlightOnSelect` | `boolean \| undefined` | _not documented_ |  |

| Output | Type | Description |
| --- | --- | --- |
| `onClick` | `EventEmitter<any>` |  |
| `onMouseEnter` | `EventEmitter<any>` |  |

## MultiSelect

`agl-multiSelect, agl-multiselect, agl-multi-select` — component

MultiSelect is used to select multiple items from a collection.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `id` | `string \| undefined` | _not documented_ | Unique identifier of the component |
| `ariaLabel` | `string \| undefined` | _not documented_ | Defines a string that labels the input for accessibility. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the element. **Deprecated:** since v20.0.0, use `class` instead. |
| `panelStyle` | `any` | _not documented_ | Inline style of the overlay panel. |
| `panelStyleClass` | `string \| undefined` | _not documented_ | Style class of the overlay panel element. |
| `inputId` | `string \| undefined` | _not documented_ | Identifier of the focus input to match a label defined for the component. |
| `readonly` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component cannot be edited. |
| `group` | `boolean \| undefined` | _not documented_ | Whether to display options as grouped when nested options are provided. |
| `filter` | `boolean` | _not documented_ | When specified, displays an input field to filter the items on keyup. |
| `filterPlaceHolder` | `string \| undefined` | _not documented_ | Defines placeholder of the filter input. |
| `filterLocale` | `string \| undefined` | _not documented_ | Locale to use in filtering. The default locale is the host environment's current locale. |
| `overlayVisible` | `boolean \| undefined` | _not documented_ | Specifies the visibility of the options panel. |
| `tabindex` | `number \| undefined` | _not documented_ | Index of the element in tabbing order. |
| `dataKey` | `string \| undefined` | _not documented_ | A property to uniquely identify a value in options. |
| `ariaLabelledBy` | `string \| undefined` | _not documented_ | Establishes relationships between the component and label(s) where its value should be one or more element IDs. |
| `displaySelectedLabel` | `` | `true` | Whether to show labels of selected item labels or use default label. |
| `maxSelectedLabels` | `` | `3` | Decides how many selected item labels to show at most. |
| `selectionLimit` | `number \| undefined` | _not documented_ | Maximum number of selectable items. |
| `selectedItemsLabel` | `string \| undefined` | _not documented_ | Label to display after exceeding max selected labels e.g. ({0} items selected), defaults "ellipsis" keyword to indicate a text-overflow. |
| `showToggleAll` | `boolean` | _not documented_ | Whether to show the checkbox at header to toggle all items at once. |
| `emptyFilterMessage` | `string` | _not documented_ | Text to display when filtering does not return any results. |
| `emptyMessage` | `string` | _not documented_ | Text to display when there is no data. Defaults to global value in i18n translation configuration. |
| `resetFilterOnHide` | `boolean` | _not documented_ | Clears the filter value when hiding the dropdown. |
| `dropdownIcon` | `string \| undefined` | _not documented_ | Icon class of the dropdown icon. |
| `chipIcon` | `string \| undefined` | _not documented_ | Icon class of the chip icon. |
| `optionLabel` | `string \| undefined` | _not documented_ | Name of the label field of an option. |
| `optionValue` | `string \| undefined` | _not documented_ | Name of the value field of an option. |
| `optionDisabled` | `string \| undefined` | _not documented_ | Name of the disabled field of an option. |
| `optionGroupLabel` | `string \| undefined` | _not documented_ | Name of the label field of an option group. |
| `optionGroupChildren` | `string` | _not documented_ | Name of the options field of an option group. |
| `showHeader` | `boolean` | _not documented_ | Whether to show the header. |
| `filterBy` | `string \| undefined` | _not documented_ | When filtering is enabled, filterBy decides which field or fields (comma separated) to search against. |
| `scrollHeight` | `string` | _not documented_ | Height of the viewport in pixels, a scrollbar is defined if height of list exceeds this value. |
| `lazy` | `boolean` | _not documented_ | Defines if data is loaded and interacted with in lazy manner. |
| `virtualScroll` | `boolean \| undefined` | _not documented_ | Whether the data should be loaded on demand during scroll. |
| `loading` | `boolean \| undefined` | _not documented_ | Whether the multiselect is in loading state. |
| `virtualScrollItemSize` | `number \| undefined` | _not documented_ | Height of an item in the list for VirtualScrolling. |
| `loadingIcon` | `string \| undefined` | _not documented_ | Icon to display in loading state. |
| `virtualScrollOptions` | `ScrollerOptions \| undefined` | _not documented_ | Whether to use the scroller feature. The properties of scroller component can be used like an object in it. |
| `overlayOptions` | `OverlayOptions \| undefined` | _not documented_ | Whether to use overlay API feature. The properties of overlay API can be used like an object in it. |
| `ariaFilterLabel` | `string \| undefined` | _not documented_ | Defines a string that labels the filter input. |
| `filterMatchMode` | `'contains' \| 'startsWith' \| 'endsWith' \| 'equals' \| 'notEquals' \| 'in' \| 'lt' \| 'lte' \| 'gt' \| 'gte'` | _not documented_ | Defines how the items are filtered. |
| `tooltip` | `string` | _not documented_ | Advisory information to display in a tooltip on hover. |
| `tooltipPosition` | `'top' \| 'left' \| 'right' \| 'bottom'` | _not documented_ | Position of the tooltip. |
| `tooltipPositionStyle` | `string` | _not documented_ | Type of CSS position. |
| `tooltipStyleClass` | `string \| undefined` | _not documented_ | Style class of the tooltip. |
| `autofocusFilter` | `boolean` | _not documented_ | Applies focus to the filter element when the overlay is shown. |
| `display` | `string \| 'comma' \| 'chip'` | _not documented_ | Defines how the selected items are displayed. |
| `autocomplete` | `string` | _not documented_ | Defines the autocomplete is active. |
| `showClear` | `boolean` | _not documented_ | When enabled, a clear icon is displayed to clear the value. |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |
| `placeholder` | `` | _not documented_ | Label to display when there are no selections. |
| `options` | `any[] \| undefined` | _not documented_ | An array of objects to display as the available options. |
| `filterValue` | `string \| undefined \| null` | _not documented_ | When specified, filter displays with this value. |
| `selectAll` | `boolean \| undefined \| null` | _not documented_ | Whether all data is selected. |
| `focusOnHover` | `boolean` | _not documented_ | Indicates whether to focus on options when hovering over them, defaults to optionLabel. |
| `filterFields` | `any[] \| undefined` | _not documented_ | Fields used when filtering the options, defaults to optionLabel. |
| `selectOnFocus` | `boolean` | _not documented_ | Determines if the option will be selected on focus. |
| `autoOptionFocus` | `boolean` | _not documented_ | Whether to focus on the first visible or selected element when the overlay panel is shown. |
| `highlightOnSelect` | `boolean` | _not documented_ | Whether the selected option will be add highlight class. |
| `size` | `'large' \| 'small' \| undefined` | `undefined` | Specifies the size of the component. |
| `variant` | `'filled' \| 'outlined' \| undefined` | `undefined` | Specifies the input variant of the component. |
| `fluid` | `` | `undefined` | Spans 100% width of the container when enabled. |
| `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 |
| --- | --- | --- |
| `onChange` | `EventEmitter<MultiSelectChangeEvent>` | Callback to invoke when value changes. |
| `onFilter` | `EventEmitter<MultiSelectFilterEvent>` | Callback to invoke when data is filtered. |
| `onFocus` | `EventEmitter<MultiSelectFocusEvent>` | Callback to invoke when multiselect receives focus. |
| `onBlur` | `EventEmitter<MultiSelectBlurEvent>` | Callback to invoke when multiselect loses focus. |
| `onClick` | `EventEmitter<Event>` | Callback to invoke when component is clicked. |
| `onClear` | `EventEmitter<void>` | Callback to invoke when input field is cleared. |
| `onPanelShow` | `EventEmitter<AnimationEvent>` | Callback to invoke when overlay panel becomes visible. |
| `onPanelHide` | `EventEmitter<AnimationEvent>` | Callback to invoke when overlay panel becomes hidden. |
| `onLazyLoad` | `EventEmitter<MultiSelectLazyLoadEvent>` | Callback to invoke in lazy mode to load new data. |
| `onRemove` | `EventEmitter<MultiSelectRemoveEvent>` | Callback to invoke in lazy mode to load new data. |
| `onSelectAllChange` | `EventEmitter<MultiSelectSelectAllChangeEvent>` | Callback to invoke when all data is selected. |

# overlay

```ts
import { … } from '@anguless/angulux/overlay';
```

## Overlay

`agl-overlay` — component

This API allows overlay components to be controlled from the AnguluxConfig. In this way, all overlay components in the application can have the same behavior.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `hostName` | `string` | _not documented_ |  |
| `visible` | `boolean` | `false` | The visible property is an input that determines the visibility of the component. |
| `mode` | `OverlayModeType \| string` | `null` | The mode property is an input that determines the overlay mode type or string. |
| `style` | `{ [klass: string]: any } \| null \| undefined` | `null` | The style property is an input that determines the style object for the component. |
| `styleClass` | `string` | `null` | The styleClass property is an input that determines the CSS class(es) for the component. |
| `contentStyle` | `{ [klass: string]: any } \| null \| undefined` | `null` | The contentStyle property is an input that determines the style object for the content of the component. |
| `contentStyleClass` | `string` | `null` | The contentStyleClass property is an input that determines the CSS class(es) for the content of the component. |
| `target` | `string \| null \| undefined` | `null` | The target property is an input that specifies the target element or selector for the component. |
| `autoZIndex` | `boolean` | `false` | The autoZIndex determines whether to automatically manage layering. Its default value is 'false'. |
| `baseZIndex` | `number` | `null` | The baseZIndex is base zIndex value to use in layering. |
| `showTransitionOptions` | `string` | `.12s cubic-bezier(0, 0, 0.2, 1)` | Transition options of the show or hide animation. **Deprecated:** since v21.0.0. Use `motionOptions` instead. |
| `hideTransitionOptions` | `string` | `.1s linear` | The hideTransitionOptions property is an input that determines the CSS transition options for hiding the component. **Deprecated:** since v21.0.0. Use `motionOptions` instead. |
| `listener` | `any` | `null` | The listener property is an input that specifies the listener object for the component. |
| `responsive` | `ResponsiveOverlayOptions \| undefined` | `null` | It is the option used to determine in which mode it should appear according to the given media or breakpoint. |
| `options` | `OverlayOptions \| undefined` | `null` | The options property is an input that specifies the overlay options for 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). |
| `inline` | `boolean` | `false` | Specifies whether the overlay should be rendered inline within the current component's template. |
| `motionOptions` | `MotionOptions \| undefined` | _not documented_ | The motion options. |
| `hostAttrSelector` | `string` | _not documented_ |  |

| Output | Type | Description |
| --- | --- | --- |
| `visibleChange` | `EventEmitter<boolean>` | This EventEmitter is used to notify changes in the visibility state of a component. |
| `onBeforeShow` | `EventEmitter<OverlayOnBeforeShowEvent>` | Callback to invoke before the overlay is shown. |
| `onShow` | `EventEmitter<OverlayOnShowEvent>` | Callback to invoke when the overlay is shown. |
| `onBeforeHide` | `EventEmitter<OverlayOnBeforeHideEvent>` | Callback to invoke before the overlay is hidden. |
| `onHide` | `EventEmitter<OverlayOnHideEvent>` | Callback to invoke when the overlay is hidden |
| `onAnimationStart` | `EventEmitter<AnimationEvent>` | Callback to invoke when the animation is started. |
| `onAnimationDone` | `EventEmitter<AnimationEvent>` | Callback to invoke when the animation is done. |
| `onBeforeEnter` | `EventEmitter<MotionEvent>` | Callback to invoke before the overlay enters. |
| `onEnter` | `EventEmitter<MotionEvent>` | Callback to invoke when the overlay enters. |
| `onAfterEnter` | `EventEmitter<MotionEvent>` | Callback to invoke after the overlay has entered. |
| `onBeforeLeave` | `EventEmitter<MotionEvent>` | Callback to invoke before the overlay leaves. |
| `onLeave` | `EventEmitter<MotionEvent>` | Callback to invoke when the overlay leaves. |
| `onAfterLeave` | `EventEmitter<MotionEvent>` | Callback to invoke after the overlay has left. |

# paginator

```ts
import { … } from '@anguless/angulux/paginator';
```

## Paginator

`agl-paginator` — component

Paginator is a generic component to display content in paged format.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `pageLinkSize` | `number` | _not documented_ | Number of page links to display. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `alwaysShow` | `boolean` | _not documented_ | Whether to show it even there is only one page. |
| `dropdownAppendTo` | `HTMLElement \| ElementRef \| TemplateRef<any> \| string \| null \| undefined \| any` | _not documented_ | Target element to attach the dropdown 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). **Deprecated:** since v20.0.0. Use `appendTo` instead. |
| `templateLeft` | `TemplateRef<PaginatorTemplateContext> \| undefined` | _not documented_ | Template instance to inject into the left side of the paginator. |
| `templateRight` | `TemplateRef<PaginatorTemplateContext> \| undefined` | _not documented_ | Template instance to inject into the right side of the paginator. |
| `dropdownScrollHeight` | `string` | _not documented_ | Dropdown height of the viewport in pixels, a scrollbar is defined if height of list exceeds this value. |
| `currentPageReportTemplate` | `string` | _not documented_ | Template of the current page report element. Available placeholders are {currentPage},{totalPages},{rows},{first},{last} and {totalRecords} |
| `showCurrentPageReport` | `boolean \| undefined` | _not documented_ | Whether to display current page report. |
| `showFirstLastIcon` | `boolean` | _not documented_ | When enabled, icons are displayed on paginator to go first and last page. |
| `totalRecords` | `number` | _not documented_ | Number of total records. |
| `rows` | `number` | _not documented_ | Data count to display per page. |
| `rowsPerPageOptions` | `any[] \| undefined` | _not documented_ | Array of integer/object values to display inside rows per page dropdown. A object that have 'showAll' key can be added to it to show all data. Exp; [10,20,30,{showAll:'All'}] |
| `showJumpToPageDropdown` | `boolean \| undefined` | _not documented_ | Whether to display a dropdown to navigate to any page. |
| `showJumpToPageInput` | `boolean \| undefined` | _not documented_ | Whether to display a input to navigate to any page. |
| `jumpToPageItemTemplate` | `TemplateRef<PaginatorDropdownItemTemplateContext> \| undefined` | _not documented_ | Template instance to inject into the jump to page dropdown item inside in the paginator. |
| `showPageLinks` | `boolean` | _not documented_ | Whether to show page links. |
| `locale` | `string \| undefined` | _not documented_ | Locale to be used in formatting. |
| `dropdownItemTemplate` | `TemplateRef<PaginatorDropdownItemTemplateContext> \| undefined` | _not documented_ | Template instance to inject into the rows per page dropdown item inside in the paginator. |
| `first` | `number` | _not documented_ | Zero-relative number of the first row to be displayed. |
| `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). |

| Output | Type | Description |
| --- | --- | --- |
| `onPageChange` | `EventEmitter<PaginatorState>` | Callback to invoke when page changes, the event object contains information about the new state. |

# password

```ts
import { … } from '@anguless/angulux/password';
```

## PasswordDirective

`[aglPassword]` — directive

Password directive.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `pPasswordPT` | `PasswordPassThrough \| undefined` | `undefined` | Used to pass attributes to DOM elements inside the Password component. |
| `pPasswordUnstyled` | `boolean \| undefined` | `undefined` | Indicates whether the component should be rendered without styles. |
| `promptLabel` | `string` | _not documented_ | Text to prompt password entry. Defaults to AnguluxConfig I18N API configuration. |
| `weakLabel` | `string` | _not documented_ | Text for a weak password. Defaults to AnguluxConfig I18N API configuration. |
| `mediumLabel` | `string` | _not documented_ | Text for a medium password. Defaults to AnguluxConfig I18N API configuration. |
| `strongLabel` | `string` | _not documented_ | Text for a strong password. Defaults to AnguluxConfig I18N API configuration. |
| `feedback` | `boolean` | _not documented_ | Whether to show the strength indicator or not. |
| `showPassword` | `` | `false` | Sets the visibility of the password field. |
| `variant` | `'filled' \| 'outlined' \| undefined` | `'outlined'` | Specifies the input variant of the component. |
| `fluid` | `` | `false` | Spans 100% width of the container when enabled. |
| `size` | `'large' \| 'small' \| undefined` | `undefined` | Specifies the size of the component. |

## Password

`agl-password` — component

Password displays strength indicator for password fields.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `ariaLabel` | `string \| undefined` | _not documented_ | Defines a string that labels the input for accessibility. |
| `ariaLabelledBy` | `string \| undefined` | _not documented_ | Specifies one or more IDs in the DOM that labels the input field. |
| `label` | `string \| undefined` | _not documented_ | Label of the input for accessibility. |
| `promptLabel` | `string \| undefined` | _not documented_ | Text to prompt password entry. Defaults to AnguluxConfig I18N API configuration. |
| `mediumRegex` | `string` | _not documented_ | Regex value for medium regex. |
| `strongRegex` | `string` | _not documented_ | Regex value for strong regex. |
| `weakLabel` | `string \| undefined` | _not documented_ | Text for a weak password. Defaults to AnguluxConfig I18N API configuration. |
| `mediumLabel` | `string \| undefined` | _not documented_ | Text for a medium password. Defaults to AnguluxConfig I18N API configuration. |
| `maxLength` | `number \| undefined` | _not documented_ | specifies the maximum number of characters allowed in the input element. **Deprecated:** since v20.0.0, use maxlength instead. |
| `strongLabel` | `string \| undefined` | _not documented_ | Text for a strong password. Defaults to AnguluxConfig I18N API configuration. |
| `inputId` | `string \| undefined` | _not documented_ | Identifier of the accessible input element. |
| `feedback` | `boolean` | _not documented_ | Whether to show the strength indicator or not. |
| `toggleMask` | `boolean \| undefined` | _not documented_ | Whether to show an icon to display the password as plain text. |
| `inputStyleClass` | `string \| undefined` | _not documented_ | Style class of the input field. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the element. **Deprecated:** since v20.0.0, use `class` instead. |
| `inputStyle` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the input field. |
| `showTransitionOptions` | `string` | _not documented_ | Transition options of the show animation. **Deprecated:** since v21.0.0, use `motionOptions` instead. |
| `hideTransitionOptions` | `string` | _not documented_ | Transition options of the hide animation. **Deprecated:** since v21.0.0, use `motionOptions` instead. |
| `autocomplete` | `string \| undefined` | _not documented_ | Specify automated assistance in filling out password by browser. |
| `placeholder` | `string \| undefined` | _not documented_ | Advisory information to display on input. |
| `showClear` | `boolean` | _not documented_ | When enabled, a clear icon is displayed to clear the value. |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |
| `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. |
| `overlayOptions` | `OverlayOptions \| undefined` | _not documented_ | Whether to use overlay API feature. The properties of overlay API can be used like an object in it. |

| Output | Type | Description |
| --- | --- | --- |
| `onFocus` | `EventEmitter<Event>` | Callback to invoke when the component receives focus. |
| `onBlur` | `EventEmitter<Event>` | Callback to invoke when the component loses focus. |
| `onClear` | `EventEmitter<any>` | Callback to invoke when clear button is clicked. |

# popover

```ts
import { … } from '@anguless/angulux/popover';
```

## Popover

`agl-popover` — component

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` | `string` | _not documented_ | Transition options of the show animation. **Deprecated:** since v21.0.0. Use `motionOptions` instead. |
| `hideTransitionOptions` | `string` | _not documented_ | Transition options of the hide animation. **Deprecated:** since v21.0.0. Use `motionOptions` instead. |
| `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. |

# progressbar

```ts
import { … } from '@anguless/angulux/progressbar';
```

## ProgressBar

`agl-progressBar, agl-progressbar, agl-progress-bar` — component

ProgressBar is a process status indicator.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `value` | `number \| undefined` | _not documented_ | Current value of the progress. |
| `showValue` | `boolean` | _not documented_ | Whether to display the progress bar value. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the element. **Deprecated:** since v20.0.0, use `class` instead. |
| `valueStyleClass` | `string \| undefined` | _not documented_ | Style class of the value element. |
| `unit` | `string` | _not documented_ | Unit sign appended to the value. |
| `mode` | `'determinate' \| 'indeterminate'` | `'determinate'` | Defines the mode of the progress |
| `color` | `string \| undefined` | _not documented_ | Color for the background of the progress. |

# progressspinner

```ts
import { … } from '@anguless/angulux/progressspinner';
```

## ProgressSpinner

`agl-progressSpinner, agl-progress-spinner, agl-progressspinner` — component

ProgressSpinner is a process status indicator.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `styleClass` | `string \| undefined` | _not documented_ | Class of the element. **Deprecated:** since v20.0.0, use `class` instead. |
| `strokeWidth` | `string` | _not documented_ | Width of the circle stroke. |
| `fill` | `string` | _not documented_ | Color for the background of the circle. |
| `animationDuration` | `string` | _not documented_ | Duration of the rotate animation. |
| `ariaLabel` | `string \| undefined` | _not documented_ | Used to define a aria label attribute the current element. |

# radiobutton

```ts
import { … } from '@anguless/angulux/radiobutton';
```

## RadioButton

`agl-radioButton, agl-radiobutton, agl-radio-button` — component

RadioButton is an extension to standard radio button element with theming.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `value` | `any` | _not documented_ | Value of the radiobutton. |
| `tabindex` | `number \| undefined` | _not documented_ | Index of the element in tabbing order. |
| `inputId` | `string \| undefined` | _not documented_ | Identifier of the focus input to match a label defined for the component. |
| `ariaLabelledBy` | `string \| undefined` | _not documented_ | Establishes relationships between the component and label(s) where its value should be one or more element IDs. |
| `ariaLabel` | `string \| undefined` | _not documented_ | Used to define a string that labels the input element. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |
| `binary` | `boolean \| undefined` | _not documented_ | Allows to select a boolean value. |
| `variant` | `'filled' \| 'outlined' \| undefined` | `undefined` | Specifies the input variant of the component. |
| `size` | `'large' \| 'small' \| undefined` | `undefined` | Specifies the size of the component. |

| Output | Type | Description |
| --- | --- | --- |
| `onClick` | `EventEmitter<RadioButtonClickEvent>` | Callback to invoke on radio button click. |
| `onFocus` | `EventEmitter<Event>` | Callback to invoke when the receives focus. |
| `onBlur` | `EventEmitter<Event>` | Callback to invoke when the loses focus. |

# ripple

```ts
import { … } from '@anguless/angulux/ripple';
```

## Ripple

`[aglRipple]` — directive

Ripple directive adds ripple effect to the host element.

# scroller

```ts
import { … } from '@anguless/angulux/scroller';
```

## Scroller

`agl-scroller, agl-virtualscroller, agl-virtual-scroller, agl-virtualScroller` — component

Scroller is a performance-approach to handle huge data efficiently.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `hostName` | `` | _not documented_ |  |
| `id` | `string \| undefined` | _not documented_ | Unique identifier of the element. |
| `style` | `any` | _not documented_ | Inline style of the component. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the element. |
| `tabindex` | `` | _not documented_ | Index of the element in tabbing order. |
| `items` | `any[] \| undefined \| null` | _not documented_ | An array of objects to display. |
| `itemSize` | `number[] \| number` | _not documented_ | The height/width of item according to orientation. |
| `scrollHeight` | `string \| undefined` | _not documented_ | Height of the scroll viewport. |
| `scrollWidth` | `string \| undefined` | _not documented_ | Width of the scroll viewport. |
| `orientation` | `'vertical' \| 'horizontal' \| 'both'` | _not documented_ | The orientation of scrollbar. |
| `step` | `number` | _not documented_ | Used to specify how many items to load in each load method in lazy mode. |
| `delay` | `` | _not documented_ | Delay in scroll before new data is loaded. |
| `resizeDelay` | `` | _not documented_ | Delay after window's resize finishes. |
| `appendOnly` | `boolean` | _not documented_ | Used to append each loaded item to top without removing any items from the DOM. Using very large data may cause the browser to crash. |
| `inline` | `` | _not documented_ | Specifies whether the scroller should be displayed inline or not. |
| `lazy` | `` | _not documented_ | Defines if data is loaded and interacted with in lazy manner. |
| `disabled` | `` | _not documented_ | If disabled, the scroller feature is eliminated and the content is displayed directly. |
| `loaderDisabled` | `` | _not documented_ | Used to implement a custom loader instead of using the loader feature in the scroller. |
| `columns` | `any[] \| undefined \| null` | _not documented_ | Columns to display. |
| `showSpacer` | `` | _not documented_ | Used to implement a custom spacer instead of using the spacer feature in the scroller. |
| `showLoader` | `` | _not documented_ | Defines whether to show loader. |
| `numToleratedItems` | `` | _not documented_ | Determines how many additional elements to add to the DOM outside of the view. According to the scrolls made up and down, extra items are added in a certain algorithm in the form of multiples of this number. Default value is half the number of items shown in the view. |
| `loading` | `boolean \| undefined` | _not documented_ | Defines whether the data is loaded. |
| `autoSize` | `boolean` | _not documented_ | Defines whether to dynamically change the height or width of scrollable container. |
| `trackBy` | `Function` | _not documented_ | Function to optimize the dom operations by delegating to ngForTrackBy, default algoritm checks for object identity. |
| `options` | `ScrollerOptions \| undefined` | _not documented_ | Defines whether to use the scroller feature. The properties of scroller component can be used like an object in it. |

| Output | Type | Description |
| --- | --- | --- |
| `onLazyLoad` | `EventEmitter<ScrollerLazyLoadEvent>` | Callback to invoke in lazy mode to load new data. |
| `onScroll` | `EventEmitter<ScrollerScrollEvent>` | Callback to invoke when scroll position changes. |
| `onScrollIndexChange` | `EventEmitter<ScrollerScrollIndexChangeEvent>` | Callback to invoke when scroll position and item's range in view changes. |

# select

```ts
import { … } from '@anguless/angulux/select';
```

## SelectItem

`agl-selectItem` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `id` | `string \| undefined` | _not documented_ |  |
| `option` | `any` | _not documented_ |  |
| `selected` | `boolean \| undefined` | _not documented_ |  |
| `focused` | `boolean \| undefined` | _not documented_ |  |
| `label` | `string \| undefined` | _not documented_ |  |
| `disabled` | `boolean \| undefined` | _not documented_ |  |
| `visible` | `boolean \| undefined` | _not documented_ |  |
| `itemSize` | `number \| undefined` | _not documented_ |  |
| `ariaPosInset` | `string \| undefined` | _not documented_ |  |
| `ariaSetSize` | `string \| undefined` | _not documented_ |  |
| `template` | `TemplateRef<any> \| undefined` | _not documented_ |  |
| `checkmark` | `boolean` | _not documented_ |  |
| `index` | `number \| undefined` | _not documented_ |  |
| `scrollerOptions` | `any` | _not documented_ |  |

| Output | Type | Description |
| --- | --- | --- |
| `onClick` | `EventEmitter<any>` |  |
| `onMouseEnter` | `EventEmitter<any>` |  |

## Select

`agl-select` — component

Select is used to choose an item from a collection of options.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `id` | `string \| undefined` | _not documented_ | Unique identifier of the component |
| `scrollHeight` | `string` | _not documented_ | Height of the viewport in pixels, a scrollbar is defined if height of list exceeds this value. |
| `filter` | `boolean \| undefined` | _not documented_ | When specified, displays an input field to filter the items on keyup. |
| `panelStyle` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the overlay panel element. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the element. **Deprecated:** since v20.0.0, use `class` instead. |
| `panelStyleClass` | `string \| undefined` | _not documented_ | Style class of the overlay panel element. |
| `readonly` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component cannot be edited. |
| `editable` | `boolean \| undefined` | _not documented_ | When present, custom value instead of predefined options can be entered using the editable input field. |
| `tabindex` | `number \| undefined` | _not documented_ | Index of the element in tabbing order. |
| `placeholder` | `` | _not documented_ | Default text to display when no option is selected. |
| `loadingIcon` | `string \| undefined` | _not documented_ | Icon to display in loading state. |
| `filterPlaceholder` | `string \| undefined` | _not documented_ | Placeholder text to show when filter input is empty. |
| `filterLocale` | `string \| undefined` | _not documented_ | Locale to use in filtering. The default locale is the host environment's current locale. |
| `inputId` | `string \| undefined` | _not documented_ | Identifier of the accessible input element. |
| `dataKey` | `string \| undefined` | _not documented_ | A property to uniquely identify a value in options. |
| `filterBy` | `string \| undefined` | _not documented_ | When filtering is enabled, filterBy decides which field or fields (comma separated) to search against. |
| `filterFields` | `any[] \| undefined` | _not documented_ | Fields used when filtering the options, defaults to optionLabel. |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |
| `resetFilterOnHide` | `boolean` | _not documented_ | Clears the filter value when hiding the select. |
| `checkmark` | `boolean` | _not documented_ | Whether the selected option will be shown with a check mark. |
| `dropdownIcon` | `string \| undefined` | _not documented_ | Icon class of the select icon. |
| `loading` | `boolean \| undefined` | _not documented_ | Whether the select is in loading state. |
| `optionLabel` | `string \| undefined` | _not documented_ | Name of the label field of an option. |
| `optionValue` | `string \| undefined` | _not documented_ | Name of the value field of an option. |
| `optionDisabled` | `string \| undefined` | _not documented_ | Name of the disabled field of an option. |
| `optionGroupLabel` | `string \| undefined` | _not documented_ | Name of the label field of an option group. |
| `optionGroupChildren` | `string` | _not documented_ | Name of the options field of an option group. |
| `group` | `boolean \| undefined` | _not documented_ | Whether to display options as grouped when nested options are provided. |
| `showClear` | `boolean \| undefined` | _not documented_ | When enabled, a clear icon is displayed to clear the value. |
| `emptyFilterMessage` | `string` | _not documented_ | Text to display when filtering does not return any results. Defaults to global value in i18n translation configuration. |
| `emptyMessage` | `string` | _not documented_ | Text to display when there is no data. Defaults to global value in i18n translation configuration. |
| `lazy` | `boolean` | _not documented_ | Defines if data is loaded and interacted with in lazy manner. |
| `virtualScroll` | `boolean \| undefined` | _not documented_ | Whether the data should be loaded on demand during scroll. |
| `virtualScrollItemSize` | `number \| undefined` | _not documented_ | Height of an item in the list for VirtualScrolling. |
| `virtualScrollOptions` | `ScrollerOptions \| undefined` | _not documented_ | Whether to use the scroller feature. The properties of scroller component can be used like an object in it. |
| `overlayOptions` | `OverlayOptions \| undefined` | _not documented_ | Whether to use overlay API feature. The properties of overlay API can be used like an object in it. |
| `ariaFilterLabel` | `string \| undefined` | _not documented_ | Defines a string that labels the filter input. |
| `ariaLabel` | `string \| undefined` | _not documented_ | Used to define a aria label attribute the current element. |
| `ariaLabelledBy` | `string \| undefined` | _not documented_ | Establishes relationships between the component and label(s) where its value should be one or more element IDs. |
| `filterMatchMode` | `'contains' \| 'startsWith' \| 'endsWith' \| 'equals' \| 'notEquals' \| 'in' \| 'lt' \| 'lte' \| 'gt' \| 'gte'` | _not documented_ | Defines how the items are filtered. |
| `tooltip` | `string` | _not documented_ | Advisory information to display in a tooltip on hover. |
| `tooltipPosition` | `'top' \| 'left' \| 'right' \| 'bottom'` | _not documented_ | Position of the tooltip. |
| `tooltipPositionStyle` | `string` | _not documented_ | Type of CSS position. |
| `tooltipStyleClass` | `string \| undefined` | _not documented_ | Style class of the tooltip. |
| `focusOnHover` | `boolean` | _not documented_ | Fields used when filtering the options, defaults to optionLabel. |
| `selectOnFocus` | `boolean` | _not documented_ | Determines if the option will be selected on focus. |
| `autoOptionFocus` | `boolean` | _not documented_ | Whether to focus on the first visible or selected element when the overlay panel is shown. |
| `autofocusFilter` | `boolean` | _not documented_ | Applies focus to the filter element when the overlay is shown. |
| `filterValue` | `string \| undefined \| null` | _not documented_ | When specified, filter displays with this value. |
| `options` | `any[] \| null \| undefined` | _not documented_ | An array of objects to display as the available options. |
| `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 |
| --- | --- | --- |
| `onChange` | `EventEmitter<SelectChangeEvent>` | Callback to invoke when value of select changes. |
| `onFilter` | `EventEmitter<SelectFilterEvent>` | Callback to invoke when data is filtered. |
| `onFocus` | `EventEmitter<Event>` | Callback to invoke when select gets focus. |
| `onBlur` | `EventEmitter<Event>` | Callback to invoke when select loses focus. |
| `onClick` | `EventEmitter<MouseEvent>` | Callback to invoke when component is clicked. |
| `onShow` | `EventEmitter<AnimationEvent>` | Callback to invoke when select overlay gets visible. |
| `onHide` | `EventEmitter<AnimationEvent>` | Callback to invoke when select overlay gets hidden. |
| `onClear` | `EventEmitter<Event>` | Callback to invoke when select clears the value. |
| `onLazyLoad` | `EventEmitter<SelectLazyLoadEvent>` | Callback to invoke in lazy mode to load new data. |

# selectbutton

```ts
import { … } from '@anguless/angulux/selectbutton';
```

## SelectButton

`agl-selectButton, agl-selectbutton, agl-select-button` — component

SelectButton is used to choose single or multiple items from a list using buttons.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `options` | `any[] \| undefined` | _not documented_ | An array of selectitems to display as the available options. |
| `optionLabel` | `string \| undefined` | _not documented_ | Name of the label field of an option. |
| `optionValue` | `string \| undefined` | _not documented_ | Name of the value field of an option. |
| `optionDisabled` | `string \| undefined` | _not documented_ | Name of the disabled field of an option. |
| `unselectable` | `` | _not documented_ |  |
| `tabindex` | `number` | _not documented_ | Index of the element in tabbing order. |
| `multiple` | `boolean \| undefined` | _not documented_ | When specified, allows selecting multiple values. |
| `allowEmpty` | `boolean` | _not documented_ | Whether selection can not be cleared. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. |
| `ariaLabelledBy` | `string \| undefined` | _not documented_ | Establishes relationships between the component and label(s) where its value should be one or more element IDs. |
| `dataKey` | `string \| undefined` | _not documented_ | A property to uniquely identify a value in options. |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |
| `size` | `'large' \| 'small' \| undefined` | `undefined` | Specifies the size of the component. |
| `fluid` | `` | `undefined` | Spans 100% width of the container when enabled. |

| Output | Type | Description |
| --- | --- | --- |
| `onOptionClick` | `EventEmitter<SelectButtonOptionClickEvent>` | Callback to invoke on input click. |
| `onChange` | `EventEmitter<SelectButtonChangeEvent>` | Callback to invoke on selection change. |

# skeleton

```ts
import { … } from '@anguless/angulux/skeleton';
```

## Skeleton

`agl-skeleton` — component

Skeleton is a placeholder to display instead of the actual content.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `styleClass` | `string \| undefined` | _not documented_ | Class of the element. **Deprecated:** since v20.0.0, use `class` instead. |
| `shape` | `string` | _not documented_ | Shape of the element. |
| `animation` | `string` | _not documented_ | Type of the animation. |
| `borderRadius` | `string \| undefined` | _not documented_ | Border radius of the element, defaults to value from theme. |
| `size` | `string \| undefined` | _not documented_ | Size of the skeleton. |
| `width` | `string` | _not documented_ | Width of the element. |
| `height` | `string` | _not documented_ | Height of the element. |

# splitbutton

```ts
import { … } from '@anguless/angulux/splitbutton';
```

## SplitButton

`agl-splitbutton, agl-splitButton, agl-split-button` — component

SplitButton groups a set of commands in an overlay with a default command.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `model` | `MenuItem[] \| undefined` | _not documented_ | MenuModel instance to define the overlay items. |
| `severity` | `'success' \| 'info' \| 'warn' \| 'danger' \| 'help' \| 'primary' \| 'secondary' \| 'contrast' \| null \| undefined` | _not documented_ | Defines the style of the button. |
| `raised` | `boolean` | _not documented_ | Add a shadow to indicate elevation. |
| `rounded` | `boolean` | _not documented_ | Add a circular border radius to the button. |
| `text` | `boolean` | _not documented_ | Add a textual class to the button without a background initially. |
| `outlined` | `boolean` | _not documented_ | Add a border class without a background initially. |
| `size` | `'small' \| 'large' \| undefined \| null` | _not documented_ | Defines the size of the button. |
| `plain` | `boolean` | _not documented_ | Add a plain textual class to the button without a background initially. |
| `icon` | `string \| undefined` | _not documented_ | Name of the icon. |
| `iconPos` | `SplitButtonIconPosition` | _not documented_ | Position of the icon. |
| `label` | `string \| undefined` | _not documented_ | Text of the button. |
| `tooltip` | `string \| undefined` | _not documented_ | Tooltip for the main button. |
| `tooltipOptions` | `TooltipOptions \| undefined` | _not documented_ | Tooltip options for the main button. |
| `styleClass` | `string \| undefined` | _not documented_ | Class of the element. **Deprecated:** since v20.0.0, use `class` instead. |
| `menuStyle` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the overlay menu. |
| `menuStyleClass` | `string \| undefined` | _not documented_ | Style class of the overlay menu. |
| `dropdownIcon` | `string \| undefined` | _not documented_ | Name of the dropdown icon. |
| `appendTo` | `HTMLElement \| ElementRef \| TemplateRef<any> \| 'self' \| 'body' \| null \| undefined \| any` | `'body'` | 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). |
| `dir` | `string \| undefined` | _not documented_ | Indicates the direction of the element. |
| `expandAriaLabel` | `string \| undefined` | _not documented_ | Defines a string that labels the expand button for accessibility. |
| `showTransitionOptions` | `string` | _not documented_ | Transition options of the show animation. **Deprecated:** since v21.0.0. Use `motionOptions` instead. |
| `hideTransitionOptions` | `string` | _not documented_ | Transition options of the hide animation. **Deprecated:** since v21.0.0. Use `motionOptions` instead. |
| `motionOptions` | `MotionOptions \| undefined` | _not documented_ | The motion options. |
| `buttonProps` | `ButtonProps \| undefined` | _not documented_ | Button Props |
| `menuButtonProps` | `MenuButtonProps \| undefined` | _not documented_ | Menu Button Props |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |
| `disabled` | `` | _not documented_ | When present, it specifies that the element should be disabled. |
| `tabindex` | `number \| undefined` | _not documented_ | Index of the element in tabbing order. |
| `menuButtonDisabled` | `boolean` | _not documented_ | When present, it specifies that the menu button element should be disabled. |
| `buttonDisabled` | `boolean` | _not documented_ | When present, it specifies that the button element should be disabled. |

| Output | Type | Description |
| --- | --- | --- |
| `onClick` | `EventEmitter<MouseEvent>` | Callback to invoke when default command button is clicked. |
| `onMenuHide` | `EventEmitter<any>` | Callback to invoke when overlay menu is hidden. |
| `onMenuShow` | `EventEmitter<any>` | Callback to invoke when overlay menu is shown. |
| `onDropdownClick` | `EventEmitter<MouseEvent>` | Callback to invoke when dropdown button is clicked. |

# table

```ts
import { … } from '@anguless/angulux/table';
```

## Table

`agl-table` — component

Table displays data in tabular format.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `frozenColumns` | `any[] \| undefined` | _not documented_ | An array of objects to represent dynamic columns that are frozen. |
| `frozenValue` | `any[] \| undefined` | _not documented_ | An array of objects to display as frozen. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `tableStyle` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the table. |
| `tableStyleClass` | `string \| undefined` | _not documented_ | Style class of the table. |
| `paginator` | `boolean \| undefined` | _not documented_ | When specified as true, enables the pagination. |
| `pageLinks` | `number` | _not documented_ | Number of page links to display in paginator. |
| `rowsPerPageOptions` | `any[] \| undefined` | _not documented_ | Array of integer/object values to display inside rows per page dropdown of paginator |
| `alwaysShowPaginator` | `boolean` | _not documented_ | Whether to show it even there is only one page. |
| `paginatorPosition` | `'top' \| 'bottom' \| 'both'` | _not documented_ | Position of the paginator, options are "top", "bottom" or "both". |
| `paginatorStyleClass` | `string \| undefined` | _not documented_ | Custom style class for paginator |
| `paginatorDropdownAppendTo` | `HTMLElement \| ElementRef \| TemplateRef<any> \| string \| null \| undefined \| any` | _not documented_ | Target element to attach the paginator dropdown 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). |
| `paginatorDropdownScrollHeight` | `string` | _not documented_ | Paginator dropdown height of the viewport in pixels, a scrollbar is defined if height of list exceeds this value. |
| `currentPageReportTemplate` | `string` | _not documented_ | Template of the current page report element. Available placeholders are {currentPage},{totalPages},{rows},{first},{last} and {totalRecords} |
| `showCurrentPageReport` | `boolean \| undefined` | _not documented_ | Whether to display current page report. |
| `showJumpToPageDropdown` | `boolean \| undefined` | _not documented_ | Whether to display a dropdown to navigate to any page. |
| `showJumpToPageInput` | `boolean \| undefined` | _not documented_ | Whether to display a input to navigate to any page. |
| `showFirstLastIcon` | `boolean` | _not documented_ | When enabled, icons are displayed on paginator to go first and last page. |
| `showPageLinks` | `boolean` | _not documented_ | Whether to show page links. |
| `defaultSortOrder` | `number` | _not documented_ | Sort order to use when an unsorted column gets sorted by user interaction. |
| `sortMode` | `'single' \| 'multiple'` | _not documented_ | Defines whether sorting works on single column or on multiple columns. |
| `resetPageOnSort` | `boolean` | _not documented_ | When true, resets paginator to first page after sorting. Available only when sortMode is set to single. |
| `selectionMode` | `'single' \| 'multiple' \| undefined \| null` | _not documented_ | Specifies the selection mode, valid values are "single" and "multiple". |
| `selectionPageOnly` | `boolean \| undefined` | _not documented_ | When enabled with paginator and checkbox selection mode, the select all checkbox in the header will select all rows on the current page. |
| `contextMenuSelection` | `any` | _not documented_ | Selected row with a context menu. |
| `contextMenuSelectionMode` | `string` | _not documented_ | Defines the behavior of context menu selection, in "separate" mode context menu updates contextMenuSelection property whereas in joint mode selection property is used instead so that when row selection is enabled, both row selection and context menu selection use the same property. |
| `dataKey` | `string \| undefined` | _not documented_ | A property to uniquely identify a record in data. |
| `metaKeySelection` | `boolean \| undefined` | _not documented_ | Defines whether metaKey should be considered for the selection. On touch enabled devices, metaKeySelection is turned off automatically. |
| `rowSelectable` | `(row: { data: any; index: number }) => boolean \| undefined` | _not documented_ | Defines if the row is selectable. |
| `rowTrackBy` | `Function` | _not documented_ | Function to optimize the dom operations by delegating to ngForTrackBy, default algorithm checks for object identity. |
| `lazy` | `boolean` | _not documented_ | Defines if data is loaded and interacted with in lazy manner. |
| `lazyLoadOnInit` | `boolean` | _not documented_ | Whether to call lazy loading on initialization. |
| `compareSelectionBy` | `'equals' \| 'deepEquals'` | _not documented_ | Algorithm to define if a row is selected, valid values are "equals" that compares by reference and "deepEquals" that compares all fields. |
| `csvSeparator` | `string` | _not documented_ | Character to use as the csv separator. |
| `exportFilename` | `string` | _not documented_ | Name of the exported file. |
| `filters` | `{ [s: string]: FilterMetadata \| FilterMetadata[] }` | _not documented_ | An array of FilterMetadata objects to provide external filters. |
| `globalFilterFields` | `string[] \| undefined` | _not documented_ | An array of fields as string to use in global filtering. |
| `filterDelay` | `number` | _not documented_ | Delay in milliseconds before filtering the data. |
| `filterLocale` | `string \| undefined` | _not documented_ | Locale to use in filtering. The default locale is the host environment's current locale. |
| `expandedRowKeys` | `{ [s: string]: boolean }` | _not documented_ | Map instance to keep the expanded rows where key of the map is the data key of the row. |
| `editingRowKeys` | `{ [s: string]: boolean }` | _not documented_ | Map instance to keep the rows being edited where key of the map is the data key of the row. |
| `rowExpandMode` | `'multiple' \| 'single'` | _not documented_ | Whether multiple rows can be expanded at any time. Valid values are "multiple" and "single". |
| `scrollable` | `boolean \| undefined` | _not documented_ | Enables scrollable tables. |
| `rowGroupMode` | `'subheader' \| 'rowspan' \| undefined` | _not documented_ | Type of the row grouping, valid values are "subheader" and "rowspan". |
| `scrollHeight` | `string \| undefined` | _not documented_ | Height of the scroll viewport in fixed pixels or the "flex" keyword for a dynamic size. |
| `virtualScroll` | `boolean \| undefined` | _not documented_ | Whether the data should be loaded on demand during scroll. |
| `virtualScrollItemSize` | `number \| undefined` | _not documented_ | Height of a row to use in calculations of virtual scrolling. |
| `virtualScrollOptions` | `ScrollerOptions \| undefined` | _not documented_ | Whether to use the scroller feature. The properties of scroller component can be used like an object in it. |
| `virtualScrollDelay` | `number` | _not documented_ | Threshold in milliseconds to delay lazy loading during scrolling. |
| `frozenWidth` | `string \| undefined` | _not documented_ | Width of the frozen columns container. |
| `contextMenu` | `any` | _not documented_ | Local ng-template varilable of a ContextMenu. |
| `resizableColumns` | `boolean \| undefined` | _not documented_ | When enabled, columns can be resized using drag and drop. |
| `columnResizeMode` | `string` | _not documented_ | Defines whether the overall table width should change on column resize, valid values are "fit" and "expand". |
| `reorderableColumns` | `boolean \| undefined` | _not documented_ | When enabled, columns can be reordered using drag and drop. |
| `loading` | `boolean \| undefined` | _not documented_ | Displays a loader to indicate data load is in progress. |
| `loadingIcon` | `string \| undefined` | _not documented_ | The icon to show while indicating data load is in progress. |
| `showLoader` | `boolean` | _not documented_ | Whether to show the loading mask when loading property is true. |
| `rowHover` | `boolean \| undefined` | _not documented_ | Adds hover effect to rows without the need for selectionMode. Note that tr elements that can be hovered need to have "p-selectable-row" class for rowHover to work. |
| `customSort` | `boolean \| undefined` | _not documented_ | Whether to use the default sorting or a custom one using sortFunction. |
| `showInitialSortBadge` | `boolean` | _not documented_ | Whether to use the initial sort badge or not. |
| `exportFunction` | `Function \| undefined` | _not documented_ | Export function. |
| `exportHeader` | `string \| undefined` | _not documented_ | Custom export header of the column to be exported as CSV. |
| `stateKey` | `string \| undefined` | _not documented_ | Unique identifier of a stateful table to use in state storage. |
| `stateStorage` | `'session' \| 'local'` | _not documented_ | Defines where a stateful table keeps its state, valid values are "session" for sessionStorage and "local" for localStorage. |
| `editMode` | `'cell' \| 'row'` | _not documented_ | Defines the editing mode, valid values are "cell" and "row". |
| `groupRowsBy` | `any` | _not documented_ | Field name to use in row grouping. |
| `size` | `'small' \| 'large' \| undefined` | _not documented_ | Defines the size of the table. |
| `showGridlines` | `boolean \| undefined` | _not documented_ | Whether to show grid lines between cells. |
| `stripedRows` | `boolean \| undefined` | _not documented_ | Whether to display rows with alternating colors. |
| `groupRowsByOrder` | `number` | _not documented_ | Order to sort when default row grouping is enabled. |
| `responsiveLayout` | `string` | _not documented_ | Defines the responsive mode, valid options are "stack" and "scroll". **Deprecated:** since v20.0.0, always defaults to scroll, stack mode needs custom implementation |
| `breakpoint` | `string` | _not documented_ | The breakpoint to define the maximum width boundary when using stack responsive layout. |
| `paginatorLocale` | `string \| undefined` | _not documented_ | Locale to be used in paginator formatting. |
| `value` | `RowData[]` | _not documented_ | An array of objects to display. |
| `columns` | `any[] \| undefined` | _not documented_ | An array of objects to represent dynamic columns. |
| `first` | `number \| null \| undefined` | _not documented_ | Index of the first row to be displayed. |
| `rows` | `number \| undefined` | _not documented_ | Number of rows to display per page. |
| `totalRecords` | `number` | _not documented_ | Number of total records, defaults to length of value when not defined. |
| `sortField` | `string \| undefined \| null` | _not documented_ | Name of the field to sort data by default. |
| `sortOrder` | `number` | _not documented_ | Order to sort when default sorting is enabled. |
| `multiSortMeta` | `SortMeta[] \| undefined \| null` | _not documented_ | An array of SortMeta objects to sort the data by default in multiple sort mode. |
| `selection` | `any` | _not documented_ | Selected row in single mode or an array of values in multiple mode. |
| `selectAll` | `boolean \| null` | _not documented_ | Whether all data is selected. |

| Output | Type | Description |
| --- | --- | --- |
| `contextMenuSelectionChange` | `EventEmitter<any>` | Callback to invoke on context menu selection change. |
| `selectAllChange` | `EventEmitter<TableSelectAllChangeEvent>` | Emits when the all of the items selected or unselected. |
| `selectionChange` | `EventEmitter<any \| null>` | Callback to invoke on selection changed. |
| `onRowSelect` | `EventEmitter<TableRowSelectEvent<RowData>>` | Callback to invoke when a row is selected. |
| `onRowUnselect` | `EventEmitter<TableRowUnSelectEvent<RowData>>` | Callback to invoke when a row is unselected. |
| `onPage` | `EventEmitter<TablePageEvent>` | Callback to invoke when pagination occurs. |
| `onSort` | `EventEmitter<{ multisortmeta: SortMeta[] } \| any>` | Callback to invoke when a column gets sorted. |
| `onFilter` | `EventEmitter<TableFilterEvent>` | Callback to invoke when data is filtered. |
| `onLazyLoad` | `EventEmitter<TableLazyLoadEvent>` | Callback to invoke when paging, sorting or filtering happens in lazy mode. |
| `onRowExpand` | `EventEmitter<TableRowExpandEvent<RowData>>` | Callback to invoke when a row is expanded. |
| `onRowCollapse` | `EventEmitter<TableRowCollapseEvent>` | Callback to invoke when a row is collapsed. |
| `onContextMenuSelect` | `EventEmitter<TableContextMenuSelectEvent<RowData>>` | Callback to invoke when a row is selected with right click. |
| `onColResize` | `EventEmitter<TableColResizeEvent>` | Callback to invoke when a column is resized. |
| `onColReorder` | `EventEmitter<TableColumnReorderEvent>` | Callback to invoke when a column is reordered. |
| `onRowReorder` | `EventEmitter<TableRowReorderEvent>` | Callback to invoke when a row is reordered. |
| `onEditInit` | `EventEmitter<TableEditInitEvent>` | Callback to invoke when a cell switches to edit mode. |
| `onEditComplete` | `EventEmitter<TableEditCompleteEvent>` | Callback to invoke when cell edit is completed. |
| `onEditCancel` | `EventEmitter<TableEditCancelEvent>` | Callback to invoke when cell edit is cancelled with escape key. |
| `onHeaderCheckboxToggle` | `EventEmitter<TableHeaderCheckboxToggleEvent>` | Callback to invoke when state of header checkbox changes. |
| `sortFunction` | `EventEmitter<any>` | A function to implement custom sorting, refer to sorting section for details. |
| `firstChange` | `EventEmitter<number>` | Callback to invoke on pagination. |
| `rowsChange` | `EventEmitter<number>` | Callback to invoke on rows change. |
| `onStateSave` | `EventEmitter<TableState>` | Callback to invoke table state is saved. |
| `onStateRestore` | `EventEmitter<TableState>` | Callback to invoke table state is restored. |

## TableBody

`[aglTableBody]` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `columns` | `any[] \| undefined` | _not documented_ |  |
| `template` | `Nullable<TemplateRef<any>>` | _not documented_ |  |
| `value` | `any[] \| undefined` | _not documented_ |  |
| `frozen` | `boolean \| undefined` | _not documented_ |  |
| `frozenRows` | `boolean \| undefined` | _not documented_ |  |
| `scrollerOptions` | `any` | _not documented_ |  |

## RowGroupHeader

`[aglRowGroupHeader]` — directive

## FrozenColumn

`[aglFrozenColumn]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `frozen` | `boolean` | _not documented_ |  |
| `alignFrozen` | `string` | _not documented_ |  |

## SortableColumn

`[aglSortableColumn]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `field` | `string \| undefined` | _not documented_ |  |
| `aglSortableColumnDisabled` | `boolean \| undefined` | _not documented_ |  |

## SortIcon

`agl-sortIcon` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `field` | `string \| undefined` | _not documented_ |  |

## SelectableRow

`[aglSelectableRow]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `data` | `any` | _not documented_ |  |
| `index` | `number \| undefined` | _not documented_ |  |
| `aglSelectableRowDisabled` | `boolean \| undefined` | _not documented_ |  |

## SelectableRowDblClick

`[aglSelectableRowDblClick]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `data` | `any` | _not documented_ |  |
| `index` | `number \| undefined` | _not documented_ |  |
| `aglSelectableRowDisabled` | `boolean \| undefined` | _not documented_ |  |

## ContextMenuRow

`[aglContextMenuRow]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `data` | `any` | _not documented_ |  |
| `index` | `number \| undefined` | _not documented_ |  |
| `aglContextMenuRowDisabled` | `boolean \| undefined` | _not documented_ |  |

## RowToggler

`[aglRowToggler]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `data` | `any` | _not documented_ |  |
| `aglRowTogglerDisabled` | `boolean \| undefined` | _not documented_ |  |

## ResizableColumn

`[aglResizableColumn]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `aglResizableColumnDisabled` | `boolean \| undefined` | _not documented_ |  |

## ReorderableColumn

`[aglReorderableColumn]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `aglReorderableColumnDisabled` | `boolean \| undefined` | _not documented_ |  |

## EditableColumn

`[aglEditableColumn]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `data` | `any` | _not documented_ |  |
| `field` | `any` | _not documented_ |  |
| `rowIndex` | `number \| undefined` | _not documented_ |  |
| `aglEditableColumnDisabled` | `boolean \| undefined` | _not documented_ |  |
| `aglFocusCellSelector` | `string \| undefined` | _not documented_ |  |

## EditableRow

`[aglEditableRow]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `data` | `any` | _not documented_ |  |
| `aglEditableRowDisabled` | `boolean \| undefined` | _not documented_ |  |

## InitEditableRow

`[aglInitEditableRow]` — directive

## SaveEditableRow

`[aglSaveEditableRow]` — directive

## CancelEditableRow

`[aglCancelEditableRow]` — directive

## CellEditor

`agl-cellEditor` — component

## TableRadioButton

`agl-tableRadioButton` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `value` | `any` | _not documented_ |  |
| `disabled` | `boolean \| undefined` | _not documented_ |  |
| `index` | `number \| undefined` | _not documented_ |  |
| `inputId` | `string \| undefined` | _not documented_ |  |
| `name` | `string \| undefined` | _not documented_ |  |
| `ariaLabel` | `string \| undefined` | _not documented_ |  |

## TableCheckbox

`agl-tableCheckbox` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `value` | `any` | _not documented_ |  |
| `disabled` | `boolean \| undefined` | _not documented_ |  |
| `required` | `boolean \| undefined` | _not documented_ |  |
| `index` | `number \| undefined` | _not documented_ |  |
| `inputId` | `string \| undefined` | _not documented_ |  |
| `name` | `string \| undefined` | _not documented_ |  |
| `ariaLabel` | `string \| undefined` | _not documented_ |  |

## TableHeaderCheckbox

`agl-tableHeaderCheckbox` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `disabled` | `boolean \| undefined` | _not documented_ |  |
| `inputId` | `string \| undefined` | _not documented_ |  |
| `name` | `string \| undefined` | _not documented_ |  |
| `ariaLabel` | `string \| undefined` | _not documented_ |  |

## ReorderableRowHandle

`[aglReorderableRowHandle]` — directive

## ReorderableRow

`[aglReorderableRow]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `index` | `number \| undefined` | _not documented_ |  |
| `aglReorderableRowDisabled` | `boolean \| undefined` | _not documented_ |  |

## ColumnFilter

`agl-columnFilter, agl-column-filter, agl-columnfilter` — component

Column Filter Component.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `field` | `string \| undefined` | _not documented_ | Property represented by the column. |
| `type` | `string` | _not documented_ | Type of the input. |
| `display` | `string` | _not documented_ | Filter display. |
| `showMenu` | `boolean` | _not documented_ | Decides whether to display filter menu popup. |
| `matchMode` | `string \| undefined` | _not documented_ | Filter match mode. |
| `operator` | `string` | `'AND'` | Filter operator. |
| `showOperator` | `boolean` | _not documented_ | Decides whether to display filter operator. |
| `showClearButton` | `boolean` | `true` | Decides whether to display clear filter button when display is menu. |
| `showApplyButton` | `boolean` | _not documented_ | Decides whether to display apply filter button when display is menu. |
| `showMatchModes` | `boolean` | _not documented_ | Decides whether to display filter match modes when display is menu. |
| `showAddButton` | `boolean` | _not documented_ | Decides whether to display add filter button when display is menu. |
| `hideOnClear` | `boolean` | _not documented_ | Decides whether to close popup on clear button click. |
| `placeholder` | `string \| undefined` | _not documented_ | Filter placeholder. |
| `matchModeOptions` | `SelectItem[] \| undefined` | _not documented_ | Filter match mode options. |
| `maxConstraints` | `number` | _not documented_ | Defines maximum amount of constraints. |
| `minFractionDigits` | `number \| undefined` | _not documented_ | Defines minimum fraction of digits. |
| `maxFractionDigits` | `number \| undefined` | _not documented_ | Defines maximum fraction of digits. |
| `prefix` | `string \| undefined` | _not documented_ | Defines prefix of the filter. |
| `suffix` | `string \| undefined` | _not documented_ | Defines suffix of the filter. |
| `locale` | `string \| undefined` | _not documented_ | Defines filter locale. |
| `localeMatcher` | `string \| undefined` | _not documented_ | Defines filter locale matcher. |
| `currency` | `string \| undefined` | _not documented_ | Enables currency input. |
| `currencyDisplay` | `string \| undefined` | _not documented_ | Defines the display of the currency input. |
| `filterOn` | `string \| undefined` | `enter` | Default trigger to run filtering on built-in text and numeric filters, valid values are 'enter' and 'input'. |
| `useGrouping` | `boolean` | _not documented_ | Defines if filter grouping will be enabled. |
| `showButtons` | `boolean` | _not documented_ | Defines the visibility of buttons. |
| `ariaLabel` | `string \| undefined` | _not documented_ | Defines the aria-label of the form element. |
| `filterButtonProps` | `TableFilterButtonPropsOptions` | `{ filter: { severity: 'secondary', text: true, rounded: true }, inline: { clear: { severity: 'secondary', text: true, rounded: true } }, popover: { addRule: { severity: 'info', text: true, size: 'small' }, removeRule: { severity: 'danger', text: true, size: 'small' }, apply: { size: 'small' }, clear: { outlined: true, size: 'small' } } }` | Used to pass all filter button property object |
| `motionOptions` | `MotionOptions \| undefined` | _not documented_ |  |

| Output | Type | Description |
| --- | --- | --- |
| `onShow` | `EventEmitter<{ originalEvent: AnimationEvent }>` | Callback to invoke on overlay is shown. |
| `onHide` | `EventEmitter<{ originalEvent: AnimationEvent }>` | Callback to invoke on overlay is hidden. |

## ColumnFilterFormElement

`agl-columnFilterFormElement` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `field` | `string \| undefined` | _not documented_ |  |
| `type` | `string \| undefined` | _not documented_ |  |
| `filterConstraint` | `FilterMetadata \| undefined` | _not documented_ |  |
| `filterTemplate` | `Nullable<TemplateRef<any>>` | _not documented_ |  |
| `placeholder` | `string \| undefined` | _not documented_ |  |
| `minFractionDigits` | `number \| undefined` | _not documented_ |  |
| `maxFractionDigits` | `number \| undefined` | _not documented_ |  |
| `prefix` | `string \| undefined` | _not documented_ |  |
| `suffix` | `string \| undefined` | _not documented_ |  |
| `locale` | `string \| undefined` | _not documented_ |  |
| `localeMatcher` | `string \| undefined` | _not documented_ |  |
| `currency` | `string \| undefined` | _not documented_ |  |
| `currencyDisplay` | `string \| undefined` | _not documented_ |  |
| `useGrouping` | `boolean` | _not documented_ |  |
| `ariaLabel` | `string \| undefined` | _not documented_ |  |
| `filterOn` | `string \| undefined` | _not documented_ |  |

# tabs

```ts
import { … } from '@anguless/angulux/tabs';
```

## Tab

`agl-tab` — component

Defines valid properties in Tab component.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `disabled` | `` | `false` | Whether the tab is disabled. |

## TabList

`agl-tablist` — component

TabList is a helper component for Tabs component.

## TabPanel

`agl-tabpanel` — component

TabPanel is a helper component for Tabs component.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `lazy` | `` | `false` | When enabled, tab is not rendered until activation. |

## TabPanels

`agl-tabpanels` — component

TabPanels is a helper component for Tabs component.

## Tabs

`agl-tabs` — component

Tabs facilitates seamless switching between different views.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `scrollable` | `` | `false` | When specified, enables horizontal and/or vertical scrolling. |
| `lazy` | `` | `false` | When enabled, tabs are not rendered until activation. |
| `selectOnFocus` | `` | `false` | When enabled, the focused tab is activated. |
| `showNavigators` | `` | `true` | Whether to display navigation buttons in container when scrollable is enabled. |
| `tabindex` | `` | `0` | Tabindex of the tab buttons. |

# tag

```ts
import { … } from '@anguless/angulux/tag';
```

## Tag

`agl-tag` — component

Tag component is used to categorize content.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `severity` | `'success' \| 'secondary' \| 'info' \| 'warn' \| 'danger' \| 'contrast' \| undefined \| null` | _not documented_ | Severity type of the tag. |
| `value` | `string \| undefined` | _not documented_ | Value to display inside the tag. |
| `icon` | `string \| undefined` | _not documented_ | Icon of the tag to display next to the value. |
| `rounded` | `boolean \| undefined` | _not documented_ | Whether the corners of the tag are rounded. |

# textarea

```ts
import { … } from '@anguless/angulux/textarea';
```

## Textarea

`[aglTextarea], [aglInputTextarea]` — directive

Textarea adds styling and autoResize functionality to standard textarea element.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `pTextareaPT` | `TextareaPassThrough` | `undefined` | Used to pass attributes to DOM elements inside the Textarea component. |
| `pTextareaUnstyled` | `boolean \| undefined` | `undefined` | Indicates whether the component should be rendered without styles. |
| `autoResize` | `boolean \| undefined` | _not documented_ | When present, textarea size changes as being typed. |
| `aglSize` | `'large' \| 'small'` | _not documented_ | Defines the size of the component. |
| `variant` | `'filled' \| 'outlined' \| undefined` | `undefined` | Specifies the input variant of the component. |
| `fluid` | `` | `undefined` | Spans 100% width of the container when enabled. |
| `invalid` | `` | `false` | When present, it specifies that the component should have invalid state style. |

| Output | Type | Description |
| --- | --- | --- |
| `onResize` | `EventEmitter<Event \| {}>` | Callback to invoke on textarea resize. |

# tieredmenu

```ts
import { … } from '@anguless/angulux/tieredmenu';
```

## TieredMenuSub

`agl-tieredMenuSub, agl-tieredmenusub` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `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>` |  |

## TieredMenu

`agl-tieredMenu, agl-tieredmenu, agl-tiered-menu` — component

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` | `string` | _not documented_ | Transition options of the show animation. **Deprecated:** since v21.0.0, use `motionOptions` instead. |
| `hideTransitionOptions` | `string` | _not documented_ | Transition options of the hide animation. **Deprecated:** since v21.0.0, use `motionOptions` instead. |
| `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. |

# timeline

```ts
import { … } from '@anguless/angulux/timeline';
```

## Timeline

`agl-timeline` — component

Timeline visualizes a series of chained events.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `value` | `any[] \| undefined` | _not documented_ | An array of events to display. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `align` | `string` | _not documented_ | Position of the timeline bar relative to the content. Valid values are "left", "right" for vertical layout and "top", "bottom" for horizontal layout. |
| `layout` | `'vertical' \| 'horizontal'` | _not documented_ | Orientation of the timeline. |

# toast

```ts
import { … } from '@anguless/angulux/toast';
```

## ToastItem

`agl-toastItem` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `message` | `ToastMessageOptions \| null \| undefined` | _not documented_ |  |
| `index` | `number \| null \| undefined` | _not documented_ |  |
| `life` | `number` | _not documented_ |  |
| `template` | `TemplateRef<ToastMessageTemplateContext> \| undefined` | _not documented_ |  |
| `headlessTemplate` | `TemplateRef<ToastHeadlessTemplateContext> \| undefined` | _not documented_ |  |
| `showTransformOptions` | `string \| undefined` | _not documented_ |  |
| `hideTransformOptions` | `string \| undefined` | _not documented_ |  |
| `showTransitionOptions` | `string \| undefined` | _not documented_ |  |
| `hideTransitionOptions` | `string \| undefined` | _not documented_ |  |
| `motionOptions` | `MotionOptions` | _not documented_ |  |
| `clearAll` | `any` | _not documented_ |  |

| Output | Type | Description |
| --- | --- | --- |
| `onAnimationStart` | `HTMLElement` |  |
| `onAnimationEnd` | `HTMLElement` |  |
| `onClose` | `EventEmitter<ToastItemCloseEvent>` |  |

## Toast

`agl-toast` — component

Toast is used to display messages in an overlay.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `key` | `string \| undefined` | _not documented_ | Key of the message in case message is targeted to a specific toast component. |
| `autoZIndex` | `boolean` | _not documented_ | Whether to automatically manage layering. |
| `baseZIndex` | `number` | _not documented_ | Base zIndex value to use in layering. |
| `life` | `number` | _not documented_ | The default time to display messages for in milliseconds. |
| `styleClass` | `string \| undefined` | _not documented_ | Inline class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `position` | `ToastPositionType` | _not documented_ | Position of the toast in viewport. |
| `preventOpenDuplicates` | `boolean` | _not documented_ | It does not add the new message if there is already a toast displayed with the same content |
| `preventDuplicates` | `boolean` | _not documented_ | Displays only once a message with the same content. |
| `showTransformOptions` | `string` | _not documented_ | Transform options of the show animation. **Deprecated:** since v21.0.0. Use `motionOptions` instead. |
| `hideTransformOptions` | `string` | _not documented_ | Transform options of the hide animation. **Deprecated:** since v21.0.0. Use `motionOptions` instead. |
| `showTransitionOptions` | `string` | _not documented_ | Transition options of the show animation. **Deprecated:** since v21.0.0. Use `motionOptions` instead. |
| `hideTransitionOptions` | `string` | _not documented_ | Transition options of the hide animation. **Deprecated:** since v21.0.0. Use `motionOptions` instead. |
| `motionOptions` | `MotionOptions \| undefined` | _not documented_ | The motion options. |
| `breakpoints` | `{ [key: string]: any } \| undefined` | _not documented_ | Object literal to define styles per screen size. |

| Output | Type | Description |
| --- | --- | --- |
| `onClose` | `EventEmitter<ToastCloseEvent>` | Callback to invoke when a message is closed. |

# togglebutton

```ts
import { … } from '@anguless/angulux/togglebutton';
```

## ToggleButton

`agl-toggleButton, agl-togglebutton, agl-toggle-button` — component

ToggleButton is used to select a boolean value using a button.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `onLabel` | `string` | _not documented_ | Label for the on state. |
| `offLabel` | `string` | _not documented_ | Label for the off state. |
| `onIcon` | `string \| undefined` | _not documented_ | Icon for the on state. |
| `offIcon` | `string \| undefined` | _not documented_ | Icon for the off state. |
| `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. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the element. **Deprecated:** since v20.0.0, use `class` instead. |
| `inputId` | `string \| undefined` | _not documented_ | Identifier of the focus input to match a label defined for the component. |
| `tabindex` | `number \| undefined` | _not documented_ | Index of the element in tabbing order. |
| `iconPos` | `'left' \| 'right'` | _not documented_ | Position of the icon. |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |
| `size` | `'large' \| 'small'` | _not documented_ | Defines the size of the component. |
| `allowEmpty` | `boolean \| undefined` | _not documented_ | Whether selection can not be cleared. |
| `fluid` | `` | `undefined` | Spans 100% width of the container when enabled. |

| Output | Type | Description |
| --- | --- | --- |
| `onChange` | `EventEmitter<ToggleButtonChangeEvent>` | Callback to invoke on value change. |

# toggleswitch

```ts
import { … } from '@anguless/angulux/toggleswitch';
```

## ToggleSwitch

`agl-toggleswitch, agl-toggleSwitch, agl-toggle-switch` — component

ToggleSwitch is used to select a boolean value.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `tabindex` | `number \| undefined` | _not documented_ | Index of the element in tabbing order. |
| `inputId` | `string \| undefined` | _not documented_ | Identifier of the input element. |
| `readonly` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component cannot be edited. |
| `trueValue` | `any` | _not documented_ | Value in checked state. |
| `falseValue` | `any` | _not documented_ | Value in unchecked state. |
| `ariaLabel` | `string \| undefined` | _not documented_ | Used to define a string that autocomplete attribute the current element. |
| `size` | `'large' \| 'small' \| undefined` | `undefined` | Specifies the size of the component. |
| `ariaLabelledBy` | `string \| undefined` | _not documented_ | Establishes relationships between the component and label(s) where its value should be one or more element IDs. |
| `autofocus` | `boolean \| undefined` | _not documented_ | When present, it specifies that the component should automatically get focus on load. |

| Output | Type | Description |
| --- | --- | --- |
| `onChange` | `EventEmitter<ToggleSwitchChangeEvent>` | Callback to invoke when the on value change. |

# tooltip

```ts
import { … } from '@anguless/angulux/tooltip';
```

## Tooltip

`[aglTooltip]` — directive

Tooltip directive provides advisory information for a component.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `tooltipPosition` | `'right' \| 'left' \| 'top' \| 'bottom' \| string \| undefined` | _not documented_ | Position of the tooltip. |
| `tooltipEvent` | `'hover' \| 'focus' \| 'both'` | _not documented_ | Event to show the tooltip. |
| `positionStyle` | `string \| undefined` | _not documented_ | Type of CSS position. |
| `tooltipStyleClass` | `string \| undefined` | _not documented_ | Style class of the tooltip. |
| `tooltipZIndex` | `string \| undefined` | _not documented_ | Whether the z-index should be managed automatically to always go on top or have a fixed value. |
| `escape` | `boolean` | _not documented_ | By default the tooltip contents are rendered as text. Set to false to support html tags in the content. |
| `showDelay` | `number \| undefined` | _not documented_ | Delay to show the tooltip in milliseconds. |
| `hideDelay` | `number \| undefined` | _not documented_ | Delay to hide the tooltip in milliseconds. |
| `life` | `number \| undefined` | _not documented_ | Time to wait in milliseconds to hide the tooltip even it is active. |
| `positionTop` | `number \| undefined` | _not documented_ | Specifies the additional vertical offset of the tooltip from its default position. |
| `positionLeft` | `number \| undefined` | _not documented_ | Specifies the additional horizontal offset of the tooltip from its default position. |
| `autoHide` | `boolean` | _not documented_ | Whether to hide tooltip when hovering over tooltip content. |
| `fitContent` | `boolean` | _not documented_ | Automatically adjusts the element position when there is not enough space on the selected position. |
| `hideOnEscape` | `boolean` | _not documented_ | Whether to hide tooltip on escape key press. |
| `showOnEllipsis` | `boolean` | _not documented_ | Whether to show the tooltip only when the target text overflows (e.g., ellipsis is active). |
| `content` | `string \| TemplateRef<HTMLElement> \| undefined` | _not documented_ | Content of the tooltip. |
| `disabled` | `boolean` | `false` | When present, it specifies that the component should be disabled. |
| `tooltipOptions` | `TooltipOptions \| undefined` | _not documented_ | Specifies the tooltip configuration options for 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). |
| `ptTooltip` | `TooltipPassThrough \| undefined` | `undefined` | Used to pass attributes to DOM elements inside the Tooltip component. **Deprecated:** use pTooltipPT instead. |
| `pTooltipPT` | `TooltipPassThrough \| undefined` | `undefined` | Used to pass attributes to DOM elements inside the Tooltip component. |
| `pTooltipUnstyled` | `boolean \| undefined` | `undefined` | Indicates whether the component should be rendered without styles. |

# treetable

```ts
import { … } from '@anguless/angulux/treetable';
```

## TreeTable

`agl-treeTable, agl-treetable, agl-tree-table` — component

TreeTable is used to display hierarchical data in tabular format.

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `columns` | `any[] \| undefined` | _not documented_ | An array of objects to represent dynamic columns. |
| `styleClass` | `string \| undefined` | _not documented_ | Style class of the component. **Deprecated:** since v20.0.0, use `class` instead. |
| `tableStyle` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | Inline style of the table. |
| `tableStyleClass` | `string \| undefined` | _not documented_ | Style class of the table. |
| `autoLayout` | `boolean \| undefined` | _not documented_ | Whether the cell widths scale according to their content or not. |
| `lazy` | `boolean` | _not documented_ | Defines if data is loaded and interacted with in lazy manner. |
| `lazyLoadOnInit` | `boolean` | _not documented_ | Whether to call lazy loading on initialization. |
| `paginator` | `boolean \| undefined` | _not documented_ | When specified as true, enables the pagination. |
| `rows` | `number \| undefined` | _not documented_ | Number of rows to display per page. |
| `first` | `number` | _not documented_ | Index of the first row to be displayed. |
| `pageLinks` | `number` | _not documented_ | Number of page links to display in paginator. |
| `rowsPerPageOptions` | `any[] \| undefined` | _not documented_ | Array of integer/object values to display inside rows per page dropdown of paginator |
| `alwaysShowPaginator` | `boolean` | _not documented_ | Whether to show it even there is only one page. |
| `paginatorPosition` | `'top' \| 'bottom' \| 'both'` | _not documented_ | Position of the paginator. |
| `paginatorStyleClass` | `string \| undefined` | _not documented_ | Custom style class for paginator |
| `paginatorDropdownAppendTo` | `HTMLElement \| ElementRef \| TemplateRef<any> \| string \| null \| undefined \| any` | _not documented_ | Target element to attach the paginator dropdown 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). |
| `currentPageReportTemplate` | `string` | _not documented_ | Template of the current page report element. Available placeholders are {currentPage},{totalPages},{rows},{first},{last} and {totalRecords} |
| `showCurrentPageReport` | `boolean \| undefined` | _not documented_ | Whether to display current page report. |
| `showJumpToPageDropdown` | `boolean \| undefined` | _not documented_ | Whether to display a dropdown to navigate to any page. |
| `showFirstLastIcon` | `boolean` | _not documented_ | When enabled, icons are displayed on paginator to go first and last page. |
| `showPageLinks` | `boolean` | _not documented_ | Whether to show page links. |
| `defaultSortOrder` | `number` | _not documented_ | Sort order to use when an unsorted column gets sorted by user interaction. |
| `sortMode` | `'single' \| 'multiple'` | _not documented_ | Defines whether sorting works on single column or on multiple columns. |
| `resetPageOnSort` | `boolean` | _not documented_ | When true, resets paginator to first page after sorting. |
| `customSort` | `boolean \| undefined` | _not documented_ | Whether to use the default sorting or a custom one using sortFunction. |
| `selectionMode` | `string \| undefined` | _not documented_ | Specifies the selection mode, valid values are "single" and "multiple". |
| `contextMenuSelection` | `any` | _not documented_ | Selected row with a context menu. |
| `contextMenuSelectionMode` | `string` | _not documented_ | Mode of the contet menu selection. |
| `dataKey` | `string \| undefined` | _not documented_ | A property to uniquely identify a record in data. |
| `metaKeySelection` | `boolean \| undefined` | _not documented_ | Defines whether metaKey is should be considered for the selection. On touch enabled devices, metaKeySelection is turned off automatically. |
| `compareSelectionBy` | `string` | _not documented_ | Algorithm to define if a row is selected, valid values are "equals" that compares by reference and "deepEquals" that compares all fields. |
| `rowHover` | `boolean \| undefined` | _not documented_ | Adds hover effect to rows without the need for selectionMode. |
| `loading` | `boolean \| undefined` | _not documented_ | Displays a loader to indicate data load is in progress. |
| `loadingIcon` | `string \| undefined` | _not documented_ | The icon to show while indicating data load is in progress. |
| `showLoader` | `boolean` | _not documented_ | Whether to show the loading mask when loading property is true. |
| `scrollable` | `boolean \| undefined` | _not documented_ | When specified, enables horizontal and/or vertical scrolling. |
| `scrollHeight` | `string \| undefined` | _not documented_ | Height of the scroll viewport in fixed pixels or the "flex" keyword for a dynamic size. |
| `virtualScroll` | `boolean \| undefined` | _not documented_ | Whether the data should be loaded on demand during scroll. |
| `virtualScrollItemSize` | `number \| undefined` | _not documented_ | Height of a row to use in calculations of virtual scrolling. |
| `virtualScrollOptions` | `ScrollerOptions \| undefined` | _not documented_ | Whether to use the scroller feature. The properties of scroller component can be used like an object in it. |
| `virtualScrollDelay` | `number` | _not documented_ | The delay (in milliseconds) before triggering the virtual scroll. This determines the time gap between the user's scroll action and the actual rendering of the next set of items in the virtual scroll. |
| `frozenWidth` | `string \| undefined` | _not documented_ | Width of the frozen columns container. |
| `frozenColumns` | `{ [klass: string]: any } \| null \| undefined` | _not documented_ | An array of objects to represent dynamic columns that are frozen. |
| `resizableColumns` | `boolean \| undefined` | _not documented_ | When enabled, columns can be resized using drag and drop. |
| `columnResizeMode` | `string` | _not documented_ | Defines whether the overall table width should change on column resize, valid values are "fit" and "expand". |
| `reorderableColumns` | `boolean \| undefined` | _not documented_ | When enabled, columns can be reordered using drag and drop. |
| `contextMenu` | `any` | _not documented_ | Local ng-template varilable of a ContextMenu. |
| `rowTrackBy` | `Function` | _not documented_ | Function to optimize the dom operations by delegating to ngForTrackBy, default algorithm checks for object identity. |
| `filters` | `{ [s: string]: FilterMetadata \| undefined }` | _not documented_ | An array of FilterMetadata objects to provide external filters. |
| `globalFilterFields` | `string[] \| undefined` | _not documented_ | An array of fields as string to use in global filtering. |
| `filterDelay` | `number` | _not documented_ | Delay in milliseconds before filtering the data. |
| `filterMode` | `string` | _not documented_ | Mode for filtering valid values are "lenient" and "strict". Default is lenient. |
| `filterLocale` | `string \| undefined` | _not documented_ | Locale to use in filtering. The default locale is the host environment's current locale. |
| `paginatorLocale` | `string \| undefined` | _not documented_ | Locale to be used in paginator formatting. |
| `totalRecords` | `number` | _not documented_ | Number of total records, defaults to length of value when not defined. |
| `sortField` | `string \| undefined \| null` | _not documented_ | Name of the field to sort data by default. |
| `sortOrder` | `number` | `1` | Order to sort when default sorting is enabled. |
| `multiSortMeta` | `SortMeta[] \| undefined \| null` | `null` | An array of SortMeta objects to sort the data by default in multiple sort mode. |
| `selection` | `any` | `null` | Selected row in single mode or an array of values in multiple mode. |
| `value` | `TreeNode<any>[] \| undefined` | `null` | An array of objects to display. |
| `virtualRowHeight` | `number` | `28` | Indicates the height of rows to be scrolled. **Deprecated:** use virtualScrollItemSize property instead. |
| `selectionKeys` | `any` | _not documented_ | A map of keys to control the selection state. |
| `showGridlines` | `boolean` | `false` | Whether to show grid lines between cells. |

| Output | Type | Description |
| --- | --- | --- |
| `selectionChange` | `EventEmitter<TreeTableNode<any> \| TreeTableNode<any>[] \| null>` | Callback to invoke on selected node change. |
| `contextMenuSelectionChange` | `EventEmitter<TreeTableNode>` | Callback to invoke on context menu selection change. |
| `onFilter` | `EventEmitter<TreeTableFilterEvent>` | Callback to invoke when data is filtered. |
| `onNodeExpand` | `EventEmitter<TreeTableNodeExpandEvent>` | Callback to invoke when a node is expanded. |
| `onNodeCollapse` | `EventEmitter<TreeTableNodeCollapseEvent>` | Callback to invoke when a node is collapsed. |
| `onPage` | `EventEmitter<TreeTablePaginatorState>` | Callback to invoke when pagination occurs. |
| `onSort` | `EventEmitter<any>` | Callback to invoke when a column gets sorted. |
| `onLazyLoad` | `EventEmitter<TreeTableLazyLoadEvent>` | Callback to invoke when paging, sorting or filtering happens in lazy mode. |
| `sortFunction` | `EventEmitter<TreeTableSortEvent>` | An event emitter to invoke on custom sorting, refer to sorting section for details. |
| `onColResize` | `EventEmitter<TreeTableColResizeEvent>` | Callback to invoke when a column is resized. |
| `onColReorder` | `EventEmitter<TreeTableColumnReorderEvent>` | Callback to invoke when a column is reordered. |
| `onNodeSelect` | `EventEmitter<TreeTableNode>` | Callback to invoke when a node is selected. |
| `onNodeUnselect` | `EventEmitter<TreeTableNodeUnSelectEvent>` | Callback to invoke when a node is unselected. |
| `onContextMenuSelect` | `EventEmitter<TreeTableContextMenuSelectEvent>` | Callback to invoke when a node is selected with right click. |
| `onHeaderCheckboxToggle` | `EventEmitter<TreeTableHeaderCheckboxToggleEvent>` | Callback to invoke when state of header checkbox changes. |
| `onEditInit` | `EventEmitter<TreeTableEditEvent>` | Callback to invoke when a cell switches to edit mode. |
| `onEditComplete` | `EventEmitter<TreeTableEditEvent>` | Callback to invoke when cell edit is completed. |
| `onEditCancel` | `EventEmitter<TreeTableEditEvent>` | Callback to invoke when cell edit is cancelled with escape key. |
| `selectionKeysChange` | `EventEmitter<any>` | Callback to invoke when selectionKeys are changed. |

## TTBody

`[aglTreeTableBody]` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `columns` | `any[] \| undefined` | _not documented_ |  |
| `template` | `Nullable<TemplateRef<any>>` | _not documented_ |  |
| `frozen` | `boolean \| undefined` | _not documented_ |  |
| `serializedNodes` | `any` | _not documented_ |  |
| `scrollerOptions` | `any` | _not documented_ |  |

## TTScrollableView

`[ttScrollableView]` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `columns` | `any[] \| undefined` | _not documented_ |  |
| `frozen` | `boolean \| undefined` | _not documented_ |  |
| `scrollHeight` | `string \| undefined \| null` | _not documented_ |  |

## TTSortableColumn

`[ttSortableColumn]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `field` | `string \| undefined` | _not documented_ |  |
| `ttSortableColumnDisabled` | `boolean \| undefined` | _not documented_ |  |

## TTSortIcon

`agl-treeTableSortIcon, agl-treetable-sort-icon, agl-tree-table-sort-icon` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `field` | `string \| undefined` | _not documented_ |  |
| `ariaLabelDesc` | `string \| undefined` | _not documented_ |  |
| `ariaLabelAsc` | `string \| undefined` | _not documented_ |  |

## TTResizableColumn

`[ttResizableColumn]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `ttResizableColumnDisabled` | `boolean \| undefined` | _not documented_ |  |

## TTReorderableColumn

`[ttReorderableColumn]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `ttReorderableColumnDisabled` | `boolean \| undefined` | _not documented_ |  |

## TTSelectableRow

`[ttSelectableRow]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `rowNode` | `any` | _not documented_ |  |
| `ttSelectableRowDisabled` | `boolean \| undefined` | _not documented_ |  |

## TTSelectableRowDblClick

`[ttSelectableRowDblClick]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `rowNode` | `any` | _not documented_ |  |
| `ttSelectableRowDisabled` | `boolean \| undefined` | _not documented_ |  |

## TTContextMenuRow

`[ttContextMenuRow]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `rowNode` | `any \| undefined` | _not documented_ |  |
| `ttContextMenuRowDisabled` | `boolean \| undefined` | _not documented_ |  |

## TTCheckbox

`agl-treeTableCheckbox, agl-treetable-checkbox, agl-tree-table-checkbox` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `disabled` | `boolean \| undefined` | _not documented_ |  |
| `rowNode` | `any` | _not documented_ |  |

## TTHeaderCheckbox

`agl-treeTableHeaderCheckbox` — component

## TTEditableColumn

`[ttEditableColumn]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `data` | `any` | _not documented_ |  |
| `field` | `any` | _not documented_ |  |
| `ttEditableColumnDisabled` | `boolean \| undefined` | _not documented_ |  |

## TreeTableCellEditor

`agl-treeTableCellEditor, agl-treetablecelleditor, agl-treetable-cell-editor` — component

## TTRow

`[ttRow]` — directive

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `rowNode` | `any` | _not documented_ |  |

## TreeTableToggler

`agl-treeTableToggler, agl-treetabletoggler, agl-treetable-toggler` — component

| Input | Type | Default | Description |
| --- | --- | --- | --- |
| `rowNode` | `any` | _not documented_ |  |

# ts-helpers

```ts
import { … } from '@anguless/angulux/ts-helpers';
```

This module declares no component or directive. It is internal infrastructure that other
modules depend on, and there is nothing here to use directly.

# types

```ts
import { … } from '@anguless/angulux/types';
```

This module declares no component or directive. It is internal infrastructure that other
modules depend on, and there is nothing here to use directly.

# usestyle

```ts
import { … } from '@anguless/angulux/usestyle';
```

This module declares no component or directive. It is internal infrastructure that other
modules depend on, and there is nothing here to use directly.

# utils

```ts
import { … } from '@anguless/angulux/utils';
```

This module declares no component or directive. It is internal infrastructure that other
modules depend on, and there is nothing here to use directly.