@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
43 lines (42 loc) • 2.02 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { Alignment } from "../interfaces.js";
/**
* @cssproperty [--calcite-table-header-background] - [Deprecated] Use the `--calcite-table-header-background-color` property instead. Specifies the component's background color.
* @cssproperty [--calcite-table-header-background-color] - Specifies the component's background color.
* @cssproperty [--calcite-table-header-border-color] - Specifies the component's border color.
* @cssproperty [--calcite-table-header-heading-text-color] - Specifies the component's `heading` text color.
* @cssproperty [--calcite-table-header-description-text-color] - Specifies the component's `description` text color.
*/
export abstract class TableHeader extends LitElement {
/**
* Specifies the alignment of the component.
*
* @default "start"
*/
accessor alignment: Alignment;
/** Specifies the number of columns the component should span. */
accessor colSpan: number;
/** Specifies a description for the component. Displays below the `heading`. */
accessor description: string;
/** Specifies the component's heading text. Displays above the `description`. */
accessor heading: string;
/** Overrides individual strings used by the component. */
accessor messageOverrides: {
all?: string;
keyboardDeselectAll?: string;
keyboardSelectAll?: string;
rowNumber?: string;
selected?: string;
selectionColumn?: string;
};
/** Specifies the number of rows the component should span. */
accessor rowSpan: number;
/**
* 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>;
}