@esri/calcite-components 1.0.0-beta.93 → 1.0.0-beta.94

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

@@ -1,117 +1,118 @@
-import { Placement, Strategy, VirtualElement } from "@floating-ui/dom";
-export declare type ReferenceElement = VirtualElement | Element;
-declare type UIType = "menu" | "tooltip" | "popover";
-export declare type OverlayPositioning = Strategy;
-/**
- * Placements that change based on element direction.
- *
- * These variation placements will automatically flip "left"/"right" depending on LTR/RTL direction.
- *
- * Floating-ui has no plans to offer this functionality out of the box at this time.
- *
- * see: https://github.com/floating-ui/floating-ui/issues/1563 and https://github.com/floating-ui/floating-ui/discussions/1549
- */
-declare type VariationPlacement = "leading-start" | "leading" | "leading-end" | "trailing-end" | "trailing" | "trailing-start";
-declare type AutoPlacement = "auto" | "auto-start" | "auto-end";
-/**
- * Use "*-start" and "*-end" instead.
- *
- * There is no need for our "*-leading" and "*-trailing" values anymore since "*-start" and "*-end" are already flipped in RTL.
- *
- * @deprecated
- */
-declare type DeprecatedPlacement = "leading-leading" | "leading-trailing" | "trailing-leading" | "trailing-trailing" | "top-leading" | "top-trailing" | "bottom-leading" | "bottom-trailing" | "right-leading" | "right-trailing" | "left-leading" | "left-trailing";
-export declare type LogicalPlacement = AutoPlacement | Placement | VariationPlacement | DeprecatedPlacement;
-export declare type EffectivePlacement = Placement;
-export declare const placements: LogicalPlacement[];
-export declare const effectivePlacements: EffectivePlacement[];
-export declare const menuPlacements: MenuPlacement[];
-export declare const menuEffectivePlacements: EffectivePlacement[];
-export declare const flipPlacements: EffectivePlacement[];
-/**
- * Use "*-start" and "*-end" instead.
- *
- * There is no need for our "*-leading" and "*-trailing" values anymore since "*-start" and "*-end" are already flipped in RTL.
- *
- * @deprecated
- */
-declare type DeprecatedMenuPlacement = Extract<DeprecatedPlacement, "top-leading" | "top-trailing" | "bottom-leading" | "bottom-trailing">;
-export declare type MenuPlacement = DeprecatedMenuPlacement | Extract<LogicalPlacement, "top-start" | "top" | "top-end" | "bottom-start" | "bottom" | "bottom-end">;
-export declare const defaultMenuPlacement: MenuPlacement;
-export interface FloatingUIComponent {
-  /**
-   * Whether the component is opened.
-   */
-  open: boolean;
-  /**
-   * Describes the type of positioning to use for the overlaid content. If your element is in a fixed container, use the 'fixed' value.
-   */
-  overlayPositioning: OverlayPositioning;
-  /**
-   * Determines where the component will be positioned relative to the referenceElement.
-   *
-   * Possible values: "auto", "auto-start", "auto-end", "top", "right", "bottom", "left", "top-start", "top-end", "right-start", "right-end", "bottom-start", "bottom-end", "left-start", "left-end", "leading-start", "leading", "leading-end", "trailing-end", "trailing",  or "trailing-start".
-   *
-   */
-  placement: LogicalPlacement;
-  /**
-   * Updates the position of the component.
-   */
-  reposition(): Promise<void>;
-}
-export declare const FloatingCSS: {
-  animation: string;
-  animationActive: string;
-};
-export declare function filterComputedPlacements(placements: string[], el: HTMLElement): EffectivePlacement[];
-export declare function getEffectivePlacement(floatingEl: HTMLElement, placement: LogicalPlacement): EffectivePlacement;
-/**
- * Positions the floating element relative to the reference element.
- *
- * @param root0
- * @param root0.referenceEl
- * @param root0.floatingEl
- * @param root0.overlayPositioning
- * @param root0.placement
- * @param root0.disableFlip
- * @param root0.flipPlacements
- * @param root0.offsetDistance
- * @param root0.offsetSkidding
- * @param root0.arrowEl
- * @param root0.type
- */
-export declare function positionFloatingUI({ referenceEl, floatingEl, overlayPositioning, placement, disableFlip, flipPlacements, offsetDistance, offsetSkidding, arrowEl, type }: {
-  referenceEl: ReferenceElement;
-  floatingEl: HTMLElement;
-  overlayPositioning: Strategy;
-  placement: LogicalPlacement;
-  disableFlip?: boolean;
-  flipPlacements?: EffectivePlacement[];
-  offsetDistance?: number;
-  offsetSkidding?: number;
-  arrowEl?: HTMLElement;
-  type: UIType;
-}): Promise<void>;
-/**
- * Helper to set up floating element interactions on connectedCallback.
- *
- * @param component
- * @param referenceEl
- * @param floatingEl
- */
-export declare function connectFloatingUI(component: FloatingUIComponent, referenceEl: ReferenceElement, floatingEl: HTMLElement): void;
-/**
- * Helper to tear down floating element interactions on disconnectedCallback.
- *
- * @param component
- * @param referenceEl
- * @param floatingEl
- */
-export declare function disconnectFloatingUI(component: FloatingUIComponent, referenceEl: ReferenceElement, floatingEl: HTMLElement): void;
-/**
- * Default offset the position of the floating element away from the reference element.
- *
- * @default 6
- */
-export declare const defaultOffsetDistance: number;
-export {};
+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;
+/**
+ * Placements that change based on element direction.
+ *
+ * These variation placements will automatically flip "left"/"right" depending on LTR/RTL direction.
+ *
+ * Floating-ui has no plans to offer this functionality out of the box at this time.
+ *
+ * see: https://github.com/floating-ui/floating-ui/issues/1563 and https://github.com/floating-ui/floating-ui/discussions/1549
+ */
+declare type VariationPlacement = "leading-start" | "leading" | "leading-end" | "trailing-end" | "trailing" | "trailing-start";
+declare type AutoPlacement = "auto" | "auto-start" | "auto-end";
+/**
+ * Use "*-start" and "*-end" instead.
+ *
+ * There is no need for our "*-leading" and "*-trailing" values anymore since "*-start" and "*-end" are already flipped in RTL.
+ *
+ * @deprecated
+ */
+declare type DeprecatedPlacement = "leading-leading" | "leading-trailing" | "trailing-leading" | "trailing-trailing" | "top-leading" | "top-trailing" | "bottom-leading" | "bottom-trailing" | "right-leading" | "right-trailing" | "left-leading" | "left-trailing";
+export declare type LogicalPlacement = AutoPlacement | Placement | VariationPlacement | DeprecatedPlacement;
+export declare type EffectivePlacement = Placement;
+export declare const placements: LogicalPlacement[];
+export declare const effectivePlacements: EffectivePlacement[];
+export declare const menuPlacements: MenuPlacement[];
+export declare const menuEffectivePlacements: EffectivePlacement[];
+export declare const flipPlacements: EffectivePlacement[];
+/**
+ * Use "*-start" and "*-end" instead.
+ *
+ * There is no need for our "*-leading" and "*-trailing" values anymore since "*-start" and "*-end" are already flipped in RTL.
+ *
+ * @deprecated
+ */
+declare type DeprecatedMenuPlacement = Extract<DeprecatedPlacement, "top-leading" | "top-trailing" | "bottom-leading" | "bottom-trailing">;
+export declare type MenuPlacement = DeprecatedMenuPlacement | Extract<LogicalPlacement, "top-start" | "top" | "top-end" | "bottom-start" | "bottom" | "bottom-end">;
+export declare const defaultMenuPlacement: MenuPlacement;
+export interface FloatingUIComponent {
+  /**
+   * Whether the component is opened.
+   */
+  open: boolean;
+  /**
+   * Describes the type of positioning to use for the overlaid content. If your element is in a fixed container, use the 'fixed' value.
+   */
+  overlayPositioning: OverlayPositioning;
+  /**
+   * Determines where the component will be positioned relative to the referenceElement.
+   *
+   * Possible values: "auto", "auto-start", "auto-end", "top", "right", "bottom", "left", "top-start", "top-end", "right-start", "right-end", "bottom-start", "bottom-end", "left-start", "left-end", "leading-start", "leading", "leading-end", "trailing-end", "trailing",  or "trailing-start".
+   *
+   */
+  placement: LogicalPlacement;
+  /**
+   * Updates the position of the component.
+   */
+  reposition(): Promise<void>;
+}
+export declare const FloatingCSS: {
+  animation: string;
+  animationActive: string;
+};
+export declare function filterComputedPlacements(placements: string[], el: HTMLElement): EffectivePlacement[];
+export declare function getEffectivePlacement(floatingEl: HTMLElement, placement: LogicalPlacement): EffectivePlacement;
+/**
+ * Positions the floating element relative to the reference element.
+ *
+ * @param root0
+ * @param root0.referenceEl
+ * @param root0.floatingEl
+ * @param root0.overlayPositioning
+ * @param root0.placement
+ * @param root0.disableFlip
+ * @param root0.flipPlacements
+ * @param root0.offsetDistance
+ * @param root0.offsetSkidding
+ * @param root0.arrowEl
+ * @param root0.type
+ */
+export declare function positionFloatingUI({ referenceEl, floatingEl, overlayPositioning, placement, disableFlip, flipPlacements, offsetDistance, offsetSkidding, arrowEl, type }: {
+  referenceEl: ReferenceElement;
+  floatingEl: HTMLElement;
+  overlayPositioning: Strategy;
+  placement: LogicalPlacement;
+  disableFlip?: boolean;
+  flipPlacements?: EffectivePlacement[];
+  offsetDistance?: number;
+  offsetSkidding?: number;
+  arrowEl?: HTMLElement;
+  type: UIType;
+}): Promise<void>;
+/**
+ * Helper to set up floating element interactions on connectedCallback.
+ *
+ * @param component
+ * @param referenceEl
+ * @param floatingEl
+ */
+export declare function connectFloatingUI(component: FloatingUIComponent, referenceEl: ReferenceElement, floatingEl: HTMLElement): void;
+/**
+ * Helper to tear down floating element interactions on disconnectedCallback.
+ *
+ * @param component
+ * @param referenceEl
+ * @param floatingEl
+ */
+export declare function disconnectFloatingUI(component: FloatingUIComponent, referenceEl: ReferenceElement, floatingEl: HTMLElement): void;
+/**
+ * Default offset the position of the floating element away from the reference element.
+ *
+ * @default 6
+ */
+export declare const defaultOffsetDistance: number;
+export {};

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

