@esri/calcite-components 5.2.0-next.5 → 5.2.0-next.51

package/dist/components/calcite-action-bar/customElement.d.ts

@@ -1,6 +1,6 @@
 /// <reference path="../../index.d.ts" />
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { Layout, Position, Scale, SelectionAppearance } from "../interfaces.js";
+import type { Layout, Position, Scale, SelectionAppearance } from "../types.js";
 import type { OverlayPositioning } from "../../utils/floating-ui.js";
 
 /**
@@ -20,13 +20,16 @@ export abstract class ActionBar extends LitElement {
   /** Specifies an accessible name for the first `calcite-action-group`. */
   accessor actionsStartGroupLabel: string | undefined;
   /**
-   * When `true`, the expand-toggling behavior is disabled.
+   * When `true`, the expand/collapse toggle button is not shown.
    *
+   * @deprecated in v5.2.0, removal target v6.0.0 - Use `expandToggleDisabled` instead.
    * @default false
    */
   accessor expandDisabled: boolean;
   /**
-   * When `true`, expands the component and its contents.
+   * When `true`, expands the component.
+   *
+   * The `expanded` or `textEnabled` state of `calcite-action`, `calcite-action-group`, and `calcite-action-menu` children is synced when this property is toggled, not during initialization.
    * When a child `calcite-action` specifies `textEnabled` as `true`, its `text` initially displays adjacent to its `icon` regardless of expansion.
    *
    * @default false
@@ -38,6 +41,12 @@ export abstract class ActionBar extends LitElement {
    * @default "end"
    */
   accessor expandPosition: Extract<"start" | "end", Position>;
+  /**
+   * When `true`, the expand/collapse toggle button is not shown.
+   *
+   * @default false
+   */
+  accessor expandToggleDisabled: boolean;
   /**
    * When `true`, the component is in a floating state.
    *
@@ -50,34 +59,52 @@ export abstract class ActionBar extends LitElement {
    * @default "vertical"
    */
   accessor layout: Extract<"horizontal" | "vertical" | "grid", Layout>;
-  /** Overrides individual strings used by the component. */
+  /**
+   * Replace localized message strings with your own strings.
+   *
+   * _**Note**: Individual message keys may change between releases._
+   */
   accessor messageOverrides: {
-      expand?: string;
-      collapse?: string;
-      expandLabel?: string;
-      collapseLabel?: string;
+      expand?: string | undefined;
+      collapse?: string | undefined;
+      expandLabel?: string | undefined;
+      collapseLabel?: string | undefined;
   };
   /**
    * When `true`, disables automatically overflowing `calcite-action`s that won't fit into menus.
    *
+   * @deprecated in v5.2.0, removal target v7.0.0 - Use `overflowMode="none"` instead.
    * @default false
    */
   accessor overflowActionsDisabled: boolean;
   /**
-   * Specifies the type of positioning to use for overlaid content, where:
+   * Specifies how the component handles `calcite-action`s that overflow the available space, where:
+   *
+   * `"collapse"` overflows actions that won't fit into menus,
+   *
+   * `"wrap"` allows the actions to wrap onto multiple lines, adding dividers between the wrapped rows
+   * or columns (has no effect when `layout` is `"grid"`), and
+   *
+   * `"none"` applies no overflow handling.
+   *
+   * @default "collapse"
+   */
+  accessor overflowMode: "collapse" | "wrap" | "none";
+  /**
+   * Specifies the type of positioning to use for overlaid content.
    *
-   * `"absolute"` works for most cases - positioning the component inside of overflowing parent containers, which affects the container's layout, and
+   * - `"absolute"` works for most cases - positioning the component inside of overflowing parent containers, which affects the container's layout.
    *
-   * `"fixed"` is used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`.
+   * - `"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;
   /**
-   * When `expandDisabled` is `false`, specifies the expand toggle's chevron direction, where:
+   * When `expandToggleDisabled` is `false`, specifies the expand toggle's chevron direction.
    *
-   * `"start"` positions the expand toggle's chevron away from the start of the component when `expanded` is `false`, and
-   * `"end"` positions the expand toggle's chevron away from the end of the component when `expanded` is `false`.
+   * - `"start"` positions the expand toggle's chevron away from the start of the component when `expanded` is `false`.
+   * - `"end"` positions the expand toggle's chevron away from the end of the component when `expanded` is `false`.
    *
    * When `expanded` is `true`, the chevron direction is reversed.
    */