@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
76 lines (75 loc) • 3.84 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { LogicalFlowPosition } from "../interfaces.js";
/**
* @cssproperty [--calcite-card-accent-color-selected] - Specifies the component's accent color when `selected`.
* @cssproperty [--calcite-card-background-color] - Specifies the component's background color.
* @cssproperty [--calcite-card-border-color] - Specifies the component's border color.
* @cssproperty [--calcite-card-corner-radius] - Specifies the component's corner radius.
* @cssproperty [--calcite-card-selection-background-color-hover] - Specifies the component's selection element background color when hovered.
* @cssproperty [--calcite-card-selection-background-color-press] - Specifies the component's selection element background color when active.
* @cssproperty [--calcite-card-selection-background-color] - [Deprecated] Use `--calcite-card-background-color`. Specifies the component's selection element background color.
* @cssproperty [--calcite-card-selection-color-hover] - Specifies the component's selection element color when hovered or focused.
* @cssproperty [--calcite-card-selection-color] - Specifies the component's selection element color.
* @cssproperty [--calcite-card-selection-icon-color-hover] - [Deprecated] Use `--calcite-card-selection-color-hover`. Specifies the component's selection element icon color when hovered.
* @cssproperty [--calcite-card-selection-icon-color-selected] - [Deprecated] Use `--calcite-card-accent-color-selected`. Specifies the component's selection element icon color when `selected`.
* @cssproperty [--calcite-card-shadow] - Specifies the component's shadow.
* @slot - A slot for adding content.
* @slot [thumbnail] - A slot for adding a thumbnail.
* @slot [heading] - A slot for adding a heading.
* @slot [description] - A slot for adding a description.
* @slot [footer-start] - A slot for adding a leading footer.
* @slot [footer-end] - A slot for adding a trailing footer.
*/
export abstract class Card 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. */
accessor label: string;
/**
* When `true`, a busy indicator is displayed.
*
* @default false
*/
accessor loading: boolean;
/** Overrides individual strings used by the component. */
accessor messageOverrides: {
select?: string;
loading?: string;
};
/**
* When `true`, the component is selectable.
*
* @deprecated in v3.0.0, removal target v6.0.0 - Use the `selectionMode` property on a parent `calcite-card-group` instead.
* @default false
*/
accessor selectable: boolean;
/**
* When `true`, the component is selected.
*
* @default false
*/
accessor selected: boolean;
/**
* Sets the placement of the thumbnail defined in the `thumbnail` slot.
*
* @default "block-start"
*/
accessor thumbnailPosition: LogicalFlowPosition;
/**
* 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 deprecated `selectable` is true, or `selectionMode` set on parent `calcite-card-group` is not `none` and the component is selected. */
readonly calciteCardSelect: import("@arcgis/lumina").TargetedEvent<this, void>;
readonly "@eventTypes": {
calciteCardSelect: Card["calciteCardSelect"]["detail"];
};
}