You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
173 lines
8.8 KiB
173 lines
8.8 KiB
/**
|
|
* @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
|
|
*/
|
|
import { FocusableOption, FocusMonitor, FocusOrigin } from '@angular/cdk/a11y';
|
|
import { BooleanInput, NumberInput } from '@angular/cdk/coercion';
|
|
import { AfterViewChecked, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnDestroy, AfterViewInit } from '@angular/core';
|
|
import { ControlValueAccessor } from '@angular/forms';
|
|
import { CanColor, CanDisable, CanDisableRipple, HasTabIndex, MatRipple } from '@angular/material/core';
|
|
import { MatCheckboxDefaultOptions } from './checkbox-config';
|
|
/**
|
|
* Provider Expression that allows mat-checkbox to register as a ControlValueAccessor.
|
|
* This allows it to support [(ngModel)].
|
|
* @docs-private
|
|
*/
|
|
import * as ɵngcc0 from '@angular/core';
|
|
export declare const MAT_CHECKBOX_CONTROL_VALUE_ACCESSOR: any;
|
|
/**
|
|
* 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
|
|
}
|
|
/** 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;
|
|
}
|
|
/** @docs-private */
|
|
declare const _MatCheckboxBase: import("@angular/material/core/common-behaviors/constructor").Constructor<HasTabIndex> & import("@angular/material/core/common-behaviors/constructor").AbstractConstructor<HasTabIndex> & import("@angular/material/core/common-behaviors/constructor").Constructor<CanColor> & import("@angular/material/core/common-behaviors/constructor").AbstractConstructor<CanColor> & import("@angular/material/core/common-behaviors/constructor").Constructor<CanDisableRipple> & import("@angular/material/core/common-behaviors/constructor").AbstractConstructor<CanDisableRipple> & import("@angular/material/core/common-behaviors/constructor").Constructor<CanDisable> & import("@angular/material/core/common-behaviors/constructor").AbstractConstructor<CanDisable> & {
|
|
new (_elementRef: ElementRef): {
|
|
_elementRef: ElementRef;
|
|
};
|
|
};
|
|
/**
|
|
* 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 implements ControlValueAccessor, AfterViewInit, AfterViewChecked, OnDestroy, CanColor, CanDisable, HasTabIndex, CanDisableRipple, FocusableOption {
|
|
private _changeDetectorRef;
|
|
private _focusMonitor;
|
|
private _ngZone;
|
|
_animationMode?: string | undefined;
|
|
private _options?;
|
|
/**
|
|
* 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: boolean);
|
|
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<MatCheckboxChange>;
|
|
/** 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(elementRef: ElementRef<HTMLElement>, _changeDetectorRef: ChangeDetectorRef, _focusMonitor: FocusMonitor, _ngZone: NgZone, tabIndex: string, _animationMode?: string | undefined, _options?: MatCheckboxDefaultOptions | undefined);
|
|
ngAfterViewInit(): void;
|
|
ngAfterViewChecked(): void;
|
|
ngOnDestroy(): void;
|
|
/**
|
|
* Whether the checkbox is checked.
|
|
*/
|
|
get checked(): boolean;
|
|
set checked(value: boolean);
|
|
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(): any;
|
|
set disabled(value: any);
|
|
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: boolean);
|
|
private _indeterminate;
|
|
_isRippleDisabled(): any;
|
|
/** 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;
|
|
/**
|
|
* 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;
|
|
_onInteractionEvent(event: Event): 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 ngAcceptInputType_disabled: BooleanInput;
|
|
static ngAcceptInputType_required: BooleanInput;
|
|
static ngAcceptInputType_disableRipple: BooleanInput;
|
|
static ngAcceptInputType_indeterminate: BooleanInput;
|
|
static ngAcceptInputType_tabIndex: NumberInput;
|
|
static ɵfac: ɵngcc0.ɵɵFactoryDeclaration<MatCheckbox, [null, null, null, null, { attribute: "tabindex"; }, { optional: true; }, { optional: true; }]>;
|
|
static ɵcmp: ɵngcc0.ɵɵComponentDeclaration<MatCheckbox, "mat-checkbox", ["matCheckbox"], { "disableRipple": "disableRipple"; "color": "color"; "tabIndex": "tabIndex"; "ariaLabel": "aria-label"; "ariaLabelledby": "aria-labelledby"; "id": "id"; "labelPosition": "labelPosition"; "name": "name"; "required": "required"; "checked": "checked"; "disabled": "disabled"; "indeterminate": "indeterminate"; "ariaDescribedby": "aria-describedby"; "value": "value"; }, { "change": "change"; "indeterminateChange": "indeterminateChange"; }, never, ["*"]>;
|
|
}
|
|
export {};
|
|
|
|
//# sourceMappingURL=checkbox.d.ts.map
|