@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
83 lines (82 loc) • 3.68 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { FlipContext, Scale, Status } from "../interfaces.js";
import type { IconName } from "../calcite-icon/interfaces.js";
import type { BlockSectionToggleDisplay } from "./interfaces.js";
/**
* @cssproperty [--calcite-block-section-background-color] - Specifies the component's background color.
* @cssproperty [--calcite-block-section-border-color] - Specifies the component's border color. When `expanded`, applies to the component's bottom border.
* @cssproperty [--calcite-block-section-header-text-color] - Specifies the component's header text color.
* @cssproperty [--calcite-block-section-text-color] - Specifies the component's text color.
* @cssproperty [--calcite-block-section-text-color-hover] - Specifies the component's text color on hover.
* @cssproperty [--calcite-block-section-content-space] - Specifies the padding of the component's content in `default` slot.
* @slot - A slot for adding custom content.
*/
export abstract class BlockSection extends LitElement {
/**
* When `true`, expands the component and its contents.
*
* @default false
*/
accessor expanded: boolean;
/** Specifies an icon to display at the end of the component. */
accessor iconEnd: IconName;
/** Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). */
accessor iconFlipRtl: FlipContext;
/** Specifies an icon to display at the start of the component. */
accessor iconStart: IconName;
/** Overrides individual strings used by the component. */
accessor messageOverrides: {
collapse?: string;
expand?: string;
};
/**
* When `true`, expands the component and its contents.
*
* @deprecated in v3.1.0, removal target v6.0.0 - Use `expanded` prop instead.
* @default false
*/
accessor open: boolean;
/**
* Specifies the size of the component.
*
* @default "m"
*/
accessor scale: Scale;
/**
* Displays a status-related indicator icon.
*
* @deprecated in v2.8.1, removal target v6.0.0 - Use `icon-start` instead.
*/
accessor status: Status;
/** The component header text. */
accessor text: string;
/**
* Specifies how the component's toggle is displayed, where:
*
* `"button"` sets the toggle to a selectable header, and
*
* `"switch"` sets the toggle to a switch.
*
* @default "button"
*/
accessor toggleDisplay: BlockSectionToggleDisplay;
/**
* Sets focus on the component's first tabbable 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 content area is collapsed. */
readonly calciteBlockSectionCollapse: import("@arcgis/lumina").TargetedEvent<this, void>;
/** Fires when the component's content area is expanded. */
readonly calciteBlockSectionExpand: import("@arcgis/lumina").TargetedEvent<this, void>;
/** Fires when the header has been clicked. */
readonly calciteBlockSectionToggle: import("@arcgis/lumina").TargetedEvent<this, void>;
readonly "@eventTypes": {
calciteBlockSectionCollapse: BlockSection["calciteBlockSectionCollapse"]["detail"];
calciteBlockSectionExpand: BlockSection["calciteBlockSectionExpand"]["detail"];
calciteBlockSectionToggle: BlockSection["calciteBlockSectionToggle"]["detail"];
};
}