@angular/material 14.0.0-next.9 → 14.0.0-rc.2

package/checkbox/index.d.ts

@@ -1,8 +1,279 @@
+import { _AbstractConstructor } from '@angular/material/core';
+import { AfterViewInit } from '@angular/core';
+import { BooleanInput } from '@angular/cdk/coercion';
+import { CanColor } from '@angular/material/core';
+import { CanDisable } from '@angular/material/core';
+import { CanDisableRipple } from '@angular/material/core';
+import { ChangeDetectorRef } from '@angular/core';
+import { CheckboxRequiredValidator } from '@angular/forms';
+import { _Constructor } from '@angular/material/core';
+import { ControlValueAccessor } from '@angular/forms';
+import { ElementRef } from '@angular/core';
+import { EventEmitter } from '@angular/core';
+import { FocusableOption } from '@angular/cdk/a11y';
+import { FocusMonitor } from '@angular/cdk/a11y';
+import { FocusOrigin } from '@angular/cdk/a11y';
+import { HasTabIndex } from '@angular/material/core';
+import * as i0 from '@angular/core';
+import * as i3 from '@angular/material/core';
+import * as i4 from '@angular/cdk/observers';
+import { InjectionToken } from '@angular/core';
+import { MatRipple } from '@angular/material/core';
+import { NgZone } from '@angular/core';
+import { OnDestroy } from '@angular/core';
+import { Provider } from '@angular/core';
+import { ThemePalette } from '@angular/material/core';
+
+declare namespace i1 {
+    export {
+        MAT_CHECKBOX_REQUIRED_VALIDATOR,
+        MatCheckboxRequiredValidator
+    }
+}
+
+declare namespace i2 {
+    export {
+        MAT_CHECKBOX_CONTROL_VALUE_ACCESSOR,
+        TransitionCheckState,
+        MatCheckboxChange,
+        _MatCheckboxBase,
+        MatCheckbox
+    }
+}
+
 /**
- * @license
- * Copyright Google LLC All Rights Reserved.
- *
- * Use of this source code is governed by an MIT-style license that can be
- * found in the LICENSE file at https://angular.io/license
+ * Provider Expression that allows mat-checkbox to register as a ControlValueAccessor.
+ * This allows it to support [(ngModel)].
+ * @docs-private
  */
