@anguless/angulux/iconfield
iconfield
1 declarations2 demos
import
import { IconFieldModule } from '@anguless/angulux/iconfield';Basic
IconField wraps an input and an InputIcon so the two line up as one control.
<agl-iconfield> <agl-inputicon class="pi pi-search" /> <input type="text" aglInputText placeholder="Search" /></agl-iconfield>Position
The icon sits wherever it is written, before or after the input.
<agl-iconfield> <agl-inputicon class="pi pi-user" /> <input type="text" aglInputText placeholder="Icon first" /></agl-iconfield><agl-iconfield> <input type="text" aglInputText placeholder="Icon last" /> <agl-inputicon class="pi pi-spin pi-spinner" /></agl-iconfield>API
Generated from the committed corpus, which check:corpus holds to the built library.
IconField
componentagl-iconfield, agl-iconField, agl-icon-fieldIconField wraps an input and an icon.
| Input | Type | Default | Description |
|---|---|---|---|
| hostName | any | not documented | |
| iconPosition | 'right' | 'left' | not documented | Position of the icon. |
| styleClass deprecated — since v20.0.0, use `class` instead. | string | not documented | Style class of the component. |
Inherited from BaseComponent
inherited| Input | Type | Default | Description |
|---|---|---|---|
| dt | Object | undefined | undefined | Defines scoped design tokens of the component. |
| unstyled | boolean | undefined | undefined | Indicates whether the component should be rendered without styles. |
| pt | PT | undefined | undefined | Used to pass attributes to DOM elements inside the component. TRUSTED INPUT ONLY. Whatever you put here is applied to the DOM as given: keys become attributes, and a key that names a DOM property is assigned to that property directly, with no sanitizer in between. That is what makes the API useful, and it means a value reaching it from a user, a database or a CMS can execute script. Treat it like markup you wrote yourself, not like data you received. |
| ptOptions | PassThroughOptions | undefined | undefined | Used to configure passthrough(pt) options of the component. |