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

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

@@ -1,139 +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 CheckableFormCompoment<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
- */
-export declare function submitForm(component: FormOwner): void;
-/**
- * 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

@@ -0,0 +1,6 @@
+/**
+ * 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;

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

@@ -1,31 +1,31 @@
-export interface InteractiveComponent {
-  /**
-   * The host element.
-   */
-  readonly el: HTMLElement;
-  /**
-   * When true, prevents user interaction.
-   *
-   * Notes:
-   *
-   * This prop should use the @Prop decorator and reflect.
-   * The `disabled` Sass mixin must be added to the component's stylesheet.
-   */
-  disabled: boolean;
-}
-declare type HostIsTabbablePredicate = () => boolean;
-/**
- * This helper updates the host element to prevent keyboard interaction on its subtree and sets the appropriate aria attribute for accessibility.
- *
- * This should be used in the `componentDidRender` lifecycle hook.
- *
- * **Notes**
- *
- * this util is not needed for simple components whose root element or elements are an interactive component (custom element or native control). For those cases, set the `disabled` props on the root components instead.
- * technically, users can override `tabindex` and restore keyboard navigation, but this will be considered user error
- *
- * @param component
- * @param hostIsTabbable
- */
-export declare function updateHostInteraction(component: InteractiveComponent, hostIsTabbable?: boolean | HostIsTabbablePredicate | "managed"): void;
-export {};
+export interface InteractiveComponent {
+  /**
+   * The host element.
+   */
+  readonly el: HTMLElement;
+  /**
+   * When true, prevents user interaction.
+   *
+   * Notes:
+   *
+   * This prop should use the @Prop decorator and reflect.
+   * The `disabled` Sass mixin must be added to the component's stylesheet.
+   */
+  disabled: boolean;
+}
+declare type HostIsTabbablePredicate = () => boolean;
+/**
+ * This helper updates the host element to prevent keyboard interaction on its subtree and sets the appropriate aria attribute for accessibility.
+ *
+ * This should be used in the `componentDidRender` lifecycle hook.
+ *
+ * **Notes**
+ *
+ * this util is not needed for simple components whose root element or elements are an interactive component (custom element or native control). For those cases, set the `disabled` props on the root components instead.
+ * technically, users can override `tabindex` and restore keyboard navigation, but this will be considered user error
+ *
+ * @param component
+ * @param hostIsTabbable
+ */
+export declare function updateHostInteraction(component: InteractiveComponent, hostIsTabbable?: boolean | HostIsTabbablePredicate | "managed"): void;
+export {};

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

@@ -1,3 +1,3 @@
-export declare function isActivationKey(key: string): boolean;
-export declare const numberKeys: string[];
-export declare const letterKeys: string[];
+export declare function isActivationKey(key: string): boolean;
+export declare const numberKeys: string[];
+export declare const letterKeys: string[];

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

@@ -1,48 +1,48 @@
-export interface LabelableComponent {
-  /**
-   * When true, disabled prevents interaction.
-   */
-  disabled: boolean;
-  /**
-   * The host element.
-   */
-  readonly el: HTMLElement;
-  /**
-   * Text label.
-   */
-  label?: string;
-  /**
-   * The label this component is associated with.
-   */
-  labelEl: HTMLCalciteLabelElement;
-  /**
-   * Hook for components to provide custom label click behavior.
-   */
-  onLabelClick: (event: CustomEvent<any>) => void;
-}
-/**
- * Exported for testing purposes only
- *
- * @internal
- */
-export declare const labelClickEvent = "calciteInternalLabelClick";
-export declare const labelConnectedEvent = "calciteInternalLabelConnected";
-export declare const labelDisconnectedEvent = "calciteInternaLabelDisconnected";
-/**
- * Helper to set up label interactions on connectedCallback.
- *
- * @param component
- */
-export declare function connectLabel(component: LabelableComponent): void;
-/**
- * Helper to tear down label interactions on disconnectedCallback on labelable components.
- *
- * @param component
- */
-export declare function disconnectLabel(component: LabelableComponent): void;
-/**
- * Helper to get the label text from a component.
- *
- * @param component
- */
-export declare function getLabelText(component: LabelableComponent): string;
+export interface LabelableComponent {
+  /**
+   * When true, disabled prevents interaction.
+   */
+  disabled: boolean;
+  /**
+   * The host element.
+   */
+  readonly el: HTMLElement;
+  /**
+   * Text label.
+   */
+  label?: string;
+  /**
+   * The label this component is associated with.
+   */
+  labelEl: HTMLCalciteLabelElement;
+  /**
+   * Hook for components to provide custom label click behavior.
+   */
+  onLabelClick: (event: CustomEvent<any>) => void;
+}
+/**
+ * Exported for testing purposes only
+ *
+ * @internal
+ */
+export declare const labelClickEvent = "calciteInternalLabelClick";
+export declare const labelConnectedEvent = "calciteInternalLabelConnected";
+export declare const labelDisconnectedEvent = "calciteInternaLabelDisconnected";
+/**
+ * Helper to set up label interactions on connectedCallback.
+ *
+ * @param component
+ */
+export declare function connectLabel(component: LabelableComponent): void;
+/**
+ * Helper to tear down label interactions on disconnectedCallback on labelable components.
+ *
+ * @param component
+ */
+export declare function disconnectLabel(component: LabelableComponent): void;
+/**
+ * Helper to get the label text from a component.
+ *
+ * @param component
+ */
+export declare function getLabelText(component: LabelableComponent): string;

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

