LiInputComponent class

Mixed-in types
Annotations
  • @Component.new(selector: 'li-input', templateUrl: 'input_component.html', styleUrls: ['input_component.css'], directives: [coreDirectives], providers: [ExistingProvider.forToken(ngValueAccessor, LiInputComponent)], changeDetection: ChangeDetectionStrategy.onPush)

Constructors

LiInputComponent(HtmlElement _hostElement, ChangeDetectorRef _changeDetectorRef, [@Optional.new() LiFormDirective? _formDirective])

Properties

allowNegative ↔ bool
Whether a leading - can be typed in a numeric valueType.
getter/setter pair
ariaLabel ↔ String
getter/setter pair
autocapitalize ↔ String
getter/setter pair
autocomplete ↔ String
getter/setter pair
autocorrect ↔ String
getter/setter pair
containerClass ↔ String
getter/setter pair
currentValue → String
no setter
data1pIgnore ↔ String
getter/setter pair
dataBwignore ↔ String
getter/setter pair
dataInvalid ↔ bool
External invalid state, same as invalid.
getter/setter pairinherited
dataLpignore ↔ String
getter/setter pair
decimalPlaces ↔ int?
Maximum number of digits after the decimal separator when valueType is decimal. null (default) does not limit them; 0 blocks the separator. Ignored for other value types.
getter/setter pair
disabled ↔ bool
getter/setter pair
effectiveAutoInvalid → bool
Whether the automatic validation failed and is visible.
no setterinherited
effectiveAutoValid → bool
Whether the automatic validation passed, has rules and is visible.
no setterinherited
effectiveErrorText → String
errorText first, then the legacy invalidFeedbackText while the field is invalid, then the message of the automatic validation.
no setteroverride
effectiveHtmlType → String
no setter
effectiveInvalid → bool
Also invalid while the host carries is-invalid or data-invalid.
no setteroverride
effectiveMask → String
no setter
effectiveMaxLength → int?
no setter
effectiveMessages → Map<String, String>
Messages in effect since the last rebuildValidationConfig.
no setterinherited
effectiveMinLength → int?
no setter
effectiveRequired → bool
no setter
effectiveRules → List<LiRule>
Rules in effect since the last rebuildValidationConfig.
no setterinherited
effectiveValid → bool
Valid state painted by the field.
no setterinherited
enterKeyHint ↔ String
getter/setter pair
errorText ↔ String
getter/setter pair
externalErrorText → String
External error message, typically from the backend. Wins over the message of the automatic validation.
no setteroverride
externalValid → bool
An is-valid class set on the host.
no setteroverride
floatingLabel ↔ bool
getter/setter pair
formSubmitted → bool
Whether the enclosing liForm was submitted.
no setterinherited
hasAddons → bool
no setter
hasCustomMaskFormatter → bool
no setter
hasExplicitSuffix → bool
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasLabel → bool
no setter
hasMask → bool
no setter
hasPrefix → bool
no setter
hasSuffix → bool
no setter
helperClass ↔ String
getter/setter pair
helperText ↔ String
getter/setter pair
hidePasswordLabel ↔ String
getter/setter pair
hostClass → bool
no setter
hostTabIndex → String
no setter
id ↔ String
getter/setter pair
inputBlur → Stream<Event>
no setter
inputClass ↔ String
getter/setter pair
inputClick → Stream<MouseEvent>
no setter
inputElement ↔ Element?
getter/setter pair
inputEnter → Stream<KeyboardEvent>
no setter
inputFocus → Stream<Event>
no setter
inputKeydown → Stream<KeyboardEvent>
no setter
inputMode ↔ String
getter/setter pair
invalid ↔ bool
External invalid state, typically from the backend. Wins over the automatic validation.
getter/setter pairinherited
invalidFeedbackClass ↔ String
getter/setter pair
invalidFeedbackText ↔ String
getter/setter pair
isInvalid → bool
no setter
isNumeric → bool
Whether valueType is integer or decimal.
no setter
isValid → bool
no setter
label ↔ String
getter/setter pair
labelClass ↔ String
getter/setter pair
liInputType ↔ LiInputType?
getter/setter pair
liMessages ↔ Map<String, String>
Per-field message overrides keyed by rule code.
getter/setter pairinherited
liRules ↔ List<LiRule>
Declarative rules evaluated against validationValue.
getter/setter pairinherited
liType ↔ String
getter/setter pair
liValidationMode ↔ String
When the automatic validation becomes visible.
getter/setter pairinherited
locale ↔ String
Locale of the default rule messages and, with a numeric valueType, of the decimal separator typed and displayed in the field.
getter/setter pairoverride-getter
mask ↔ String
getter/setter pair
maskFormatter ↔ LiInputMaskFormatter?
getter/setter pair
maskSlot ↔ String
getter/setter pair
max ↔ String
getter/setter pair
maxLength ↔ int
getter/setter pair
min ↔ String
getter/setter pair
minLength ↔ int
getter/setter pair
multiline ↔ bool
getter/setter pair
name ↔ String?
getter/setter pair
numericValue → num?
Value held by the model in a numeric valueType: int, double or null. Always null in text mode.
no setter
passwordToggle ↔ bool
getter/setter pair
passwordToggleAriaLabel → String
no setter
passwordToggleIconClass → String
no setter
passwordToggleOverlay ↔ bool
getter/setter pair
passwordVisible → bool
no setter
pattern ↔ String
getter/setter pair
placeholder ↔ String
getter/setter pair
prefixIconClass ↔ String
getter/setter pair
prefixText ↔ String
getter/setter pair
readonly ↔ bool
getter/setter pair
required ↔ bool
getter/setter pair
resolvedAriaInvalid → String?
Value of aria-invalid.
no setterinherited
resolvedAriaLabel → String?
no setter
resolvedAutocapitalize → String?
no setter
resolvedAutocomplete → String?
no setter
resolvedAutocorrect → String?
no setter
resolvedBaseType → String
no setter
resolvedContainerClass → String
no setter
resolvedData1pIgnore → String?
no setter
resolvedDataBwignore → String?
no setter
resolvedDataInvalidAttr → String?
Value of data-invalid, the attribute liForm looks for.
no setterinherited
resolvedDataLpignore → String?
no setter
resolvedEnterKeyHint → String?
no setter
resolvedHelperClass → String
no setter
resolvedId → String
no setter
resolvedInputClass → String
no setter
resolvedInputGroupClass → String
no setter
resolvedInputMode → String?
no setter
resolvedInvalidFeedbackClass → String
no setter
resolvedInvalidFeedbackText → String
no setter
resolvedLabelClass → String
no setter
resolvedLiInputType → LiInputType?
no setter
resolvedMax → String?
no setter
resolvedMaxLength → int?
no setter
resolvedMin → String?
no setter
resolvedMinLength → int?
no setter
resolvedName → String?
no setter
resolvedPattern → String?
no setter
resolvedPlaceholder → String
no setter
resolvedRows → int
no setter
resolvedSpellcheck → String?
no setter
resolvedStep → String?
no setter
resolvedTitleText → String?
no setter
resolvedType → String
no setter
resolvedValidFeedbackClass → String
no setter
resolvedValueType → String
Normalized valueType: text, integer or decimal.
no setter
rows ↔ int
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shouldRevalidate → bool
Whether a change of the value should run the rules again: always with validateOnInput, otherwise only while the result is visible or a failure is pending.
no setterinherited
shouldShowValidation → bool
Whether liValidationMode lets the automatic validation show now.
no setterinherited
showErrorFeedback → bool
Whether the error message is rendered.
no setterinherited
showHelperText → bool
no setter
showInvalidFeedback → bool
no setter
showPasswordLabel ↔ String
getter/setter pair
showsAddonPasswordToggle → bool
no setter
showsPasswordToggle → bool
no setter
showTopLabel → bool
no setter
showValidFeedback → bool
no setter
size ↔ String
getter/setter pair
spellcheck ↔ String
getter/setter pair
step ↔ String
getter/setter pair
suffixIconClass ↔ String
getter/setter pair
suffixText ↔ String
getter/setter pair
titleText ↔ String
getter/setter pair
type ↔ String
getter/setter pair
usesFloatingLabel → bool
no setter
usesOverlayPasswordToggle → bool
no setter
validateOnInput ↔ bool
Whether the rules run again on every change of the value, even before the result is visible.
getter/setter pairinherited
validationDirty ↔ bool
Whether the user changed the value at least once.
getter/setter pairinherited
validationFieldName → String?
Field name handed to the rules through LiRuleContext.fieldName.
no setteroverride
validationInputType → Object?
Field preset handed to the rules through LiRuleContext.inputType.
no setteroverride
validationIssue → LiValidationIssue?
Result of the last runValidation: the first failing rule, or null.
no setterinherited
validationTouched ↔ bool
Whether the field lost focus at least once.
getter/setter pairinherited
validationValue → dynamic
The number in a numeric valueType; otherwise the text, normalized by the field preset when there is one.
no setteroverride
validator ↔ LiInputValidator?
getter/setter pair
validFeedbackClass ↔ String
getter/setter pair
validFeedbackText ↔ String
getter/setter pair
valueType ↔ String
Type of the value the model receives.
getter/setter pair

