@esri/calcite-components 1.0.0-next.582 → 1.0.0-next.591

package/dist/types/components.d.ts

@@ -823,8 +823,9 @@ export namespace Components {
          */
         "storageId": string;
         /**
-          * The color value.  This value can be either a {@link https ://developer.mozilla.org/en-US/docs/Web/CSS/color|CSS string} a RGB, HSL or HSV object.  The type will be preserved as the color is updated.
+          * The component's value.  This value can be either a CSS color string, a RGB, HSL or HSV object.  The type will be preserved as the color is updated.
           * @default "#007ac2"
+          * @see [CSS Color](https://developer.mozilla.org/en-US/docs/Web/CSS/color)
           * @see [ColorValue](https://github.com/Esri/calcite-components/blob/master/src/components/color-picker/interfaces.ts#L10)
          */
         "value": ColorValue | null;
@@ -1046,6 +1047,8 @@ export namespace Components {
         "intlYear"?: string;
         /**
           * BCP 47 language tag for desired language and country format
+          * @deprecated set the global `lang` attribute on the element instead.
+          * @mdn [lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)
          */
         "locale"?: string;
         /**
@@ -1208,10 +1211,6 @@ export namespace Components {
           * Localized string for year.
          */
         "intlYear": string;
-        /**
-          * User's language and region as BCP 47 formatted string.
-         */
-        "locale": string;
         /**
           * CLDR locale data for translated calendar info
          */
@@ -1658,7 +1657,9 @@ export namespace Components {
          */
         "loading": boolean;
         /**
-          * Specifies the BCP 47 language tag for the desired language and country format.
+          * BCP 47 language tag for desired language and country format
+          * @deprecated set the global `lang` attribute on the element instead.
+          * @mdn [lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)
          */
         "locale": string;
         /**
@@ -1820,6 +1821,8 @@ export namespace Components {
         "layout": "horizontal" | "vertical";
         /**
           * BCP 47 language tag for desired language and country format
+          * @deprecated set the global `lang` attribute on the element instead.
+          * @mdn [lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)
          */
         "locale"?: string;
         /**
@@ -1982,6 +1985,8 @@ export namespace Components {
         "loading": boolean;
         /**
           * Specifies the BCP 47 language tag for the desired language and country format.
+          * @deprecated set the global `lang` attribute on the element instead.
+          * @mdn [lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)
          */
         "locale": string;
         /**
@@ -2238,6 +2243,8 @@ export namespace Components {
         "intlSecondUp"?: string;
         /**
           * BCP 47 language tag for desired language and country format
+          * @deprecated set the global `lang` attribute on the element instead.
+          * @mdn [lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)
          */
         "locale": string;
         /**
@@ -2248,6 +2255,10 @@ export namespace Components {
           * When true, displays the `calcite-time-picker` component.
          */
         "open": boolean;
+        /**
+          * Determines the type of positioning to use for the overlaid content.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
+         */
+        "overlayPositioning": OverlayPositioning;
         /**
           * Determines where the popover will be positioned relative to the input.
           * @see [LogicalPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/floating-ui.ts#L25)
@@ -3835,6 +3846,8 @@ export namespace Components {
         "intlSecondUp": string;
         /**
           * BCP 47 language tag for desired language and country format.
+          * @deprecated set the global `lang` attribute on the element instead.
+          * @mdn [lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)
          */
         "locale": string;
         /**
@@ -5836,8 +5849,9 @@ declare namespace LocalJSX {
          */
         "storageId"?: string;
         /**
-          * The color value.  This value can be either a {@link https ://developer.mozilla.org/en-US/docs/Web/CSS/color|CSS string} a RGB, HSL or HSV object.  The type will be preserved as the color is updated.
+          * The component's value.  This value can be either a CSS color string, a RGB, HSL or HSV object.  The type will be preserved as the color is updated.
           * @default "#007ac2"
+          * @see [CSS Color](https://developer.mozilla.org/en-US/docs/Web/CSS/color)
           * @see [ColorValue](https://github.com/Esri/calcite-components/blob/master/src/components/color-picker/interfaces.ts#L10)
          */
         "value"?: ColorValue | null;
@@ -6084,6 +6098,8 @@ declare namespace LocalJSX {
         "intlYear"?: string;
         /**
           * BCP 47 language tag for desired language and country format
+          * @deprecated set the global `lang` attribute on the element instead.
+          * @mdn [lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)
          */
         "locale"?: string;
         /**
@@ -6263,10 +6279,6 @@ declare namespace LocalJSX {
           * Localized string for year.
          */
         "intlYear"?: string;
-        /**
-          * User's language and region as BCP 47 formatted string.
-         */
-        "locale"?: string;
         /**
           * CLDR locale data for translated calendar info
          */
@@ -6554,7 +6566,16 @@ declare namespace LocalJSX {
         /**
           * Fires when the back button is clicked.
          */
+        "onCalciteFlowItemBack"?: (event: CalciteFlowItemCustomEvent<void>) => void;
+        /**
+          * Fires when the back button is clicked.
+          * @deprecated use calciteFlowItemBack instead.
+         */
         "onCalciteFlowItemBackClick"?: (event: CalciteFlowItemCustomEvent<void>) => void;
+        /**
+          * Fires when the close button is clicked.
+         */
+        "onCalciteFlowItemClose"?: (event: CalciteFlowItemCustomEvent<void>) => void;
         /**
           * When true, displays a back button in the header.
          */
@@ -6721,7 +6742,9 @@ declare namespace LocalJSX {
          */
         "loading"?: boolean;
         /**
-          * Specifies the BCP 47 language tag for the desired language and country format.
+          * BCP 47 language tag for desired language and country format
+          * @deprecated set the global `lang` attribute on the element instead.
+          * @mdn [lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)
          */
         "locale"?: string;
         /**
@@ -6879,6 +6902,8 @@ declare namespace LocalJSX {
         "layout"?: "horizontal" | "vertical";
         /**
           * BCP 47 language tag for desired language and country format
+          * @deprecated set the global `lang` attribute on the element instead.
+          * @mdn [lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)
          */
         "locale"?: string;
         /**
@@ -7059,6 +7084,8 @@ declare namespace LocalJSX {
         "loading"?: boolean;
         /**
           * Specifies the BCP 47 language tag for the desired language and country format.
+          * @deprecated set the global `lang` attribute on the element instead.
+          * @mdn [lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)
          */
         "locale"?: string;
         /**
@@ -7324,6 +7351,10 @@ declare namespace LocalJSX {
           * When true, displays the `calcite-time-picker` component.
          */
         "open"?: boolean;
+        /**
+          * Determines the type of positioning to use for the overlaid content.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
+         */
+        "overlayPositioning"?: OverlayPositioning;
         /**
           * Determines where the popover will be positioned relative to the input.
           * @see [LogicalPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/floating-ui.ts#L25)
@@ -7760,10 +7791,15 @@ declare namespace LocalJSX {
         /**
           * Fires when the close button is clicked.
          */
+        "onCalcitePanelClose"?: (event: CalcitePanelCustomEvent<void>) => void;
+        /**
+          * Fires when the close button is clicked.
+          * @deprecated use calcitePanelClose instead.
+         */
         "onCalcitePanelDismiss"?: (event: CalcitePanelCustomEvent<void>) => void;
         /**
           * Fires when there is a change to the `dismissed` property value .
-          * @deprecated use calcitePanelDismiss instead.
+          * @deprecated use calcitePanelClose instead.
          */
         "onCalcitePanelDismissedChange"?: (event: CalcitePanelCustomEvent<void>) => void;
         /**

package/dist/types/preact.d.ts

@@ -145,8 +145,10 @@ declare module "preact/src/jsx" {
 
       "calcite-flow": JSX.CalciteFlow & JSXInternal.HTMLAttributes<HTMLCalciteFlowElement>
 
-      "calcite-flow-item": Omit<JSX.CalciteFlowItem, "onCalciteFlowItemBackClick"> & JSXInternal.HTMLAttributes<HTMLCalciteFlowItemElement> & {
+      "calcite-flow-item": Omit<JSX.CalciteFlowItem, "onCalciteFlowItemBack" | "onCalciteFlowItemBackClick" | "onCalciteFlowItemClose"> & JSXInternal.HTMLAttributes<HTMLCalciteFlowItemElement> & {
+        "oncalciteFlowItemBack"?: (event: CustomEvent<any>) => void;
         "oncalciteFlowItemBackClick"?: (event: CustomEvent<any>) => void;
+        "oncalciteFlowItemClose"?: (event: CustomEvent<any>) => void;
       }
 
       "calcite-graph": JSX.CalciteGraph & JSXInternal.HTMLAttributes<HTMLCalciteGraphElement>
@@ -239,7 +241,8 @@ declare module "preact/src/jsx" {
         "oncalcitePaginationChange"?: (event: CustomEvent<any>) => void;
       }
 
-      "calcite-panel": Omit<JSX.CalcitePanel, "onCalcitePanelDismiss" | "onCalcitePanelDismissedChange" | "onCalcitePanelScroll" | "onCalcitePanelBackClick"> & JSXInternal.HTMLAttributes<HTMLCalcitePanelElement> & {
+      "calcite-panel": Omit<JSX.CalcitePanel, "onCalcitePanelClose" | "onCalcitePanelDismiss" | "onCalcitePanelDismissedChange" | "onCalcitePanelScroll" | "onCalcitePanelBackClick"> & JSXInternal.HTMLAttributes<HTMLCalcitePanelElement> & {
+        "oncalcitePanelClose"?: (event: CustomEvent<any>) => void;
         "oncalcitePanelDismiss"?: (event: CustomEvent<any>) => void;
         "oncalcitePanelDismissedChange"?: (event: CustomEvent<any>) => void;
         "oncalcitePanelScroll"?: (event: CustomEvent<any>) => void;
@@ -347,12 +350,13 @@ declare module "preact/src/jsx" {
         "oncalciteInternalTabChange"?: (event: CustomEvent<any>) => void;
       }
 
-      "calcite-tab-title": Omit<JSX.CalciteTabTitle, "onCalciteTabsActivate" | "onCalciteInternalTabsActivate" | "onCalciteInternalTabsFocusNext" | "onCalciteInternalTabsFocusPrevious" | "onCalciteInternalTabTitleRegister"> & JSXInternal.HTMLAttributes<HTMLCalciteTabTitleElement> & {
+      "calcite-tab-title": Omit<JSX.CalciteTabTitle, "onCalciteTabsActivate" | "onCalciteInternalTabsActivate" | "onCalciteInternalTabsFocusNext" | "onCalciteInternalTabsFocusPrevious" | "onCalciteInternalTabTitleRegister" | "onCalciteInternalTabIconChanged"> & JSXInternal.HTMLAttributes<HTMLCalciteTabTitleElement> & {
         "oncalciteTabsActivate"?: (event: CustomEvent<any>) => void;
         "oncalciteInternalTabsActivate"?: (event: CustomEvent<any>) => void;
         "oncalciteInternalTabsFocusNext"?: (event: CustomEvent<any>) => void;
         "oncalciteInternalTabsFocusPrevious"?: (event: CustomEvent<any>) => void;
         "oncalciteInternalTabTitleRegister"?: (event: CustomEvent<any>) => void;
+        "oncalciteInternalTabIconChanged"?: (event: CustomEvent<any>) => void;
       }
 
       "calcite-tabs": JSX.CalciteTabs & JSXInternal.HTMLAttributes<HTMLCalciteTabsElement>

package/dist/types/utils/floating-ui.d.ts

@@ -1,4 +1,5 @@
 import { Placement, Strategy, VirtualElement } from "@floating-ui/dom";
+export declare const repositionDebounceTimeout = 100;
 export declare type ReferenceElement = VirtualElement | Element;
 declare type UIType = "menu" | "tooltip" | "popover";
 export declare type OverlayPositioning = Strategy;

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

@@ -1,3 +1,4 @@
+import { GlobalAttrComponent } from "./globalAttributes";
 export declare const locales: string[];
 export declare function createLocaleNumberFormatter(locale: string, numberingSystem?: string): Intl.NumberFormat;
 export declare function delocalizeNumberString(numberString: string, locale: string): string;
@@ -5,3 +6,24 @@ export declare function getGroupSeparator(locale: string): string;
 export declare function getDecimalSeparator(locale: string): string;
 export declare function getMinusSign(locale: string): string;
 export declare function localizeNumberString(numberString: string, locale: string, displayGroupSeparator?: boolean, numberingSystem?: string): string;
+/**
+ * This interface is for components that need to determine locale from the lang attribute.
+ */
+export interface LangComponent extends GlobalAttrComponent {
+  /**
+   * BCP 47 language tag for desired language and country format
+   *
+   * **Note**: this prop was added exclusively for backwards-compatibility
+   *
+   * @deprecated set the global `lang` attribute on the element instead.
+   * @mdn [lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)
+   */
+  locale?: string;
+}
+/**
+ * This util helps resolve a component's locale.
+ * It will also fall back on the deprecated `locale` if a component implemented this previously.
+ *
+ * @param component
+ */
+export declare function getLocale(component: LangComponent): string;