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

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,29 @@
-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;
+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;
+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;

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 {};

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

@@ -1,50 +1,50 @@
-/**
- * Defines interface for components with open/close public emitter.
- * All implementations of this interface must handle the following events: `beforeOpen`, `open`, `beforeClose`, `close`.
- */
-export interface OpenCloseComponent {
-  /**
-   * The host element.
-   */
-  readonly el: HTMLElement;
-  /**
-   * When true, the component opens.
-   */
-  open: boolean;
-  /**
-   * Specifies property on which active transition is watched for.
-   */
-  openTransitionProp: string;
-  /**
-   * Specifies element that the transition is allowed to emit on.
-   */
-  transitionEl: HTMLDivElement;
-  /**
-   * Defines method for `beforeOpen` event handler.
-   */
-  onBeforeOpen: () => void;
-  /**
-   * Defines method for `open` event handler:
-   */
-  onOpen: () => void;
-  /**
-   * Defines method for `beforeClose` event handler:
-   */
-  onBeforeClose: () => void;
-  /**
-   * Defines method for `close` event handler:
-   */
-  onClose: () => void;
-}
-/**
- * Helper to keep track of transition listeners on setTransitionEl and connectedCallback on OpenCloseComponent components.
- *
- * @param component
- */
-export declare function connectOpenCloseComponent(component: OpenCloseComponent): void;
-/**
- * Helper to tear down transition listeners on disconnectedCallback on OpenCloseComponent components.
- *
- * @param component
- */
-export declare function disconnectOpenCloseComponent(component: OpenCloseComponent): void;
+/**
+ * Defines interface for components with open/close public emitter.
+ * All implementations of this interface must handle the following events: `beforeOpen`, `open`, `beforeClose`, `close`.
+ */
+export interface OpenCloseComponent {
+  /**
+   * The host element.
+   */
+  readonly el: HTMLElement;
+  /**
+   * When true, the component opens.
+   */
+  open: boolean;
+  /**
+   * Specifies property on which active transition is watched for.
+   */
+  openTransitionProp: string;
+  /**
+   * Specifies element that the transition is allowed to emit on.
+   */
+  transitionEl: HTMLDivElement;
+  /**
+   * Defines method for `beforeOpen` event handler.
+   */
+  onBeforeOpen: () => void;
+  /**
+   * Defines method for `open` event handler:
+   */
+  onOpen: () => void;
+  /**
+   * Defines method for `beforeClose` event handler:
+   */
+  onBeforeClose: () => void;
+  /**
+   * Defines method for `close` event handler:
+   */
+  onClose: () => void;
+}
+/**
+ * Helper to keep track of transition listeners on setTransitionEl and connectedCallback on OpenCloseComponent components.
+ *
+ * @param component
+ */
+export declare function connectOpenCloseComponent(component: OpenCloseComponent): void;
+/**
+ * Helper to tear down transition listeners on disconnectedCallback on OpenCloseComponent components.
+ *
+ * @param component
+ */
+export declare function disconnectOpenCloseComponent(component: OpenCloseComponent): void;

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

@@ -1,18 +1,18 @@
-import { ThemeClass, ThemeName } from "../components/interfaces";
-export declare const autoTheme = "calcite-theme-auto";
-export declare const darkTheme = "calcite-theme-dark";
-interface Theme {
-  name: ThemeName;
-  className: ThemeClass;
-}
-export declare const THEMES: Theme[];
-export declare const CSS_UTILITY: {
-  autoTheme: string;
-  darkTheme: string;
-  lightTheme: string;
-  rtl: string;
-};
-export declare const TEXT: {
-  loading: string;
-};
-export {};
+import { ThemeClass, ThemeName } from "../components/interfaces";
+export declare const autoTheme = "calcite-theme-auto";
+export declare const darkTheme = "calcite-theme-dark";
+interface Theme {
+  name: ThemeName;
+  className: ThemeClass;
+}
+export declare const THEMES: Theme[];
+export declare const CSS_UTILITY: {
+  autoTheme: string;
+  darkTheme: string;
+  lightTheme: string;
+  rtl: string;
+};
+export declare const TEXT: {
+  loading: string;
+};
+export {};

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

@@ -1,4 +1,4 @@
-/**
- * Emits when the theme is dynamically toggled between light and dark on <body> or in OS preferences.
- */
-export declare function initThemeChangeEvent(): void;
+/**
+ * Emits when the theme is dynamically toggled between light and dark on <body> or in OS preferences.
+ */
+export declare function initThemeChangeEvent(): void;

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

@@ -1,29 +1,29 @@
-export declare type HourCycle = "12" | "24";
-export interface LocalizedTime {
-  localizedHour: string;
-  localizedHourSuffix: string;
-  localizedMinute: string;
-  localizedMinuteSuffix: string;
-  localizedSecond: string;
-  localizedSecondSuffix: string;
-  localizedMeridiem: string;
-}
-export declare type Meridiem = "AM" | "PM";
-export declare type MinuteOrSecond = "minute" | "second";
-export interface Time {
-  hour: string;
-  minute: string;
-  second: string;
-}
-export declare type TimePart = "hour" | "hourSuffix" | "minute" | "minuteSuffix" | "second" | "secondSuffix" | "meridiem";
-export declare const maxTenthForMinuteAndSecond = 5;
-export declare function formatTimePart(number: number): string;
-export declare function formatTimeString(value: string): string;
-export declare function getLocaleHourCycle(locale: string): HourCycle;
-export declare function getMeridiem(hour: string): Meridiem;
-export declare function isValidTime(value: string): boolean;
-export declare function localizeTimePart(value: string, part: TimePart, locale: string): string;
-export declare function localizeTimeString(value: string, locale?: string, includeSeconds?: boolean): string;
-export declare function localizeTimeStringToParts(value: string, locale?: string): LocalizedTime;
-export declare function getTimeParts(value: string, locale?: string): Intl.DateTimeFormatPart[];
-export declare function parseTimeString(value: string): Time;
+export declare type HourCycle = "12" | "24";
+export interface LocalizedTime {
+  localizedHour: string;
+  localizedHourSuffix: string;
+  localizedMinute: string;
+  localizedMinuteSuffix: string;
+  localizedSecond: string;
+  localizedSecondSuffix: string;
+  localizedMeridiem: string;
+}
+export declare type Meridiem = "AM" | "PM";
+export declare type MinuteOrSecond = "minute" | "second";
+export interface Time {
+  hour: string;
+  minute: string;
+  second: string;
+}
+export declare type TimePart = "hour" | "hourSuffix" | "minute" | "minuteSuffix" | "second" | "secondSuffix" | "meridiem";
+export declare const maxTenthForMinuteAndSecond = 5;
+export declare function formatTimePart(number: number): string;
+export declare function formatTimeString(value: string): string;
+export declare function getLocaleHourCycle(locale: string): HourCycle;
+export declare function getMeridiem(hour: string): Meridiem;
+export declare function isValidTime(value: string): boolean;
+export declare function localizeTimePart(value: string, part: TimePart, locale: string): string;
+export declare function localizeTimeString(value: string, locale?: string, includeSeconds?: boolean): string;
+export declare function localizeTimeStringToParts(value: string, locale?: string): LocalizedTime;
+export declare function getTimeParts(value: string, locale?: string): Intl.DateTimeFormatPart[];
+export declare function parseTimeString(value: string): Time;