@@ -1,7 +1,7 @@
-export declare const locales: string[];
-export declare function createLocaleNumberFormatter(locale: string, numberingSystem?: string): Intl.NumberFormat;
-export declare function delocalizeNumberString(numberString: string, locale: string): string;
-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;
+export declare const locales: string[];
+export declare function createLocaleNumberFormatter(locale: string, numberingSystem?: string): Intl.NumberFormat;
+export declare function delocalizeNumberString(numberString: string, locale: string): string;
+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;

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

@@ -1,2 +1,2 @@
-export declare const clamp: (value: number, min: number, max: number) => number;
-export declare const decimalPlaces: (value: number) => number;
+export declare const clamp: (value: number, min: number, max: number) => number;
+export declare const decimalPlaces: (value: number) => number;

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

@@ -1,23 +1,23 @@
-export declare class BigDecimal {
-  value: bigint;
-  isNegative: boolean;
-  static DECIMALS: number;
-  static ROUNDED: boolean;
-  static SHIFT: bigint;
-  constructor(input: string | BigDecimal);
-  static _divRound(dividend: bigint, divisor: bigint): bigint;
-  static fromBigInt(bigint: bigint): bigint;
-  toString(): string;
-  formatToParts(locale: string, numberingSystem?: string): Intl.NumberFormatPart[];
-  add(num: string): bigint;
-  subtract(num: string): bigint;
-  multiply(num: string): bigint;
-  divide(num: string): bigint;
-}
-export declare function isValidNumber(numberString: string): boolean;
-export declare function parseNumberString(numberString?: string): string;
-export declare function sanitizeDecimalString(decimalString: string): string;
-export declare function sanitizeNegativeString(negativeString: string): string;
-export declare function sanitizeLeadingZeroString(zeroString: string): string;
-export declare function sanitizeNumberString(numberString: string): string;
-export declare function sanitizeExponentialNumberString(numberString: string, func: (s: string) => string): string;
+export declare class BigDecimal {
+  value: bigint;
+  isNegative: boolean;
+  static DECIMALS: number;
+  static ROUNDED: boolean;
+  static SHIFT: bigint;
+  constructor(input: string | BigDecimal);
+  static _divRound(dividend: bigint, divisor: bigint): bigint;
+  static fromBigInt(bigint: bigint): bigint;
+  toString(): string;
+  formatToParts(locale: string, numberingSystem?: string): Intl.NumberFormatPart[];
+  add(num: string): bigint;
+  subtract(num: string): bigint;
+  multiply(num: string): bigint;
+  divide(num: string): bigint;
+}
+export declare function isValidNumber(numberString: string): boolean;
+export declare function parseNumberString(numberString?: string): string;
+export declare function sanitizeDecimalString(decimalString: string): string;
+export declare function sanitizeNegativeString(negativeString: string): string;
+export declare function sanitizeLeadingZeroString(zeroString: string): string;
+export declare function sanitizeNumberString(numberString: string): string;
+export declare function sanitizeExponentialNumberString(numberString: string, func: (s: string) => string): string;

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

@@ -1,13 +1,13 @@
-declare type ObserverType = "mutation" | "intersection" | "resize";
-declare type ObserverCallbackType<T extends ObserverType> = T extends "mutation" ? MutationCallback : T extends "intersection" ? IntersectionObserverCallback : T extends "resize" ? ResizeObserverCallback : never;
-declare type ObserverOptions<T extends ObserverType> = T extends "mutation" ? MutationObserverInit : T extends "intersection" ? IntersectionObserverInit : T extends "resize" ? never : never;
-declare type ObserverInstanceType<T extends ObserverType> = T extends "mutation" ? MutationObserver : T extends "intersection" ? IntersectionObserver : T extends "resize" ? ResizeObserver : never;
-/**
- * This utility ensures observers are created only for browser contexts.
- *
- * @param type - the type of observer to create
- * @param callback - the observer callback
- * @param options - the observer options
- */
-export declare function createObserver<T extends ObserverType>(type: T, callback: ObserverCallbackType<T>, options?: ObserverOptions<T>): ObserverInstanceType<T> | undefined;
-export {};
+declare type ObserverType = "mutation" | "intersection" | "resize";
+declare type ObserverCallbackType<T extends ObserverType> = T extends "mutation" ? MutationCallback : T extends "intersection" ? IntersectionObserverCallback : T extends "resize" ? ResizeObserverCallback : never;
+declare type ObserverOptions<T extends ObserverType> = T extends "mutation" ? MutationObserverInit : T extends "intersection" ? IntersectionObserverInit : T extends "resize" ? never : never;
+declare type ObserverInstanceType<T extends ObserverType> = T extends "mutation" ? MutationObserver : T extends "intersection" ? IntersectionObserver : T extends "resize" ? ResizeObserver : never;
+/**
+ * This utility ensures observers are created only for browser contexts.
+ *
+ * @param type - the type of observer to create
+ * @param callback - the observer callback
+ * @param options - the observer options
+ */
+export declare function createObserver<T extends ObserverType>(type: T, callback: ObserverCallbackType<T>, options?: ObserverOptions<T>): ObserverInstanceType<T> | undefined;
+export {};