@esri/calcite-components 5.0.0-next.8 → 5.0.0-next.81

package/dist/utils/array.d.ts

@@ -1 +0,0 @@
-export declare function getRoundRobinIndex(index: number, total: number): number;

package/dist/utils/browser.d.ts

@@ -1 +0,0 @@
-export declare function getUserAgentString(): string;

package/dist/utils/component.d.ts

@@ -1,34 +0,0 @@
-import { LitElement } from '@arcgis/lumina';
-import { Scale } from '../components/interfaces';
-import { ComboboxChildElement } from '../components/calcite-combobox/interfaces';
-import { StepperItem } from '../components/calcite-stepper-item/customElement.js';
-import { TableRow } from '../components/calcite-table-row/customElement.js';
-export declare function getIconScale(componentScale: Scale): Extract<Scale, "s" | "m">;
-/**
- * This utility logs a warning message when a required property is missing.
- *
- * Note: this should only be used for cases where using the @required JSDoc tag is not possible, such as:
- * - when a required property is being deprecated
- * - when a required property can be computed from another property
- *
- * @param component the component that requires the property
- * @param newProp the new property that is required
- * @param deprecatedProp the deprecated property that is required
- */
-export declare function warnIfMissingRequiredProp<C extends LitElement>(component: C, newProp: keyof C, deprecatedProp: keyof C): void;
-export declare function isHidden<C extends ComboboxChildElement | HTMLCalciteStepperItemElement | HTMLCalciteTableRowElement>(el: C): boolean;
-/**
- * This helper util can be used to ensuring the component is loaded and rendered by the browser (The "componentOnReady" lifecycle method has been called and any internal elements are focusable).
- *
- * A component developer can await this method before proceeding with any logic that requires a component to be loaded first and then an internal element be focused.
- *
- * @example
- * async focusPart(): Promise<void> {
- *   await componentFocusable(this);
- *   this.internalElement?.focus();
- * }
- *
- * @param component
- * @returns Promise<void>
- */
-export declare function componentFocusable(component: LitElement): Promise<void>;

package/dist/utils/dynamicClasses.d.ts

@@ -1,2 +0,0 @@
-import { Scale, Width, Height } from '../components/interfaces';
-export declare function getDimensionClass(type: "width" | "height", size: Width | Height, scale: Scale): `${typeof type}-${Scale | Width | Height}`;

package/dist/utils/filter.d.ts

@@ -1 +0,0 @@
-export declare const filter: (data: Array<object>, value: string, filterProps?: string[]) => Array<any>;

package/dist/utils/focusTrapComponent.d.ts

@@ -1,78 +0,0 @@
-import { FocusTrap as _FocusTrap, Options as FocusTrapOptions } from 'focus-trap';
-/** Defines interface for components with a focus trap. Focusable content is required for components implementing focus trapping with this interface. */
-export interface FocusTrapComponent {
-    /** The focus trap element. */
-    el: HTMLElement;
-    /** When `true`, prevents focus trapping. */
-    focusTrapDisabled?: boolean;
-    /** When defined, provides a condition to disable focus trapping. When `true`, prevents focus trapping. */
-    focusTrapDisabledOverride?: () => boolean;
-    /** The focus trap instance. */
-    focusTrap: FocusTrap;
-    /**
-     * Specifies custom focus trap configuration on the component, where
-     *
-     * `"allowOutsideClick`" allows outside clicks,
-     * `"initialFocus"` enables initial focus,
-     * `"returnFocusOnDeactivate"` returns focus when not active, and
-     * `"extraContainers"` specifies additional focusable elements external to the trap (e.g., 3rd-party components appending elements to the document body).
-     * `"setReturnFocus"` customizes the element to which focus is returned when the trap is deactivated. Return `false` to prevent focus return, or `undefined` to use the default behavior (returning focus to the element focused before activation).
-     */
-    focusTrapOptions?: Partial<FocusTrapOptions>;
-    /**
-     * Method to update the element(s) that are used within the FocusTrap component.
-     *
-     * This should be implemented for components that allow user content and/or have conditionally-rendered focusable elements within the trap.
-     */
-    updateFocusTrapElements?: () => Promise<void>;
-}
-export type FocusTrap = _FocusTrap;
-interface ConnectFocusTrapOptions {
-    /** This option allows the focus trap to be created on a different element that's not the host (e.g., a supporting popup component). */
-    focusTrapEl?: HTMLElement;
-    /** This allows specifying overrides to ConnectFocusTrap options. */
-    focusTrapOptions?: Omit<FocusTrapOptions, "document" | "tabbableOptions" | "trapStack">;
-}
-/**
- * Helper to set up the FocusTrap component.
- *
- * @param {FocusTrapComponent} component The FocusTrap component.
- * @param options
- */
-export declare function connectFocusTrap(component: FocusTrapComponent, options?: ConnectFocusTrapOptions): void;
-/**
- * Helper to create the FocusTrap options.
- *
- * @param hostEl
- * @param options
- */
-export declare function createFocusTrapOptions(hostEl: HTMLElement, options?: FocusTrapOptions): FocusTrapOptions;
-/**
- * Helper to activate the FocusTrap component.
- *
- * @param {FocusTrapComponent} component The FocusTrap component.
- * @param [options] The FocusTrap activate options.
- */
-export declare function activateFocusTrap(component: FocusTrapComponent, options?: Parameters<_FocusTrap["activate"]>[0]): void;
-/**
- * Helper to deactivate the FocusTrap component.
- *
- * @param {FocusTrapComponent} component The FocusTrap component.
- * @param [options] The FocusTrap deactivate options.
- */
-export declare function deactivateFocusTrap(component: FocusTrapComponent, options?: Parameters<_FocusTrap["deactivate"]>[0]): void;
-/**
- * Helper to update the element(s) that are used within the FocusTrap component.
- *
- * @param {FocusTrapComponent} component The FocusTrap component.
- *
- * @example
- * const dialog = document.querySelector("calcite-dialog");
- * const input = document.createElement("calcite-input");
- * content.appendChild(input);
- * await input.componentOnReady();
- * await dialog.updateFocusTrapElements();
- * requestAnimationFrame(() => input.setFocus());
- */
-export declare function updateFocusTrapElements(component: FocusTrapComponent): void;
-export {};