@@ -1,140 +1,140 @@
-import { FunctionalComponent } from "../stencil-public-runtime";
-/**
- * Exported for testing purposes.
- */
-export declare const hiddenFormInputSlotName = "hidden-form-input";
-/**
- * Defines interface for form owning components.
- *
- * Allows calling submit/reset methods on the form.
- */
-export interface FormOwner {
-  /**
-   * The form this component is associated with.
-   */
-  formEl: HTMLFormElement;
-}
-/**
- * Defines interface for form-associated components.
- *
- * Along with the interface, use the matching form utils to help set up the component behavior.
- */
-export interface FormComponent<T = any> extends FormOwner {
-  /**
-   * When true, this component's value will not be submitted in the form.
-   */
-  disabled: boolean;
-  /**
-   * When true, form submit requests will enforce field requirement.
-   *
-   * @todo remove optional in follow-up PR
-   */
-  required?: boolean;
-  /**
-   * The host element.
-   */
-  readonly el: HTMLElement;
-  /**
-   * The name used to submit the value to the associated form.
-   *
-   * Note that this prop should use the @Prop decorator.
-   */
-  name: string;
-  /**
-   * This form component's value.
-   *
-   * Note that this prop should use the @Prop decorator.
-   */
-  value: T;
-  /**
-   * The initial value for this form component.
-   *
-   * When the form is reset, the value will be set to this property.
-   */
-  defaultValue: T;
-  /**
-   * Hook for components to provide custom form reset behavior.
-   */
-  onFormReset?(): void;
-  /**
-   * Hook for components to sync _extra_ props on the hidden input form element used for form-submitting.
-   *
-   * Note: The following props are set by default: disabled, hidden, name, required, value.
-   */
-  syncHiddenFormInput?(input: HTMLInputElement): void;
-}
-/**
- * Defines interface for checkable form-associated components.
- *
- * Along with the interface, use the matching form utils to help set up the component behavior.
- */
-export interface CheckableFormComponent<T = any> extends FormComponent<T> {
-  /**
-   * For boolean-valued components, this property defines whether the associated value is submitted to the form or not.
-   */
-  checked: boolean;
-  /**
-   * The initial checked value for this form component.
-   *
-   * When the form is reset, the checked property will be set to this value.
-   */
-  defaultChecked: boolean;
-}
-/**
- * Helper to submit a form.
- *
- * @param component
- * @returns true if its associated form was submitted, false otherwise.
- */
-export declare function submitForm(component: FormOwner): boolean;
-/**
- * Helper to reset a form.
- *
- * @param component
- */
-export declare function resetForm(component: FormOwner): void;
-/**
- * Helper to set up form interactions on connectedCallback.
- *
- * @param component
- */
-export declare function connectForm<T>(component: FormComponent<T>): void;
-/**
- * Helper to tear down form interactions on disconnectedCallback.
- *
- * @param component
- */
-export declare function disconnectForm<T>(component: FormComponent<T>): void;
-/**
- * Helper for setting the default value on initialization after connectedCallback.
- *
- * Note that this is only needed if the default value cannot be determined on connectedCallback.
- *
- * @param component
- * @param value
- */
-export declare function afterConnectDefaultValueSet<T>(component: FormComponent<T>, value: any): void;
-interface HiddenFormInputSlotProps {
-  component: FormComponent;
-}
-/**
- * Helper to render the slot for form-associated component's hidden input.
- *
- * If the component has a default slot, this must be placed at the bottom of the component's root container to ensure it is the last child.
- *
- * render(): VNode {
- *   <Host>
- *     <div class={CSS.container}>
- *     // ...
- *     <HiddenFormInputSlot component={this} />
- *     </div>
- *   </Host>
- * }
- *
- * Note that the hidden-form-input Sass mixin must be added to the component's style to apply specific styles.
- *
- * @param root0
- * @param root0.component
- */
-export declare const HiddenFormInputSlot: FunctionalComponent<HiddenFormInputSlotProps>;
-export {};
+import { FunctionalComponent } from "../stencil-public-runtime";
+/**
+ * Exported for testing purposes.
+ */
+export declare const hiddenFormInputSlotName = "hidden-form-input";
+/**
+ * Defines interface for form owning components.
+ *
+ * Allows calling submit/reset methods on the form.
+ */
+export interface FormOwner {
+  /**
+   * The form this component is associated with.
+   */
+  formEl: HTMLFormElement;
+}
+/**
+ * Defines interface for form-associated components.
+ *
+ * Along with the interface, use the matching form utils to help set up the component behavior.
+ */
+export interface FormComponent<T = any> extends FormOwner {
+  /**
+   * When true, this component's value will not be submitted in the form.
+   */
+  disabled: boolean;
+  /**
+   * When true, form submit requests will enforce field requirement.
+   *
+   * @todo remove optional in follow-up PR
+   */
+  required?: boolean;
+  /**
+   * The host element.
+   */
+  readonly el: HTMLElement;
+  /**
+   * The name used to submit the value to the associated form.
+   *
+   * Note that this prop should use the @Prop decorator.
+   */
+  name: string;
+  /**
+   * This form component's value.
+   *
+   * Note that this prop should use the @Prop decorator.
+   */
+  value: T;
+  /**
+   * The initial value for this form component.
+   *
+   * When the form is reset, the value will be set to this property.
+   */
+  defaultValue: T;
+  /**
+   * Hook for components to provide custom form reset behavior.
+   */
+  onFormReset?(): void;
+  /**
+   * Hook for components to sync _extra_ props on the hidden input form element used for form-submitting.
+   *
+   * Note: The following props are set by default: disabled, hidden, name, required, value.
+   */
+  syncHiddenFormInput?(input: HTMLInputElement): void;
+}
+/**
+ * Defines interface for checkable form-associated components.
+ *
+ * Along with the interface, use the matching form utils to help set up the component behavior.
+ */
+export interface CheckableFormComponent<T = any> extends FormComponent<T> {
+  /**
+   * For boolean-valued components, this property defines whether the associated value is submitted to the form or not.
+   */
+  checked: boolean;
+  /**
+   * The initial checked value for this form component.
+   *
+   * When the form is reset, the checked property will be set to this value.
+   */
+  defaultChecked: boolean;
+}
+/**
+ * Helper to submit a form.
+ *
+ * @param component
+ * @returns true if its associated form was submitted, false otherwise.
+ */
+export declare function submitForm(component: FormOwner): boolean;
+/**
+ * Helper to reset a form.
+ *
+ * @param component
+ */
+export declare function resetForm(component: FormOwner): void;
+/**
+ * Helper to set up form interactions on connectedCallback.
+ *
+ * @param component
+ */
+export declare function connectForm<T>(component: FormComponent<T>): void;
+/**
+ * Helper to tear down form interactions on disconnectedCallback.
+ *
+ * @param component
+ */
+export declare function disconnectForm<T>(component: FormComponent<T>): void;
+/**
+ * Helper for setting the default value on initialization after connectedCallback.
+ *
+ * Note that this is only needed if the default value cannot be determined on connectedCallback.
+ *
+ * @param component
+ * @param value
+ */
+export declare function afterConnectDefaultValueSet<T>(component: FormComponent<T>, value: any): void;
+interface HiddenFormInputSlotProps {
+  component: FormComponent;
+}
+/**
+ * Helper to render the slot for form-associated component's hidden input.
+ *
+ * If the component has a default slot, this must be placed at the bottom of the component's root container to ensure it is the last child.
+ *
+ * render(): VNode {
+ *   <Host>
+ *     <div class={CSS.container}>
+ *     // ...
+ *     <HiddenFormInputSlot component={this} />
+ *     </div>
+ *   </Host>
+ * }
+ *
+ * Note that the hidden-form-input Sass mixin must be added to the component's style to apply specific styles.
+ *
+ * @param root0
+ * @param root0.component
+ */
+export declare const HiddenFormInputSlot: FunctionalComponent<HiddenFormInputSlotProps>;
+export {};

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

