@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
54 lines (53 loc) • 1.95 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { Scale, SelectionMode } from "../interfaces.js";
import type { Chip } from "../calcite-chip/customElement.js";
/** @slot - A slot for adding one or more `calcite-chip`s. */
export abstract class ChipGroup extends LitElement {
/**
* When `true`, interaction is prevented and the component is displayed with lower opacity.
*
* @default false
*/
accessor disabled: boolean;
/**
* Specifies an accessible label for the component.
*
* @required
*/
accessor label: string;
/**
* Specifies the size of the component. Child `calcite-chip`s inherit the component's value.
*
* @default "m"
*/
accessor scale: Scale;
/** Specifies the component's selected items. */
get selectedItems(): Chip[];
/**
* Specifies the selection mode of the component, where:
*
* `"multiple"` allows any number of selections,
*
* `"single"` allows only one selection,
*
* `"single-persist"` allows one selection and prevents de-selection, and
*
* `"none"` does not allow any selections.
*
* @default "none"
*/
accessor selectionMode: Extract<"multiple" | "single" | "single-persist" | "none", SelectionMode>;
/**
* Sets focus on the component's first focusable element.
*
* @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 selection changes. */
readonly calciteChipGroupSelect: import("@arcgis/lumina").TargetedEvent<this, void>;
readonly "@eventTypes": {
calciteChipGroupSelect: ChipGroup["calciteChipGroupSelect"]["detail"];
};
}