package/dist/utils/globalScript.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/guid.d.ts

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

package/dist/utils/interactive.d.ts

@@ -1,41 +0,0 @@
-import { TemplateResult } from 'lit-html';
-import { JsxNode, LitElement, LuminaJsx } from '@arcgis/lumina';
-export interface InteractiveComponent extends LitElement {
-    /**
-     * 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;
-}
-/**
- * Exported for testing purposes only.
- *
- * @private
- */
-export type InteractiveHTMLElement = HTMLElement & Pick<InteractiveComponent, "disabled">;
-/**
- * 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
- */
-export declare function updateHostInteraction(component: InteractiveComponent): void;
-export interface InteractiveContainerProps extends LuminaJsx.CustomAttributes {
-    disabled: boolean;
-}
-export declare const CSS: {
-    container: string;
-};
-export declare const InteractiveContainer: ({ children, disabled, }: InteractiveContainerProps & {
-    children: JsxNode;
-}) => TemplateResult;

package/dist/utils/key.d.ts

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

package/dist/utils/label.d.ts

@@ -1,45 +0,0 @@
-import { Label } from '../components/calcite-label/customElement.js';
-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
- *
- * @private
- */
-export declare const labelClickEvent = "calciteInternalLabelClick";
-export declare const labelConnectedEvent = "calciteInternalLabelConnected";
-export declare const labelDisconnectedEvent = "calciteInternalLabelDisconnected";
-/**
- * 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;
-/**
- * Helper to associate an explicit label (i.e., using `for`) with a labelable component that does not have an associated label.
- *
- * @param label - the label element
- */
-export declare function associateExplicitLabelToUnlabeledComponent(label: HTMLCalciteLabelElement): Promise<void>;

package/dist/utils/math.d.ts

@@ -1,22 +0,0 @@
-export declare const clamp: (value: number, min: number, max: number) => number;
-/**
- * Returns the quantity of real decimal places for a number, which excludes trailing zeros.
- *
- * Adapted from {@link https://stackoverflow.com/questions/10454518/javascript-how-to-retrieve-the-number-of-decimals-of-a-string-number}.
- *
- * @param decimal - decimal value
- * @param value
- * @returns {number} the amount of decimal places in a number
- */
-export declare const decimalPlaces: (value: number | string) => number;
-export declare function getDecimals(value: number): number;
-export declare function remap(value: number, fromMin: number, fromMax: number, toMin: number, toMax: number): number;
-/**
- * Helper to determine if a value is close to the edge of a range within a threshold.
- *
- * @param value
- * @param range
- * @param threshold
- * @returns -1 if close to lower edge, 1 if close to upper edge, 0 otherwise.
- */
-export declare function closeToRangeEdge(value: number, range: number, threshold: number): number;

package/dist/utils/mode.d.ts

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

package/dist/utils/number.d.ts

@@ -1,45 +0,0 @@
-import { NumberStringFormat } from './locale';
-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) => BigDecimal;
-    static fromBigInt: (bigint: bigint) => BigDecimal;
-    getIntegersAndDecimals(): {
-        integers: string;
-        decimals: string;
-    };
-    toString(): string;
-    formatToParts(formatter: NumberStringFormat): Intl.NumberFormatPart[];
-    format(formatter: NumberStringFormat): string;
-    add(n: string): BigDecimal;
-    subtract(n: string): BigDecimal;
-    multiply(n: string): BigDecimal;
-    divide(n: string): BigDecimal;
-}
-export declare function isValidNumber(numberString: string): boolean;
-export declare function parseNumberString(numberString?: string): string;
-export declare const sanitizeNumberString: (numberString: string) => string;
-export declare function getBigDecimalAsString(sanitizedValue: string): string;
-export declare function sanitizeExponentialNumberString(numberString: string, func: (s: string) => string): string;
-/**
- * Converts an exponential notation numberString into decimal notation.
- * BigInt doesn't support exponential notation, so this is required to maintain precision
- *
- * @param {string} numberString - pre-validated exponential or decimal number
- * @returns {string} numberString in decimal notation
- */
-export declare function expandExponentialNumberString(numberString: string): string;
-/**
- * Adds localized trailing decimals zero values to the number string.
- * BigInt conversion to string removes the trailing decimal zero values (Ex: 1.000 is returned as 1). This method helps adding them back.
- *
- * @param {string} localizedValue - localized number string value
- * @param {string} value - current value in the input field
- * @param {NumberStringFormat} formatter - numberStringFormatter instance to localize the number value
- * @returns {string} localized number string value
- */
-export declare function addLocalizedTrailingDecimalZeros(localizedValue: string, value: string, formatter: NumberStringFormat): string;

