MaterialMultilineInputComponent class
material-input is a multi-line text field where user can enter
input, and can optionally have a label.
- Inheritance
-
- Object
- FocusableMixin
- BaseMaterialInput
- MaterialMultilineInputComponent
- Implemented types
- Annotations
-
- @Component(selector: 'material-input[multiline]', changeDetection: ChangeDetectionStrategy.onPush, providers: [DeferredValidator, ExistingProvider(HasDisabled, MaterialMultilineInputComponent), ExistingProvider.forToken(NG_VALIDATORS, DeferredValidator), ExistingProvider(ReferenceDirective, MaterialMultilineInputComponent), ExistingProvider(Focusable, MaterialMultilineInputComponent), ExistingProvider(BaseMaterialInput, MaterialMultilineInputComponent)], templateUrl: 'material_input_multiline.html', styleUrls: ['material_input.scss.css', 'material_input_multiline.scss.css'], directives: [DefaultValueAccessor, FocusableDirective, NgFor, NgIf, NgModel, NgSwitch, NgSwitchWhen], visibility: Visibility.all)
Constructors
- MaterialMultilineInputComponent(@Self() @Optional() NgControl? cd, ChangeDetectorRef changeDetector, DeferredValidator validator, DomService _domService)
Properties
- ariaDescribedBy ↔ String?
-
Controls the aria-describedby attribute on the input element.
getter/setter pairinherited
- ariaLabel → String?
-
no setterinherited
- bottomPanelState ↔ BottomPanelState
-
Controls what section of the BottomPanel is displayed.
getter/setter pairinherited
- characterCounter ← Function?
-
A custom character counter function.
no getterinherited
- checkValid ↔ ValidityCheck
-
getter/setter pairinherited
- disabled ↔ bool
-
Whether or not this input is disabled (readonly input.)
getter/setter pairinherited
- displayBottomPanel ↔ bool
-
Whether to display error, hint text, and character counter panel.
getter/setter pairinherited
- elementRef → Element?
-
Container element for popup positioning.
no setteroverride
- emptyState → BottomPanelState
-
Template accessors for the BottomPanelState
finalinherited
- error ↔ String?
-
Error to be displayed.
getter/setter pairinherited
- errorMessage → String?
-
no setterinherited
- errorMsg ↔ String?
-
The error msg to be shown on the input if it has more than maxCount
characters.
getter/setter pairinherited
- errorRenderer ↔ ErrorFn?
-
A function which takes in an error map, and returns another map, replacing
errors with human readable text.
getter/setter pairinherited
- errorState → BottomPanelState
-
finalinherited
- errorTextId → String
-
finalinherited
- floatingLabel ↔ bool
-
Whether or not the label "floats".
getter/setter pairinherited
- floatingLabelVisible → bool
-
Whether the floating label is visible.
no setterinherited
- focusable ← Focusable?
-
no getterinherited
- focused ↔ bool
-
Whether the input box is focused.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasVisibleText → bool
-
no setterinherited
- hintState → BottomPanelState
-
finalinherited
- hintText ↔ String?
-
The hint to be shown on the input.
getter/setter pairinherited
- inputAriaDescribedBy ↔ String?
-
The ID of an element which should be assigned to the inner input element's
aria-describedby attribute.
getter/setter pairoverride-setter
- inputAriaLabel ↔ String?
-
The label to be used for assistive technologies.
getter/setter pairinherited
- inputAutocomplete ↔ String?
-
The autocomplete attribute for the inner input element.
getter/setter pairinherited
- inputRef → HtmlElement?
-
The underlying
no setteroverride
- inputTabIndex → int
-
Textarea element tabindex.
no setter
- inputText ↔ String
-
getter/setter pairinherited
- inputTextLength → int
-
no setterinherited
- invalid → bool
-
no setterinherited
- label ↔ String?
-
The label for this input.
getter/setter pairinherited
- labelAnimated → bool
-
Whether the floating label is animated to float above the input box.
no setterinherited
- labelAnimationReset → bool
-
Whether to reverse the animation of the label floating above.
no setterinherited
- labelVisible → bool
-
no setterinherited
- lineHeightMeasure ← Element?
-
no getter
- maxCount ↔ int
-
Maximum allowed characters for character counting input box.
getter/setter pairinherited
- maxInputHeight → int?
-
no setter
- maxRows ↔ int
-
Maximum number of lines to display.
getter/setter pair
- minInputHeight → int
-
no setter
- mirrorText → String
-
Text used to size the multiline textarea.
no setter
-
onBlur
→ Stream<
FocusEvent> -
Publishes events when a blur event is fired.
no setterinherited
-
onChange
→ Stream<
String?> -
Publishes events when a change event is fired. (On enter, or on blur.)
no setterinherited
-
onFocus
→ Stream<
FocusEvent> -
Event when the element is focused.
no setterinherited
-
onKeypress
→ Stream<
String> -
Publishes events whenever input text changes (each keypress).
no setterinherited
- popupSourceEl ↔ Element?
-
getter/setter pair
- required ↔ bool
-
Whether or not the input is required.
getter/setter pairinherited
- requiredErrorMsg ↔ String
-
Custom error message to show when the field is required and blank.
getter/setter pairinherited
- rows ↔ int
-
How many rows the multiline input should have.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showCharacterCount ↔ bool
-
Display character count even if maxCount is null.
getter/setter pairinherited
- showHintOnlyOnFocus ↔ bool
-
Whether or not the hint text will be displayed when the input is not
focused.
getter/setter pairinherited
- textareaEl ↔ HtmlElement?
-
getter/setter pair
- textAreaHeight → int?
-
Sets height of the text area when the height does not change with the
amount of text in it.
no setter
- underlineAnimated → bool
-
Whether underline of the input box is animated.
no setterinherited
- useNativeValidation ↔ bool
-
Enable native validation (e.g. for type="url").
getter/setter pairinherited
Methods
-
call(
AbstractControl _) → Map< String, dynamic> ? -
inherited
-
focus(
) → void -
Item/component focuses itself
override
-
handleChange(
Event event, TextAreaElement element) → void -
handleFocus(
FocusEvent event) → void -
inherited
-
inputBlurAction(
dynamic event, dynamic valid, dynamic validationMessage) → void -
inherited
-
inputChange(
dynamic newValue, dynamic valid, dynamic validationMessage) → void -
inherited
-
inputFocusAction(
dynamic event) → void -
inherited
-
inputKeypress(
dynamic newValue, dynamic valid, dynamic validationMessage) → void -
inherited
-
msgCharacterCounter(
int currentCount, int? maxCount) → String -
The message to display when character counter is shown.
inherited
-
msgCharacterCounterAriaLabel(
int currentCount, int? maxCount) → String -
The aria label to use for the character limit label.
inherited
-
ngAfterViewInit(
) → void -
inherited
-
ngOnDestroy(
) → void -
Executed before the directive is removed from the DOM and destroyed.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
selectAll(
) → void -
Selects all of the input's content.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateBottomPanelState(
) → void -
inherited
-
updateInputTextLength(
) → void -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- hostClass → const String
- hostTabIndex → const int