Methods

buildValidationMessages() → Map<String, String>
Messages in effect, rebuilt by rebuildValidationConfig.
override
buildValidationRules() → List<LiRule>
Preset rules, then the rules derived from required, minLength, maxLength, pattern and the numeric min/max, then liRules, then the legacy validator.
override
connectValidationForm(LiFormDirective? form) → void
Reads the submission state of form and follows its changes.
inherited
didChangeFormSubmission() → void
Called after the submission state of the enclosing liForm changed and the rules ran again.
override
didRunValidation() → void
Called at the end of every runValidation.
override
disconnectValidationForm() → void
Stops following the enclosing liForm. Call it in ngOnDestroy.
inherited
handleBlur(Event event) → void
handleClick(MouseEvent event) → void
handleFocus(Event event) → void
handleHostFocus() → void
handleInput(String value) → void
handleKeydown(Event event) → void
handlePasswordToggleMouseDown(MouseEvent event) → void
ngAfterChanges() → void
ngAfterViewInit() → void
ngOnDestroy() → void
Executed before the directive is removed from the DOM and destroyed.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onDisabledChanged(bool isDisabled) → void
This function is called when the control status changes to or from "DISABLED".
rebuildValidationConfig() → void
Rebuilds effectiveRules and effectiveMessages from the inputs.
inherited
registerOnChange(ChangeFunction fn) → void
Set the function to be called when the control receives a change event.
registerOnTouched(TouchFunction fn) → void
Set the function to be called when the control is touched.
runValidation() → void
Runs effectiveRules against validationValue and stores the result in validationIssue.
inherited
togglePasswordVisibility() → void
toString() → String
A string representation of this object.
inherited
writeValue(dynamic value) → void
Write a new value to the element.

Operators

operator ==(Object other) → bool
The equality operator.
inherited