package/dist/utils/observers.d.ts

@@ -1,29 +0,0 @@
-export interface ExtendedMutationObserver extends MutationObserver {
-    new: () => ExtendedMutationObserver;
-    unobserve: (target: Node) => void;
-}
-type ObserverType = "mutation" | "intersection" | "resize";
-type ObserverCallbackType<T extends ObserverType> = T extends "mutation" ? MutationCallback : T extends "intersection" ? IntersectionObserverCallback : T extends "resize" ? ResizeObserverCallback : never;
-type ObserverOptions<T extends ObserverType> = T extends "intersection" ? IntersectionObserverInit : never;
-type ObserverInstanceType<T extends ObserverType> = T extends "mutation" ? ExtendedMutationObserver : 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;
-/**
- * This utility helps to safely update observers within a ref callback
- * by unobserving the old target and observing the new target.
- *
- * Note: this should be called before the ref is updated
- *
- * @param observer
- * @param oldTarget
- * @param target
- * @param options
- */
-export declare function updateRefObserver<T extends ObserverType>(observer: ObserverInstanceType<T> | undefined, oldTarget: Element | undefined, target: Element | undefined, options?: ObserverOptions<T>): void;
-export {};

package/dist/utils/openCloseComponent.d.ts

@@ -1,52 +0,0 @@
-import { KebabCase } from 'type-fest';
-import { LitElement } from '@arcgis/lumina';
-import { Ref } from 'lit/directives/ref.js';
-/**
- * Defines interface for components with open/close public emitter.
- * All implementations of this interface must handle the following events: `beforeOpen`, `open`, `beforeClose`, `close`.
- */
-interface OpenCloseComponentBase extends LitElement {
-    /**
-     * Specifies property on which active transition is watched for.
-     *
-     * This should be used if the component uses a property other than `open` to trigger a transition.
-     */
-    openProp?: string;
-    /** Specifies the name of CSS transition property. */
-    transitionProp?: KebabCase<Extract<keyof CSSStyleDeclaration, string>>;
-    /** 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;
-}
-export interface OpenCloseComponentWithEl extends OpenCloseComponentBase {
-    /** Specifies element that the transition is allowed to emit on. */
-    transitionEl: HTMLElement;
-}
-export interface OpenCloseComponentWithRef extends OpenCloseComponentBase {
-    /** Specifies a Ref to the element that the transition is allowed to emit on. */
-    transitionRef: Ref<HTMLElement>;
-}
-export type OpenCloseComponent = OpenCloseComponentWithEl | OpenCloseComponentWithRef;
-/**
- * This util helps emit (before)open/close events consistently based on the associated CSS transition property.
- *
- * Note: this should be called whenever the component's toggling property changes and would trigger a transition.
- *
- * @example
- * import { toggleOpenClose } from "../../utils/openCloseComponent";
- *
- * override willUpdate(changes: PropertyValues<this>): void {
- *   if (changes.has("open") && (this.hasUpdated || this.open !== false)) {
- *     toggleOpenClose(this);
- *   }
- *   // ...
- * }
- * @param component - OpenCloseComponent uses `open` prop to emit (before)open/close.
- */
-export declare function toggleOpenClose(component: OpenCloseComponent): Promise<void>;
-export {};