-export * from './public-api';
+export declare const MAT_CHECKBOX_CONTROL_VALUE_ACCESSOR: any;
+
+/** Injection token to be used to override the default options for `mat-checkbox`. */
+export declare const MAT_CHECKBOX_DEFAULT_OPTIONS: InjectionToken<MatCheckboxDefaultOptions>;
+
+/** @docs-private */
+export declare function MAT_CHECKBOX_DEFAULT_OPTIONS_FACTORY(): MatCheckboxDefaultOptions;
+
+export declare const MAT_CHECKBOX_REQUIRED_VALIDATOR: Provider;
+
+/**
+ * A material design checkbox component. Supports all of the functionality of an HTML5 checkbox,
+ * and exposes a similar API. A MatCheckbox can be either checked, unchecked, indeterminate, or
+ * disabled. Note that all additional accessibility attributes are taken care of by the component,
+ * so there is no need to provide them yourself. However, if you want to omit a label and still
+ * have the checkbox be accessible, you may supply an [aria-label] input.
+ * See: https://material.io/design/components/selection-controls.html
+ */
+export declare class MatCheckbox extends _MatCheckboxBase<MatCheckboxChange> implements AfterViewInit, OnDestroy {
+    private _focusMonitor;
+    protected _animationClasses: {
+        uncheckedToChecked: string;
+        uncheckedToIndeterminate: string;
+        checkedToUnchecked: string;
+        checkedToIndeterminate: string;
+        indeterminateToChecked: string;
+        indeterminateToUnchecked: string;
+    };
+    constructor(elementRef: ElementRef<HTMLElement>, changeDetectorRef: ChangeDetectorRef, _focusMonitor: FocusMonitor, ngZone: NgZone, tabIndex: string, animationMode?: string, options?: MatCheckboxDefaultOptions);
+    protected _createChangeEvent(isChecked: boolean): MatCheckboxChange;
+    protected _getAnimationTargetElement(): any;
+    ngAfterViewInit(): void;
+    ngOnDestroy(): void;
+    /**
+     * Event handler for checkbox input element.
+     * Toggles checked state if element is not disabled.
+     * Do not toggle on (change) event since IE doesn't fire change event when
+     *   indeterminate checkbox is clicked.
+     * @param event
+     */
+    _onInputClick(event: Event): void;
+    /** Focuses the checkbox. */
+    focus(origin?: FocusOrigin, options?: FocusOptions): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatCheckbox, [null, null, null, null, { attribute: "tabindex"; }, { optional: true; }, { optional: true; }]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MatCheckbox, "mat-checkbox", ["matCheckbox"], { "disableRipple": "disableRipple"; "color": "color"; "tabIndex": "tabIndex"; }, {}, never, ["*"], false>;
+}
+
+export declare abstract class _MatCheckboxBase<E> extends _MatCheckboxMixinBase implements AfterViewInit, ControlValueAccessor, CanColor, CanDisable, HasTabIndex, CanDisableRipple, FocusableOption {
+    protected _changeDetectorRef: ChangeDetectorRef;
+    protected _ngZone: NgZone;
+    _animationMode?: string | undefined;
+    protected _options?: MatCheckboxDefaultOptions | undefined;
+    /** Focuses the checkbox. */
+    abstract focus(origin?: FocusOrigin): void;
+    /** Creates the change event that will be emitted by the checkbox. */
+    protected abstract _createChangeEvent(isChecked: boolean): E;
+    /** Gets the element on which to add the animation CSS classes. */
+    protected abstract _getAnimationTargetElement(): HTMLElement | null;
+    /** CSS classes to add when transitioning between the different checkbox states. */
+    protected abstract _animationClasses: {
+        uncheckedToChecked: string;
+        uncheckedToIndeterminate: string;
+        checkedToUnchecked: string;
+        checkedToIndeterminate: string;
+        indeterminateToChecked: string;
+        indeterminateToUnchecked: string;
+    };
+    /**
+     * Attached to the aria-label attribute of the host element. In most cases, aria-labelledby will
+     * take precedence so this may be omitted.
+     */
+    ariaLabel: string;
+    /**
+     * Users can specify the `aria-labelledby` attribute which will be forwarded to the input element
+     */
+    ariaLabelledby: string | null;
+    /** The 'aria-describedby' attribute is read after the element's label and field type. */
+    ariaDescribedby: string;
+    private _uniqueId;
+    /** A unique id for the checkbox input. If none is supplied, it will be auto-generated. */
+    id: string;
+    /** Returns the unique id for the visual hidden input. */
+    get inputId(): string;
+    /** Whether the checkbox is required. */
+    get required(): boolean;
+    set required(value: BooleanInput);
+    private _required;
+    /** Whether the label should appear after or before the checkbox. Defaults to 'after' */
+    labelPosition: 'before' | 'after';
+    /** Name value will be applied to the input element if present */
+    name: string | null;
+    /** Event emitted when the checkbox's `checked` value changes. */
+    readonly change: EventEmitter<E>;
+    /** Event emitted when the checkbox's `indeterminate` value changes. */
+    readonly indeterminateChange: EventEmitter<boolean>;
+    /** The value attribute of the native input element */
+    value: string;
+    /** The native `<input type="checkbox">` element */
+    _inputElement: ElementRef<HTMLInputElement>;
+    /** Reference to the ripple instance of the checkbox. */
+    ripple: MatRipple;
+    /**
+     * Called when the checkbox is blurred. Needed to properly implement ControlValueAccessor.
+     * @docs-private
+     */
+    _onTouched: () => any;
+    private _currentAnimationClass;
+    private _currentCheckState;
+    private _controlValueAccessorChangeFn;
+    constructor(idPrefix: string, elementRef: ElementRef<HTMLElement>, _changeDetectorRef: ChangeDetectorRef, _ngZone: NgZone, tabIndex: string, _animationMode?: string | undefined, _options?: MatCheckboxDefaultOptions | undefined);
+    ngAfterViewInit(): void;
+    /** Whether the checkbox is checked. */
+    get checked(): boolean;
+    set checked(value: BooleanInput);
+    private _checked;
+    /**
+     * Whether the checkbox is disabled. This fully overrides the implementation provided by
+     * mixinDisabled, but the mixin is still required because mixinTabIndex requires it.
+     */
+    get disabled(): boolean;
+    set disabled(value: BooleanInput);
+    private _disabled;
+    /**
+     * Whether the checkbox is indeterminate. This is also known as "mixed" mode and can be used to
+     * represent a checkbox with three states, e.g. a checkbox that represents a nested list of
+     * checkable items. Note that whenever checkbox is manually clicked, indeterminate is immediately
+     * set to false.
+     */
+    get indeterminate(): boolean;
+    set indeterminate(value: BooleanInput);
+    private _indeterminate;
+    _isRippleDisabled(): boolean;
+    /** Method being called whenever the label text changes. */
+    _onLabelTextChange(): void;
+    writeValue(value: any): void;
+    registerOnChange(fn: (value: any) => void): void;
+    registerOnTouched(fn: any): void;
+    setDisabledState(isDisabled: boolean): void;
+    _getAriaChecked(): 'true' | 'false' | 'mixed';
+    private _transitionCheckState;
+    private _emitChangeEvent;
+    /** Toggles the `checked` state of the checkbox. */
+    toggle(): void;
+    protected _handleInputClick(): void;
+    _onInteractionEvent(event: Event): void;
+    _onBlur(): void;
+    private _getAnimationClassForCheckStateTransition;
+    /**
+     * Syncs the indeterminate value with the checkbox DOM node.
+     *
+     * We sync `indeterminate` directly on the DOM node, because in Ivy the check for whether a
+     * property is supported on an element boils down to `if (propName in element)`. Domino's
+     * HTMLInputElement doesn't have an `indeterminate` property so Ivy will warn during
+     * server-side rendering.
+     */
+    private _syncIndeterminate;
+    static ɵfac: i0.ɵɵFactoryDeclaration<_MatCheckboxBase<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<_MatCheckboxBase<any>, never, never, { "ariaLabel": "aria-label"; "ariaLabelledby": "aria-labelledby"; "ariaDescribedby": "aria-describedby"; "id": "id"; "required": "required"; "labelPosition": "labelPosition"; "name": "name"; "value": "value"; "checked": "checked"; "disabled": "disabled"; "indeterminate": "indeterminate"; }, { "change": "change"; "indeterminateChange": "indeterminateChange"; }, never, never, false>;
+}
+
+/** Change event object emitted by MatCheckbox. */
+export declare class MatCheckboxChange {
+    /** The source MatCheckbox of the event. */
+    source: MatCheckbox;
+    /** The new `checked` value of the checkbox. */
+    checked: boolean;
+}
+
+/**
+ * Checkbox click action when user click on input element.
+ * noop: Do not toggle checked or indeterminate.
+ * check: Only toggle checked status, ignore indeterminate.
+ * check-indeterminate: Toggle checked status, set indeterminate to false. Default behavior.
+ * undefined: Same as `check-indeterminate`.
+ */
+export declare type MatCheckboxClickAction = 'noop' | 'check' | 'check-indeterminate' | undefined;
+
+/** Default `mat-checkbox` options that can be overridden. */
+export declare interface MatCheckboxDefaultOptions {
+    /** Default theme color palette to be used for checkboxes. */
+    color?: ThemePalette;
+    /** Default checkbox click action for checkboxes. */
+    clickAction?: MatCheckboxClickAction;
+}
+
+/** @docs-private */
+declare const _MatCheckboxMixinBase: _Constructor<HasTabIndex> & _AbstractConstructor<HasTabIndex> & _Constructor<CanColor> & _AbstractConstructor<CanColor> & _Constructor<CanDisableRipple> & _AbstractConstructor<CanDisableRipple> & _Constructor<CanDisable> & _AbstractConstructor<CanDisable> & {
+    new (_elementRef: ElementRef): {
+        _elementRef: ElementRef;
+    };
+};
+
+export declare class MatCheckboxModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatCheckboxModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<MatCheckboxModule, [typeof i2.MatCheckbox], [typeof i3.MatRippleModule, typeof i3.MatCommonModule, typeof i4.ObserversModule, typeof _MatCheckboxRequiredValidatorModule], [typeof i2.MatCheckbox, typeof i3.MatCommonModule, typeof _MatCheckboxRequiredValidatorModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<MatCheckboxModule>;
+}
+
+/**
+ * Validator for Material checkbox's required attribute in template-driven checkbox.
+ * Current CheckboxRequiredValidator only work with `input type=checkbox` and does not
+ * work with `mat-checkbox`.
+ */
+export declare class MatCheckboxRequiredValidator extends CheckboxRequiredValidator {
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatCheckboxRequiredValidator, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatCheckboxRequiredValidator, "mat-checkbox[required][formControlName],             mat-checkbox[required][formControl], mat-checkbox[required][ngModel]", never, {}, {}, never, never, false>;
+}
+
+/** This module is used by both original and MDC-based checkbox implementations. */
+export declare class _MatCheckboxRequiredValidatorModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<_MatCheckboxRequiredValidatorModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<_MatCheckboxRequiredValidatorModule, [typeof i1.MatCheckboxRequiredValidator], never, [typeof i1.MatCheckboxRequiredValidator]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<_MatCheckboxRequiredValidatorModule>;
+}
+
+/**
+ * Represents the different states that require custom transitions between them.
+ * @docs-private
+ */
+export declare const enum TransitionCheckState {
+    /** The initial state of the component before any user interaction. */
+    Init = 0,
+    /** The state representing the component when it's becoming checked. */
+    Checked = 1,
+    /** The state representing the component when it's becoming unchecked. */
+    Unchecked = 2,
+    /** The state representing the component when it's becoming indeterminate. */
+    Indeterminate = 3
+}
+
+export { }

