@esri/calcite-components 1.9.0-next.1 → 1.9.0-next.11

package/dist/types/components.d.ts

@@ -310,6 +310,10 @@ export namespace Components {
         "setFocus": () => Promise<void>;
     }
     interface CalciteActionMenu {
+        /**
+          * Specifies the appearance of the component.
+         */
+        "appearance": Extract<"solid" | "transparent", Appearance>;
         /**
           * When `true`, the component is expanded.
          */
@@ -1560,6 +1564,18 @@ export namespace Components {
           * When `true`, the component will be hidden.
          */
         "closed": boolean;
+        /**
+          * Specifies the direction of the collapse.
+         */
+        "collapseDirection": "down" | "up";
+        /**
+          * When `true`, hides the component's content area.
+         */
+        "collapsed": boolean;
+        /**
+          * When `true`, the component is collapsible.
+         */
+        "collapsible": boolean;
         /**
           * A description for the component.
          */
@@ -1595,11 +1611,13 @@ export namespace Components {
         /**
           * Scrolls the component's content to a specified set of coordinates.
           * @example myCalciteFlowItem.scrollContentTo({   left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.   top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element   behavior: "auto" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value). });
-          * @param options
+          * @param options - allows specific coordinates to be defined.
+          * @returns - promise that resolves once the content is scrolled to.
          */
         "scrollContentTo": (options?: ScrollToOptions) => Promise<void>;
         /**
           * Sets focus on the component.
+          * @returns promise.
          */
         "setFocus": () => Promise<void>;
         /**
@@ -3153,6 +3171,18 @@ export namespace Components {
           * When `true`, the component will be hidden.
          */
         "closed": boolean;
+        /**
+          * Specifies the direction of the collapse.
+         */
+        "collapseDirection": "down" | "up";
+        /**
+          * When `true`, hides the component's content area.
+         */
+        "collapsed": boolean;
+        /**
+          * When `true`, the component is collapsible.
+         */
+        "collapsible": boolean;
         /**
           * A description for the component.
          */
@@ -3188,7 +3218,8 @@ export namespace Components {
         /**
           * Scrolls the component's content to a specified set of coordinates.
           * @example myCalciteFlowItem.scrollContentTo({   left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.   top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element   behavior: "auto" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value). });
-          * @param options
+          * @param options - allows specific coordinates to be defined.
+          * @returns - promise that resolves once the content is scrolled to.
          */
         "scrollContentTo": (options?: ScrollToOptions) => Promise<void>;
         /**
@@ -6254,6 +6285,10 @@ declare namespace LocalJSX {
         "scale"?: Scale;
     }
     interface CalciteActionMenu {
+        /**
+          * Specifies the appearance of the component.
+         */
+        "appearance"?: Extract<"solid" | "transparent", Appearance>;
         /**
           * When `true`, the component is expanded.
          */
@@ -6445,8 +6480,25 @@ declare namespace LocalJSX {
           * Use this property to override individual strings used by the component.
          */
         "messageOverrides"?: Partial<BlockMessages>;
+        /**
+          * Fires when the component is requested to be closed and before the closing transition begins.
+         */
+        "onCalciteBlockBeforeClose"?: (event: CalciteBlockCustomEvent<void>) => void;
+        /**
+          * Fires when the component is added to the DOM but not rendered, and before the opening transition begins.
+         */
+        "onCalciteBlockBeforeOpen"?: (event: CalciteBlockCustomEvent<void>) => void;
+        /**
+          * Fires when the component is closed and animation is complete.
+         */
+        "onCalciteBlockClose"?: (event: CalciteBlockCustomEvent<void>) => void;
+        /**
+          * Fires when the component is open and animation is complete.
+         */
+        "onCalciteBlockOpen"?: (event: CalciteBlockCustomEvent<void>) => void;
         /**
           * Emits when the component's header is clicked.
+          * @deprecated use `openClose` events: `calciteBlock[Before]Open` and `calciteBlock[Before]Close` instead.
          */
         "onCalciteBlockToggle"?: (event: CalciteBlockCustomEvent<void>) => void;
         /**
@@ -7408,6 +7460,14 @@ declare namespace LocalJSX {
           * When `true`, the component will be hidden.
          */
         "closed"?: boolean;
+        /**
+          * When `true`, hides the component's content area.
+         */
+        "collapsed"?: boolean;
+        /**
+          * When `true`, the component is collapsible.
+         */
+        "collapsible"?: boolean;
         /**
           * A description for the component.
          */
@@ -7448,6 +7508,10 @@ declare namespace LocalJSX {
           * Fires when the content is scrolled.
          */
         "onCalciteFlowItemScroll"?: (event: CalciteFlowItemCustomEvent<void>) => void;
+        /**
+          * Fires when the collapse button is clicked.
+         */
+        "onCalciteFlowItemToggle"?: (event: CalciteFlowItemCustomEvent<void>) => void;
     }
     interface CalciteGraph {
         /**
@@ -8172,10 +8236,26 @@ declare namespace LocalJSX {
           * Specifies the Unicode numeral system used by the component for localization.
          */
         "numberingSystem"?: NumberingSystem;
+        /**
+          * Fires when the component is requested to be closed and before the closing transition begins.
+         */
+        "onCalciteInputTimePickerBeforeClose"?: (event: CalciteInputTimePickerCustomEvent<void>) => void;
+        /**
+          * Fires when the component is added to the DOM but not rendered, and before the opening transition begins.
+         */
+        "onCalciteInputTimePickerBeforeOpen"?: (event: CalciteInputTimePickerCustomEvent<void>) => void;
         /**
           * Fires when the time value is changed as a result of user input.
          */
         "onCalciteInputTimePickerChange"?: (event: CalciteInputTimePickerCustomEvent<void>) => void;
+        /**
+          * Fires when the component is closed and animation is complete.
+         */
+        "onCalciteInputTimePickerClose"?: (event: CalciteInputTimePickerCustomEvent<void>) => void;
+        /**
+          * Fires when the component is open and animation is complete.
+         */
+        "onCalciteInputTimePickerOpen"?: (event: CalciteInputTimePickerCustomEvent<void>) => void;
         /**
           * When `true`, displays the `calcite-time-picker` component.
          */
@@ -8798,11 +8878,19 @@ declare namespace LocalJSX {
          */
         "messageOverrides"?: Partial<NoticeMessages>;
         /**
-          * Fired when the component is closed.
+          * Fires when the component is requested to be closed and before the closing transition begins.
+         */
+        "onCalciteNoticeBeforeClose"?: (event: CalciteNoticeCustomEvent<void>) => void;
+        /**
+          * Fires when the component is added to the DOM but not rendered, and before the opening transition begins.
+         */
+        "onCalciteNoticeBeforeOpen"?: (event: CalciteNoticeCustomEvent<void>) => void;
+        /**
+          * Fires when the component is closed and animation is complete.
          */
         "onCalciteNoticeClose"?: (event: CalciteNoticeCustomEvent<void>) => void;
         /**
-          * Fired when the component is opened.
+          * Fires when the component is open and animation is complete.
          */
         "onCalciteNoticeOpen"?: (event: CalciteNoticeCustomEvent<void>) => void;
         /**
@@ -8889,6 +8977,14 @@ declare namespace LocalJSX {
           * When `true`, the component will be hidden.
          */
         "closed"?: boolean;
+        /**
+          * When `true`, hides the component's content area.
+         */
+        "collapsed"?: boolean;
+        /**
+          * When `true`, the component is collapsible.
+         */
+        "collapsible"?: boolean;
         /**
           * A description for the component.
          */
@@ -8925,6 +9021,10 @@ declare namespace LocalJSX {
           * Fires when the content is scrolled.
          */
         "onCalcitePanelScroll"?: (event: CalcitePanelCustomEvent<void>) => void;
+        /**
+          * Fires when the collapse button is clicked.
+         */
+        "onCalcitePanelToggle"?: (event: CalcitePanelCustomEvent<void>) => void;
     }
     /**
      * @deprecated Use the `list` component instead.

package/dist/types/preact.d.ts

@@ -42,7 +42,11 @@ declare module "preact/src/jsx" {
 
       "calcite-avatar": JSX.CalciteAvatar & JSXInternal.HTMLAttributes<HTMLCalciteAvatarElement>
 
-      "calcite-block": Omit<JSX.CalciteBlock, "onCalciteBlockToggle"> & JSXInternal.HTMLAttributes<HTMLCalciteBlockElement> & {
+      "calcite-block": Omit<JSX.CalciteBlock, "onCalciteBlockBeforeClose" | "onCalciteBlockBeforeOpen" | "onCalciteBlockClose" | "onCalciteBlockOpen" | "onCalciteBlockToggle"> & JSXInternal.HTMLAttributes<HTMLCalciteBlockElement> & {
+        "oncalciteBlockBeforeClose"?: (event: CustomEvent<any>) => void;
+        "oncalciteBlockBeforeOpen"?: (event: CustomEvent<any>) => void;
+        "oncalciteBlockClose"?: (event: CustomEvent<any>) => void;
+        "oncalciteBlockOpen"?: (event: CustomEvent<any>) => void;
         "oncalciteBlockToggle"?: (event: CustomEvent<any>) => void;
       }
 
@@ -147,10 +151,11 @@ declare module "preact/src/jsx" {
 
       "calcite-flow": JSX.CalciteFlow & JSXInternal.HTMLAttributes<HTMLCalciteFlowElement>
 
-      "calcite-flow-item": Omit<JSX.CalciteFlowItem, "onCalciteFlowItemBack" | "onCalciteFlowItemScroll" | "onCalciteFlowItemClose"> & JSXInternal.HTMLAttributes<HTMLCalciteFlowItemElement> & {
+      "calcite-flow-item": Omit<JSX.CalciteFlowItem, "onCalciteFlowItemBack" | "onCalciteFlowItemScroll" | "onCalciteFlowItemClose" | "onCalciteFlowItemToggle"> & JSXInternal.HTMLAttributes<HTMLCalciteFlowItemElement> & {
         "oncalciteFlowItemBack"?: (event: CustomEvent<any>) => void;
         "oncalciteFlowItemScroll"?: (event: CustomEvent<any>) => void;
         "oncalciteFlowItemClose"?: (event: CustomEvent<any>) => void;
+        "oncalciteFlowItemToggle"?: (event: CustomEvent<any>) => void;
       }
 
       "calcite-graph": JSX.CalciteGraph & JSXInternal.HTMLAttributes<HTMLCalciteGraphElement>
@@ -199,8 +204,12 @@ declare module "preact/src/jsx" {
         "oncalciteInputTextChange"?: (event: CustomEvent<any>) => void;
       }
 
-      "calcite-input-time-picker": Omit<JSX.CalciteInputTimePicker, "onCalciteInputTimePickerChange"> & JSXInternal.HTMLAttributes<HTMLCalciteInputTimePickerElement> & {
+      "calcite-input-time-picker": Omit<JSX.CalciteInputTimePicker, "onCalciteInputTimePickerBeforeClose" | "onCalciteInputTimePickerBeforeOpen" | "onCalciteInputTimePickerChange" | "onCalciteInputTimePickerClose" | "onCalciteInputTimePickerOpen"> & JSXInternal.HTMLAttributes<HTMLCalciteInputTimePickerElement> & {
+        "oncalciteInputTimePickerBeforeClose"?: (event: CustomEvent<any>) => void;
+        "oncalciteInputTimePickerBeforeOpen"?: (event: CustomEvent<any>) => void;
         "oncalciteInputTimePickerChange"?: (event: CustomEvent<any>) => void;
+        "oncalciteInputTimePickerClose"?: (event: CustomEvent<any>) => void;
+        "oncalciteInputTimePickerOpen"?: (event: CustomEvent<any>) => void;
       }
 
       "calcite-input-time-zone": Omit<JSX.CalciteInputTimeZone, "onCalciteInputTimeZoneBeforeClose" | "onCalciteInputTimeZoneBeforeOpen" | "onCalciteInputTimeZoneChange" | "onCalciteInputTimeZoneClose" | "onCalciteInputTimeZoneOpen"> & JSXInternal.HTMLAttributes<HTMLCalciteInputTimeZoneElement> & {
@@ -263,7 +272,9 @@ declare module "preact/src/jsx" {
 
       "calcite-navigation-user": JSX.CalciteCalciteNavigationUser & JSXInternal.HTMLAttributes<HTMLCalciteCalciteNavigationUserElement>
 
-      "calcite-notice": Omit<JSX.CalciteNotice, "onCalciteNoticeClose" | "onCalciteNoticeOpen"> & JSXInternal.HTMLAttributes<HTMLCalciteNoticeElement> & {
+      "calcite-notice": Omit<JSX.CalciteNotice, "onCalciteNoticeBeforeClose" | "onCalciteNoticeBeforeOpen" | "onCalciteNoticeClose" | "onCalciteNoticeOpen"> & JSXInternal.HTMLAttributes<HTMLCalciteNoticeElement> & {
+        "oncalciteNoticeBeforeClose"?: (event: CustomEvent<any>) => void;
+        "oncalciteNoticeBeforeOpen"?: (event: CustomEvent<any>) => void;
         "oncalciteNoticeClose"?: (event: CustomEvent<any>) => void;
         "oncalciteNoticeOpen"?: (event: CustomEvent<any>) => void;
       }
@@ -280,8 +291,9 @@ declare module "preact/src/jsx" {
         "oncalcitePaginationChange"?: (event: CustomEvent<any>) => void;
       }
 
-      "calcite-panel": Omit<JSX.CalcitePanel, "onCalcitePanelClose" | "onCalcitePanelScroll"> & JSXInternal.HTMLAttributes<HTMLCalcitePanelElement> & {
+      "calcite-panel": Omit<JSX.CalcitePanel, "onCalcitePanelClose" | "onCalcitePanelToggle" | "onCalcitePanelScroll"> & JSXInternal.HTMLAttributes<HTMLCalcitePanelElement> & {
         "oncalcitePanelClose"?: (event: CustomEvent<any>) => void;
+        "oncalcitePanelToggle"?: (event: CustomEvent<any>) => void;
         "oncalcitePanelScroll"?: (event: CustomEvent<any>) => void;
       }
 

package/dist/types/utils/openCloseComponent.d.ts

@@ -26,7 +26,7 @@ export interface OpenCloseComponent {
   /**
    * Specifies element that the transition is allowed to emit on.
    */
-  transitionEl: HTMLDivElement;
+  transitionEl: HTMLElement;
   /**
    * Defines method for `beforeOpen` event handler.
    */

package/dist/types/utils/responsive.d.ts

@@ -1,4 +1,4 @@
-interface Breakpoints {
+export interface Breakpoints {
   width: {
     large: number;
     medium: number;
@@ -10,6 +10,7 @@ interface Breakpoints {
  * This util will return a breakpoints lookup object.
  *
  * Note that the breakpoints will be evaluated at the root and cached for reuse.
+ *
+ * @returns {Promise<Breakpoints>} The Breakpoints object.
  */
 export declare function getBreakpoints(): Promise<Breakpoints>;
-export {};

package/dist/types/utils/sortableComponent.d.ts

@@ -3,6 +3,8 @@ export interface DragDetail {
   toEl: HTMLElement;
   fromEl: HTMLElement;
   dragEl: HTMLElement;
+  newIndex: number;
+  oldIndex: number;
 }
 export declare const CSS: {
   ghostClass: string;