package/dist/utils/overflow.d.ts

@@ -1,28 +0,0 @@
-/**
- * Calculates the maximum number of items that can fit within a container.
- *
- * @param params - The parameters for the calculation.
- * @param params.bufferSize - The buffer size to subtract from the container size (default is 0).
- * @param params.containerSize - The total size of the container.
- * @param params.itemSizes - An array of sizes for each item.
- * @returns The maximum number of items that can fit within the container.
- */
-export declare const calculateMaxItems: ({ bufferSize, containerSize, itemSizes, }: {
-    bufferSize?: number;
-    containerSize: number;
-    itemSizes: number[];
-}) => number;
-/**
- * Calculates the number of items that overflow a container.
- *
- * @param params - The parameters for the calculation.
- * @param params.bufferSize - The buffer size to subtract from the container size (default is 0).
- * @param params.containerSize - The total size of the container.
- * @param params.itemSizes - An array of sizes for each item.
- * @returns The number of items that overflow the container.
- */
-export declare const getOverflowCount: ({ bufferSize, containerSize, itemSizes, }: {
-    bufferSize?: number;
-    containerSize: number;
-    itemSizes: number[];
-}) => number;

package/dist/utils/resources.d.ts

@@ -1,33 +0,0 @@
-import { ModeClass, ModeName } from '../components/interfaces';
-export declare const autoMode = "calcite-mode-auto";
-export declare const darkMode = "calcite-mode-dark";
-interface Mode {
-    name: ModeName;
-    className: ModeClass;
-}
-export declare const MODES: Mode[];
-export declare const CSS_UTILITY: {
-    autoMode: string;
-    darkMode: string;
-    lightMode: string;
-    rtl: string;
-    calciteAnimate: string;
-    calciteAnimateIn: string;
-    calciteAnimateInUp: string;
-    calciteAnimateInDown: string;
-    calciteAnimateInRight: string;
-    calciteAnimateInLeft: string;
-    calciteAnimateInScale: string;
-};
-export declare const TEXT: {
-    loading: string;
-};
-export declare const DEBOUNCE: {
-    filter: number;
-    nextTick: number;
-    resize: number;
-    reposition: number;
-};
-export declare const resizeStep = 10;
-export declare const resizeShiftStep = 25;
-export {};

package/dist/utils/responsive.d.ts

@@ -1,11 +0,0 @@
-export interface Breakpoints {
-    width: {
-        large: number;
-        medium: number;
-        small: number;
-        xsmall: number;
-        xxsmall: number;
-    };
-}
-/** A breakpoints lookup object. */
-export declare const breakpoints: Breakpoints;

package/dist/utils/selectableComponent.d.ts

@@ -1,17 +0,0 @@
-import { SelectionMode } from '../components/interfaces';
-/** Defines interface for group components that manage selection behavior of their children. */
-export interface SelectableGroupComponent {
-    /** An array of the selected items. */
-    selectedItems: SelectableComponent[];
-    /** Controls how items can be selected. */
-    selectionMode: Partial<SelectionMode>;
-}
-/** Defines interface for selectable components. */
-export interface SelectableComponent {
-    /**
-     * The selected state of the component.
-     *
-     * @private
-     */
-    selected: boolean;
-}

package/dist/utils/t9n.d.ts

@@ -1 +0,0 @@
-export type MessageBundle = Record<string, string>;

package/dist/utils/text.d.ts

@@ -1,22 +0,0 @@
-import { JsxNode } from '@arcgis/lumina';
-/**
- * Capitalizes the first letter in a provided word.
- * Assumes an unbroken string of text representing a single word.
- *
- * @param word string
- */
-export declare function capitalizeWord(word: string): string;
-/**
- * Highlight text based on a search pattern.
- *
- * Items using this in their rendering should include the `text-highlight-item` mixin from `includes.scss` in their styles.
- *
- * @param text.text
- * @param text
- * @param pattern
- * @param text.pattern
- */
-export declare function highlightText({ text, pattern, }: {
-    text: string;
-    pattern: RegExp;
-}): string | (string | JsxNode)[];