Skip to content

Latest commit

 

History

History
253 lines (227 loc) · 9.56 KB

form-field.md

File metadata and controls

253 lines (227 loc) · 9.56 KB

API Report File for "components-srcs"

Do not edit this file. It is a report generated by API Extractor.

import { AbstractControlDirective } from '@angular/forms';
import { AfterContentChecked } from '@angular/core';
import { AfterContentInit } from '@angular/core';
import { AfterViewInit } from '@angular/core';
import { AnimationTriggerMetadata } from '@angular/animations';
import { BooleanInput } from '@angular/cdk/coercion';
import { ChangeDetectorRef } from '@angular/core';
import { Directionality } from '@angular/cdk/bidi';
import { ElementRef } from '@angular/core';
import * as i0 from '@angular/core';
import * as i10 from '@angular/material/core';
import * as i11 from '@angular/common';
import * as i12 from '@angular/cdk/observers';
import { InjectionToken } from '@angular/core';
import { NgControl } from '@angular/forms';
import { NgZone } from '@angular/core';
import { Observable } from 'rxjs';
import { OnDestroy } from '@angular/core';
import { Platform } from '@angular/cdk/platform';
import { QueryList } from '@angular/core';
import { ThemePalette } from '@angular/material/core';

// @public
export type FloatLabelType = 'always' | 'auto';

// @public
export function getMatFormFieldDuplicatedHintError(align: string): Error;

// @public
export function getMatFormFieldMissingControlError(): Error;

// @public
export function getMatFormFieldPlaceholderConflictError(): Error;

// @public
export const MAT_ERROR: InjectionToken<MatError>;

// @public
export const MAT_FORM_FIELD: InjectionToken<MatFormField>;

// @public
export const MAT_FORM_FIELD_DEFAULT_OPTIONS: InjectionToken<MatFormFieldDefaultOptions>;

// @public
export const MAT_PREFIX: InjectionToken<MatPrefix>;

// @public
export const MAT_SUFFIX: InjectionToken<MatSuffix>;

// @public
export class MatError {
    constructor(ariaLive: string, elementRef: ElementRef);
    // (undocumented)
    id: string;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatError, "mat-error, [matError]", never, { "id": "id"; }, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatError, [{ attribute: "aria-live"; }, null]>;
}

// @public
export class MatFormField implements AfterContentInit, AfterContentChecked, AfterViewInit, OnDestroy {
    constructor(_elementRef: ElementRef, _changeDetectorRef: ChangeDetectorRef, _ngZone: NgZone, _dir: Directionality, _platform: Platform, _defaults?: MatFormFieldDefaultOptions | undefined, _animationMode?: string | undefined, _document?: any);
    _animateAndLockLabel(): void;
    // (undocumented)
    _animationMode?: string | undefined;
    get appearance(): MatFormFieldAppearance;
    set appearance(value: MatFormFieldAppearance);
    color: ThemePalette;
    get _control(): MatFormFieldControl<any>;
    set _control(value: MatFormFieldControl<any>);
    // (undocumented)
    _elementRef: ElementRef;
    // (undocumented)
    _errorChildren: QueryList<MatError>;
    // (undocumented)
    _floatingLabel: MatFormFieldFloatingLabel | undefined;
    get floatLabel(): FloatLabelType;
    set floatLabel(value: FloatLabelType);
    _forceDisplayInfixLabel(): boolean | 0;
    // (undocumented)
    _formFieldControl: MatFormFieldControl<any>;
    getConnectedOverlayOrigin(): ElementRef;
    _getDisplayedMessages(): 'error' | 'hint';
    getLabelId(): string | null;
    // (undocumented)
    _hasFloatingLabel(): boolean;
    // (undocumented)
    _hasIconPrefix: boolean;
    // (undocumented)
    _hasIconSuffix: boolean;
    // (undocumented)
    _hasOutline(): boolean;
    // (undocumented)
    _hasTextPrefix: boolean;
    // (undocumented)
    _hasTextSuffix: boolean;
    get hideRequiredMarker(): boolean;
    set hideRequiredMarker(value: BooleanInput);
    // (undocumented)
    _hintChildren: QueryList<MatHint>;
    get hintLabel(): string;
    set hintLabel(value: string);
    // (undocumented)
    readonly _hintLabelId: string;
    // (undocumented)
    _iconPrefixContainer: ElementRef<HTMLElement>;
    // (undocumented)
    _labelChildNonStatic: MatLabel | undefined;
    // (undocumented)
    _labelChildStatic: MatLabel | undefined;
    // (undocumented)
    readonly _labelId: string;
    _labelWidth: number;
    // (undocumented)
    _lineRipple: MatFormFieldLineRipple | undefined;
    // (undocumented)
    ngAfterContentChecked(): void;
    // (undocumented)
    ngAfterContentInit(): void;
    // (undocumented)
    ngAfterViewInit(): void;
    // (undocumented)
    ngOnDestroy(): void;
    // (undocumented)
    _notchedOutline: MatFormFieldNotchedOutline | undefined;
    // (undocumented)
    _prefixChildren: QueryList<MatPrefix>;
    _refreshOutlineNotchWidth(): void;
    _shouldAlwaysFloat(): boolean;
    _shouldForward(prop: keyof AbstractControlDirective): boolean;
    // (undocumented)
    _shouldLabelFloat(): boolean;
    _subscriptAnimationState: string;
    get subscriptSizing(): SubscriptSizing;
    set subscriptSizing(value: SubscriptSizing);
    // (undocumented)
    _suffixChildren: QueryList<MatSuffix>;
    // (undocumented)
    _textField: ElementRef<HTMLElement>;
    // (undocumented)
    _textPrefixContainer: ElementRef<HTMLElement>;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatFormField, "mat-form-field", ["matFormField"], { "hideRequiredMarker": "hideRequiredMarker"; "color": "color"; "floatLabel": "floatLabel"; "appearance": "appearance"; "subscriptSizing": "subscriptSizing"; "hintLabel": "hintLabel"; }, {}, ["_labelChildNonStatic", "_labelChildStatic", "_formFieldControl", "_prefixChildren", "_suffixChildren", "_errorChildren", "_hintChildren"], ["mat-label", "[matPrefix], [matIconPrefix]", "[matTextPrefix]", "*", "[matTextSuffix]", "[matSuffix], [matIconSuffix]", "mat-error, [matError]", "mat-hint:not([align='end'])", "mat-hint[align='end']"], false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatFormField, [null, null, null, null, null, { optional: true; }, { optional: true; }, null]>;
}