@@ -1,40 +1,40 @@
-declare type AttributeObject = {
-  [k: string]: any;
-};
-declare type AllowedGlobalAttribute = "lang";
-/**
- * Watches global attributes of a component.
- *
- * Derived from: https://gist.github.com/willmartian/b4dd6b57d71dd0438fb9e7c6f4048578
- */
-export interface GlobalAttrComponent {
-  /**
-   * The host element.
-   */
-  readonly el: HTMLElement;
-  /**
-   * The watched attributes object.
-   * Should be stateful.
-   * '@State() inheritedAttributes = {};'
-   */
-  globalAttributes: AttributeObject;
-}
-/**
- * Helper to set up listening for changes to global attributes.
- *
- * render(): VNode {
- *   const lang = this.inheritedAttributes['lang'] ?? 'en';
- *   return <div>My lang is {lang}</div>;
- * }
- *
- * @param component
- * @param attributeFilter
- */
-export declare function watchGlobalAttributes(component: GlobalAttrComponent, attributeFilter: AllowedGlobalAttribute[]): void;
-/**
- * Helper remove listening for changes to inherited attributes.
- *
- * @param component
- */
-export declare function unwatchGlobalAttributes(component: GlobalAttrComponent): void;
-export {};
+declare type AttributeObject = {
+  [k: string]: any;
+};
+declare type AllowedGlobalAttribute = "lang";
+/**
+ * Watches global attributes of a component.
+ *
+ * Derived from: https://gist.github.com/willmartian/b4dd6b57d71dd0438fb9e7c6f4048578
+ */
+export interface GlobalAttrComponent {
+  /**
+   * The host element.
+   */
+  readonly el: HTMLElement;
+  /**
+   * The watched attributes object.
+   * Should be stateful.
+   * '@State() inheritedAttributes = {};'
+   */
+  globalAttributes: AttributeObject;
+}
+/**
+ * Helper to set up listening for changes to global attributes.
+ *
+ * render(): VNode {
+ *   const lang = this.inheritedAttributes['lang'] ?? 'en';
+ *   return <div>My lang is {lang}</div>;
+ * }
+ *
+ * @param component
+ * @param attributeFilter
+ */
+export declare function watchGlobalAttributes(component: GlobalAttrComponent, attributeFilter: AllowedGlobalAttribute[]): void;
+/**
+ * Helper remove listening for changes to inherited attributes.
+ *
+ * @param component
+ */
+export declare function unwatchGlobalAttributes(component: GlobalAttrComponent): void;
+export {};

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

@@ -1,6 +1,6 @@
-/**
- * This file is imported in Stencil's `globalScript` config option.
- *
- * @see {@link https://stenciljs.com/docs/config#globalscript}
- */
-export default function (): void;
+/**
+ * This file is imported in Stencil's `globalScript` config option.
+ *
+ * @see {@link https://stenciljs.com/docs/config#globalscript}
+ */
+export default function (): void;

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

@@ -1 +1 @@
-export declare const guid: () => string;
+export declare const guid: () => string;