index.api.md

API Report File for "@angular/material_form-field"

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 { BooleanInput } from '@angular/cdk/coercion';
import { ElementRef } from '@angular/core';
import * as i0 from '@angular/core';
import * as i1 from '@angular/cdk/bidi';
import * as i2 from '@angular/cdk/observers';
import { InjectionToken } from '@angular/core';
import { NgControl } from '@angular/forms';
import { Observable } from 'rxjs';
import { OnDestroy } from '@angular/core';
import { QueryList } from '@angular/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(...args: unknown[]);
    // (undocumented)
    id: string;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatError, "mat-error, [matError]", never, { "id": { "alias": "id"; "required": false; }; }, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatError, never>;
}

// @public
export class MatFormField implements FloatingLabelParent, AfterContentInit, AfterContentChecked, AfterViewInit, OnDestroy {
    constructor(...args: unknown[]);
    _animateAndLockLabel(): void;
    // (undocumented)
    protected readonly _animationsDisabled: boolean;
    get appearance(): MatFormFieldAppearance;
    set appearance(value: MatFormFieldAppearance);
    color: ThemePalette;
    get _control(): MatFormFieldControl_2<any>;
    set _control(value: MatFormFieldControl_2<any>);
    // (undocumented)
    _elementRef: ElementRef<any>;
    // (undocumented)
    _errorChildren: QueryList<MatError>;
    // (undocumented)
    _floatingLabel: MatFormFieldFloatingLabel | undefined;
    get floatLabel(): FloatLabelType;
    set floatLabel(value: FloatLabelType);
    _forceDisplayInfixLabel(): boolean | 0;
    // (undocumented)
    _formFieldControl: MatFormFieldControl_2<any>;
    getConnectedOverlayOrigin(): ElementRef;
    getLabelId: i0.Signal<string | null>;
    _getSubscriptMessageType(): 'error' | 'hint';
    _handleLabelResized(): void;
    // (undocumented)
    _hasFloatingLabel: i0.Signal<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)
    _iconSuffixContainer: ElementRef<HTMLElement>;
    // (undocumented)
    readonly _labelId: string;
    // (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;
    get subscriptSizing(): SubscriptSizing;
    set subscriptSizing(value: SubscriptSizing);
    // (undocumented)
    _suffixChildren: QueryList<MatSuffix>;
    // (undocumented)
    _textField: ElementRef<HTMLElement>;
    // (undocumented)
    _textPrefixContainer: ElementRef<HTMLElement>;
    // (undocumented)
    _textSuffixContainer: ElementRef<HTMLElement>;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatFormField, "mat-form-field", ["matFormField"], { "hideRequiredMarker": { "alias": "hideRequiredMarker"; "required": false; }; "color": { "alias": "color"; "required": false; }; "floatLabel": { "alias": "floatLabel"; "required": false; }; "appearance": { "alias": "appearance"; "required": false; }; "subscriptSizing": { "alias": "subscriptSizing"; "required": false; }; "hintLabel": { "alias": "hintLabel"; "required": false; }; }, {}, ["_labelChild", "_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']"], true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatFormField, never>;
}

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

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

// @public
export abstract class MatFormFieldControl<T> {
    readonly autofilled?: boolean;
    readonly controlType?: string;
    readonly disableAutomaticLabeling?: boolean;
    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, true, 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, never, [typeof MatCommonModule, typeof i2.ObserversModule, typeof MatFormField, typeof MatLabel, typeof MatError, typeof MatHint, typeof MatPrefix, typeof MatSuffix], [typeof MatFormField, typeof MatLabel, typeof MatHint, typeof MatError, typeof MatPrefix, typeof MatSuffix, typeof MatCommonModule]>;
}

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

// @public
export class MatLabel {
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatLabel, "mat-label", never, {}, {}, never, never, true, 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": { "alias": "matTextPrefix"; "required": false; }; }, {}, never, never, true, 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": { "alias": "matTextSuffix"; "required": false; }; }, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatSuffix, never>;
}

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

// (No @packageDocumentation comment for this package)