@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
100 lines (99 loc) • 4.38 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { Layout, Scale, SelectionMode } from "../interfaces.js";
import type { FlipPlacement, LogicalPlacement, OverlayPositioning } from "../../utils/floating-ui.js";
import type { Columns } from "./interfaces.js";
/**
* @cssproperty [--calcite-action-background-color] - Specifies the component's background color.
* @cssproperty [--calcite-action-group-border-color] - Specifies the component's border color when used in a `calcite-action-bar` or `calcite-action-menu`.
* @cssproperty [--calcite-action-group-columns] - When `layout` is `"grid"`, specifies the component's `grid-template-columns`.
* @cssproperty [--calcite-action-group-gap] - When `layout` is `"grid"`, specifies the component's gap.
* @slot - A slot for adding `calcite-action`s.
* @slot [menu-actions] - A slot for adding an overflow menu with `calcite-action`s inside a `calcite-dropdown`.
* @slot [menu-tooltip] - A slot for adding a `calcite-tooltip` for the menu.
*/
export abstract class ActionGroup extends LitElement {
/** Specifies the number of columns. */
accessor columns: Columns;
/**
* When `true`, expands the component and its contents.
*
* @default false
*/
accessor expanded: boolean;
/** Specifies an accessible label for the component. */
accessor label: string;
/**
* Indicates the layout of the component.
*
* @default "vertical"
* @internal
*/
accessor layout: Extract<"horizontal" | "vertical" | "grid", Layout>;
/** Specifies the component's fallback `menuPlacement` when it's initial or specified `menuPlacement` has insufficient space available. */
accessor menuFlipPlacements: FlipPlacement[];
/**
* When `true`, the `calcite-action-menu` is open.
*
* @default false
*/
accessor menuOpen: boolean;
/** Specifies the position of the action menu. */
accessor menuPlacement: LogicalPlacement;
/** Overrides individual strings used by the component. */
accessor messageOverrides: { more?: 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 size of the `calcite-action-menu`.
*
* @default "m"
*/
accessor scale: Scale;
/**
* 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"` disables selection (default).
*
* @default "none"
*/
accessor selectionMode: Extract<"single" | "single-persist" | "multiple" | "none", SelectionMode>;
/**
* When `true` and the component is `open`, disables top layer placement.
*
* Only set this if you need complex z-index control or if top layer placement causes conflicts with third-party components.
*
* @default false
* @mdn [Top Layer](https://developer.mozilla.org/en-US/docs/Glossary/Top_layer)
*/
accessor topLayerDisabled: boolean;
/**
* 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 calciteActionGroupCollapse: import("@arcgis/lumina").TargetedEvent<this, void>;
/** Fires when the component's content area is expanded. */
readonly calciteActionGroupExpand: import("@arcgis/lumina").TargetedEvent<this, void>;
readonly "@eventTypes": {
calciteActionGroupCollapse: ActionGroup["calciteActionGroupCollapse"]["detail"];
calciteActionGroupExpand: ActionGroup["calciteActionGroupExpand"]["detail"];
};
}