@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
88 lines (87 loc) • 3.35 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { MutableValidityState } from "../../utils/form.js";
import type { Scale, Status } from "../interfaces.js";
/**
* @cssproperty [--calcite-checkbox-size] - Specifies the component's height and width.
* @cssproperty [--calcite-checkbox-border-color] - Specifies the component's color.
* @cssproperty [--calcite-checkbox-border-color-hover] - Specifies the component's color when hovered.
* @cssproperty [--calcite-checkbox-border-color-press] - Specifies the component's color when pressed.
* @cssproperty [--calcite-checkbox-icon-color] - Specifies the component's icon color.
*/
export abstract class Checkbox extends LitElement {
/**
* When `true`, the component is checked.
*
* @default false
*/
accessor checked: boolean;
/**
* When `true`, interaction is prevented and the component is displayed with lower opacity.
*
* @default false
*/
accessor disabled: boolean;
/**
* Specifies the `id` of the component's associated form.
*
* When not set, the component is associated with its ancestor form element, if one exists.
*/
accessor form: string;
/**
* When `true`, the component is initially indeterminate, which is independent from its `checked` value.
*
* The state is visual only, and can look different across browsers.
*
* @default false
* @mdn [indeterminate](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes)
*/
accessor indeterminate: boolean;
/** Specifies an accessible label for the component. */
accessor label: string;
/** Specifies the component's label text. */
accessor labelText: string;
/** Overrides individual strings used by the component. */
accessor messageOverrides: { required?: string; };
/** Specifies the name of the component. Required to pass the component's `value` on form submission. */
accessor name: string;
/**
* When `true` and the component resides in a form,
* the component must have a value in order for the form to submit.
*
* @default false
*/
accessor required: boolean;
/**
* Specifies the size of the component.
*
* @default "m"
*/
accessor scale: Scale;
/**
* Specifies the status of the input field, which determines message and icons.
*
* @default "idle"
*/
accessor status: Status;
/**
* The component's current validation state.
*
* @mdn [ValidityState](https://developer.mozilla.org/en-US/docs/Web/API/ValidityState)
*/
get validity(): MutableValidityState;
/** The component's value. */
accessor value: any;
/**
* Sets focus on the component.
*
* @param options - When specified an optional object customizes the component's focusing process. When `preventScroll` is `true`, scrolling will not occur on the component.
* @mdn [focus(options)](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#options)
*/
setFocus(options?: FocusOptions): Promise<void>;
/** Fires when the component's `checked` status changes. */
readonly calciteCheckboxChange: import("@arcgis/lumina").TargetedEvent<this, void>;
readonly "@eventTypes": {
calciteCheckboxChange: Checkbox["calciteCheckboxChange"]["detail"];
};
}