@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
84 lines (83 loc) • 3.73 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { Layout, Position, Scale, SelectionAppearance } from "../interfaces.js";
import type { OverlayPositioning } from "../../utils/floating-ui.js";
/**
* @deprecated in v5.0.0, removal target v6.0.0 - Use the `calcite-action-bar` component instead.
* @cssproperty [--calcite-action-pad-corner-radius] - Specifies the component's border radius.
* @cssproperty [--calcite-action-pad-expanded-max-width] - When `expanded` and `layout` is `"vertical"`, specifies the component's maximum width.
* @cssproperty [--calcite-action-pad-items-space] - Specifies the component's space between slotted components.
* @slot - A slot for adding `calcite-action`s to the component.
* @slot [expand-tooltip] - A slot to set the `calcite-tooltip` for the expand toggle.
*/
export abstract class ActionPad extends LitElement {
/** Specifies the accessible label for the last `calcite-action-group`. */
accessor actionsEndGroupLabel: string | undefined;
/**
* When `true`, the expand-toggling behavior is disabled.
*
* @default false
*/
accessor expandDisabled: boolean;
/**
* When `true`, expands the component and its contents.
*
* @default false
*/
accessor expanded: boolean;
/**
* Specifies the layout of the component.
*
* @default "vertical"
*/
accessor layout: Extract<"horizontal" | "vertical" | "grid", Layout>;
/** Overrides individual strings used by the component. */
accessor messageOverrides: {
expand?: string;
collapse?: string;
expandLabel?: string;
collapseLabel?: string;
};
/**
* Specifies the type of positioning to use for overlaid content, where:
*
* `"absolute"` works for most cases - positioning the component inside of overflowing parent containers, which affects the container's layout, and
*
* `"fixed"` is used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`.
*
* @default "absolute"
*/
accessor overlayPositioning: OverlayPositioning;
/** Specifies the position of the component depending on the element's `dir` property. */
accessor position: Extract<"start" | "end", Position> | undefined;
/**
* Specifies the size of the expand `calcite-action`.
*
* @default "m"
*/
accessor scale: Scale;
/**
* Specifies the selection appearance of the component
*
* @default "neutral"
*/
accessor selectionAppearance: Extract<"neutral" | "highlight", SelectionAppearance>;
/**
* 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 content area is collapsed. */
readonly calciteActionPadCollapse: import("@arcgis/lumina").TargetedEvent<this, void>;
/** Fires when the component's content area is expanded. */
readonly calciteActionPadExpand: import("@arcgis/lumina").TargetedEvent<this, void>;
/** Fires when the `expanded` property is toggled. */
readonly calciteActionPadToggle: import("@arcgis/lumina").TargetedEvent<this, void>;
readonly "@eventTypes": {
calciteActionPadCollapse: ActionPad["calciteActionPadCollapse"]["detail"];
calciteActionPadExpand: ActionPad["calciteActionPadExpand"]["detail"];
calciteActionPadToggle: ActionPad["calciteActionPadToggle"]["detail"];
};
}