// @public
export const matFormFieldAnimations: {
    readonly transitionMessages: AnimationTriggerMetadata;
};

// @public
export type MatFormFieldAppearance = 'fill' | 'outline';

// @public
export abstract class MatFormFieldControl<T> {
    readonly autofilled?: boolean;
    readonly controlType?: string;
    readonly disabled: boolean;
    readonly empty: boolean;
    readonly errorState: boolean;
    readonly focused: boolean;
    readonly id: string;
    readonly ngControl: NgControl | AbstractControlDirective | null;
    abstract onContainerClick(event: MouseEvent): void;
    readonly placeholder: string;
    readonly required: boolean;
    abstract setDescribedByIds(ids: string[]): void;
    readonly shouldLabelFloat: boolean;
    readonly stateChanges: Observable<void>;
    readonly userAriaDescribedBy?: string;
    value: T | null;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatFormFieldControl<any>, never, never, {}, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatFormFieldControl<any>, never>;
}

// @public
export interface MatFormFieldDefaultOptions {
    appearance?: MatFormFieldAppearance;
    color?: ThemePalette;
    floatLabel?: FloatLabelType;
    hideRequiredMarker?: boolean;
    subscriptSizing?: SubscriptSizing;
}

// @public (undocumented)
export class MatFormFieldModule {
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatFormFieldModule, never>;
    // (undocumented)
    static ɵinj: i0.ɵɵInjectorDeclaration<MatFormFieldModule>;
    // (undocumented)
    static ɵmod: i0.ɵɵNgModuleDeclaration<MatFormFieldModule, [typeof i1.MatFormField, typeof i2.MatLabel, typeof i3.MatError, typeof i4.MatHint, typeof i5.MatPrefix, typeof i6.MatSuffix, typeof i7.MatFormFieldFloatingLabel, typeof i8.MatFormFieldNotchedOutline, typeof i9.MatFormFieldLineRipple], [typeof i10.MatCommonModule, typeof i11.CommonModule, typeof i12.ObserversModule], [typeof i1.MatFormField, typeof i2.MatLabel, typeof i4.MatHint, typeof i3.MatError, typeof i5.MatPrefix, typeof i6.MatSuffix, typeof i10.MatCommonModule]>;
}

// @public
export class MatHint {
    align: 'start' | 'end';
    id: string;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatHint, "mat-hint", never, { "align": "align"; "id": "id"; }, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatHint, never>;
}

// @public
export class MatLabel {
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatLabel, "mat-label", never, {}, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatLabel, never>;
}

// @public
export class MatPrefix {
    // (undocumented)
    _isText: boolean;
    // (undocumented)
    set _isTextSelector(value: '');
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatPrefix, "[matPrefix], [matIconPrefix], [matTextPrefix]", never, { "_isTextSelector": "matTextPrefix"; }, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatPrefix, never>;
}

// @public
export class MatSuffix {
    // (undocumented)
    _isText: boolean;
    // (undocumented)
    set _isTextSelector(value: '');
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatSuffix, "[matSuffix], [matIconSuffix], [matTextSuffix]", never, { "_isTextSelector": "matTextSuffix"; }, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatSuffix, never>;
}

// @public
export type SubscriptSizing = 'fixed' | 'dynamic';

// (No @packageDocumentation comment for this package)