package/checkbox/testing/index.d.ts

@@ -1,8 +1,91 @@
-/**
- * @license
- * Copyright Google LLC All Rights Reserved.
- *
- * Use of this source code is governed by an MIT-style license that can be
- * found in the LICENSE file at https://angular.io/license
- */
-export * from './public-api';
+import { AsyncFactoryFn } from '@angular/cdk/testing';
+import { BaseHarnessFilters } from '@angular/cdk/testing';
+import { ComponentHarness } from '@angular/cdk/testing';
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { TestElement } from '@angular/cdk/testing';
+
+/** A set of criteria that can be used to filter a list of `MatCheckboxHarness` instances. */
+export declare interface CheckboxHarnessFilters extends BaseHarnessFilters {
+    /** Only find instances whose label matches the given value. */
+    label?: string | RegExp;
+    /** Only find instances whose name attribute is the given value. */
+    name?: string;
+    /** Only find instances with the given checked value. */
+    checked?: boolean;
+}
+
+/** Harness for interacting with a standard mat-checkbox in tests. */
+export declare class MatCheckboxHarness extends _MatCheckboxHarnessBase {
+    /** The selector for the host element of a `MatCheckbox` instance. */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a `MatCheckboxHarness` that meets
+     * certain criteria.
+     * @param options Options for filtering which checkbox instances are considered a match.
+     * @return a `HarnessPredicate` configured with the given options.
+     */
+    static with(options?: CheckboxHarnessFilters): HarnessPredicate<MatCheckboxHarness>;
+    protected _input: AsyncFactoryFn<TestElement>;
+    protected _label: AsyncFactoryFn<TestElement>;
+    private _inputContainer;
+    toggle(): Promise<void>;
+}
+
+export declare abstract class _MatCheckboxHarnessBase extends ComponentHarness {
+    protected abstract _input: AsyncFactoryFn<TestElement>;
+    protected abstract _label: AsyncFactoryFn<TestElement>;
+    /** Whether the checkbox is checked. */
+    isChecked(): Promise<boolean>;
+    /** Whether the checkbox is in an indeterminate state. */
+    isIndeterminate(): Promise<boolean>;
+    /** Whether the checkbox is disabled. */
+    isDisabled(): Promise<boolean>;
+    /** Whether the checkbox is required. */
+    isRequired(): Promise<boolean>;
+    /** Whether the checkbox is valid. */
+    isValid(): Promise<boolean>;
+    /** Gets the checkbox's name. */
+    getName(): Promise<string | null>;
+    /** Gets the checkbox's value. */
+    getValue(): Promise<string | null>;
+    /** Gets the checkbox's aria-label. */
+    getAriaLabel(): Promise<string | null>;
+    /** Gets the checkbox's aria-labelledby. */
+    getAriaLabelledby(): Promise<string | null>;
+    /** Gets the checkbox's label text. */
+    getLabelText(): Promise<string>;
+    /** Focuses the checkbox. */
+    focus(): Promise<void>;
+    /** Blurs the checkbox. */
+    blur(): Promise<void>;
+    /** Whether the checkbox is focused. */
+    isFocused(): Promise<boolean>;
+    /**
+     * Toggles the checked state of the checkbox.
+     *
+     * Note: This attempts to toggle the checkbox as a user would, by clicking it. Therefore if you
+     * are using `MAT_CHECKBOX_DEFAULT_OPTIONS` to change the behavior on click, calling this method
+     * might not have the expected result.
+     */
+    abstract toggle(): Promise<void>;
+    /**
+     * Puts the checkbox in a checked state by toggling it if it is currently unchecked, or doing
+     * nothing if it is already checked.
+     *
+     * Note: This attempts to check the checkbox as a user would, by clicking it. Therefore if you
+     * are using `MAT_CHECKBOX_DEFAULT_OPTIONS` to change the behavior on click, calling this method
+     * might not have the expected result.
+     */
+    check(): Promise<void>;
+    /**
+     * Puts the checkbox in an unchecked state by toggling it if it is currently checked, or doing
+     * nothing if it is already unchecked.
+     *
+     * Note: This attempts to uncheck the checkbox as a user would, by clicking it. Therefore if you
+     * are using `MAT_CHECKBOX_DEFAULT_OPTIONS` to change the behavior on click, calling this method
+     * might not have the expected result.
+     */
+    uncheck(): Promise<void>;
+}
+
+export { }