@anguless/angulux/baseinput

baseinput

1 declarations

import

// baseinput exports standalone symbols — import them by name from '@anguless/angulux/baseinput/<name>'

No demos for this module yet. The API reference below is complete: it comes from the corpus, which covers every module the library ships.

API

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

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. A list of regular expressions — what Signal Forms binds through `[formField]` — is ignored, because the form validates those itself.
min	number \| null \| undefined	undefined	The value must be greater than or equal to the value. A numeric string is read as a number; anything else that is not a finite number, such as the `Date` limit of a date field, is ignored.
max	number \| null \| undefined	undefined	The value must be less than or equal to the value. A numeric string is read as a number; anything else that is not a finite number, such as the `Date` limit of a date field, is ignored.
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.

inherited

Input	Type	Default	Description
required		false	There must be a value (if set). Left unbound, a control bound through `formControlName`, `[formControl]` or `ngModel` is required when that control carries `Validators.required` or `Validators.requiredTrue`.
invalid		false	When present, it specifies that the component should have invalid state style. Left unbound, a control bound through `formControlName`, `[formControl]` or `ngModel` shows the state of that control once it is touched or dirty.
touched	boolean \| undefined	undefined	Whether the user has visited the control. Once this or `dirty` is set, the invalid state style waits for interaction: it appears when the control is touched or dirty. Signal Forms' `[formField]` sets both, so an untouched required field is not shown as invalid. Leave both unset and `invalid` alone decides.
dirty	boolean \| undefined	undefined	Whether the user has changed the value. See `touched`.
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.

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.