@arcgis/toolkit 5.2.0-next.11 → 5.2.0-next.110

package/dist/dom/index.d.ts

@@ -1,117 +0,0 @@
-import { nil } from '../type/index.ts';
-export * from './slots.ts';
-export * from './reference-element.ts';
-/**
- * Combine multiple class names into a single string.
- *
- * @remarks
- * This function is less necessary in Lumina packages as the `class` JSX prop
- * accepts `Record<string, boolean>` objects.
- */
-export declare const classes: (...classes: (nil | Record<string, boolean> | string[] | string | false)[]) => string;
-/**
- * Observe the element and its ancestors for attribute mutations.
- * If the attributes have been changed in the ancestor tree then the callback
- * will be invoked.
- *
- * @param element The element on which to observe the attribute mutations.
- * @param attributeFilter The list of attributes to observe.
- * @param callback The callback to invoke when the attributes have been changed.
- * @returns A callback to unsubscribe from the observer.
- *
- * @example
- * ```ts
- * observeAncestorsMutation(
- *   element,
- *   ["dir", "lang"],
- *   () => console.log(getElementAttribute(element, "dir", "ltr"))
- * );
- * ```
- */
-export declare const observeAncestorsMutation: (element: Node, attributeFilter: string[], callback: () => void) => (() => void);
-/**
- * Find the closest element that matches the selector.
- * It will traverse the element's ancestors to find the target element.
- * Shadow DOM boundaries are also taken into account.
- * @param base The element to start the search from.
- * @param selector The selector to match.
- * @returns The closest element that matches the selector or null if not found.
- *
- * @remarks
- * This is similar to [Element.closest()](https://developer.mozilla.org/docs/Web/API/Element/closest),
- * but the DOM's utility only looks up until the first shadow boundary.
- *
- * @example
- * ```ts
- * const hostElement = getClosestElement(element, "arcgis-map, arcgis-scene");
- * ```
- */
-export declare const getClosestElement: <T = Element>(base: Element, selector: string) => T | undefined;
-/**
- * Use the closest Calcite mode class name to determine the
- * theme of the element. It will traverse the element's
- * ancestors to find the theme. Shadow DOM boundaries are also
- * taken into account.
- *
- * @param base The element to start the search from.
- * @returns The theme of the element ("light" or "dark"). "light" is the default.
- *
- * @remarks
- * It is advised to consider alternative solutions before using this utility:
- * - Calcite CSS variables. Benefits: makes styles more consistent,
- *   and variables are updated automatically to match dark/light theme.
- * - Detect dark mode using CSS selectors and apply styles in CSS.
- *   Benefit: styles update automatically when the theme changes.
- */
-export declare function unsafeGetCalciteModeName(el: HTMLElement): "dark" | "light";
-/**
- * Get direction property of the closest element.
- *
- * @param el The element to start the search from.
- * @returns The direction of the element ("ltr" | "rtl"). "ltr" is the default.
- *
- * @remarks
- * Do not set the `dir` property on the element itself. Do not set the `dir`
- * attribute on the components you are rendering. The `dir` attribute is only
- * meant to be set by the consumers of your component. Your component is
- * expected to respect what was set by the consumer.
- *
- * @remarks
- * Prefer [useDirection()](https://webgis.esri.com/references/lumina/controllers/useDirection)
- * to ensure your component is responsive to direction changes.
- */
-export declare const unsafeGetElementDirection: (el: HTMLElement) => "ltr" | "rtl";
-/**
- * Get the attribute value from the element or closest ancestor.
- * Shadow DOM boundaries are also taken into account.
- * If the attribute is not found then the fallback value is returned.
- *
- * @example
- * ```ts
- * const dir = getElementAttribute(element, "dir", "ltr");
- * ```
- */
-export declare const getElementAttribute: (el: Element, attributeName: string, fallbackValue: string) => string;
-/**
- * Focus the element if it is focusable.
- * @returns A promise that resolves once the focus is set.
- */
-export declare const focusElement: (el: FocusableElement | undefined) => Promise<void>;
-export interface FocusableElement extends HTMLElement {
-    setFocus?: () => Promise<void>;
-}
-/**
- * Set the focus on the element that matches the selector.
- * It will traverse the element's ancestors to find the target element.
- * Shadow DOM boundaries are also taken into account.
- * If the element is not found then the focus is not set.
- * Example: `setFocusOnElement(element, "[role='menuitem']");`
- * @param ref The element to start the search from.
- * @param selector The selector to match.
- * @returns Returns true if the focus is set on the element.
- *
- * @deprecated This function is doing too much. Import from `focusElement(getClosestElement())` from `@arcgis/toolkit/dom` instead.
- */
-export declare const setFocusOnElement: (ref: (Element & {
-    componentOnReady?: () => Promise<void>;
-}) | null | undefined, selector: string) => void;

package/dist/dom/reference-element.d.ts

@@ -1,6 +0,0 @@
-type ArcgisComponentBase<T> = {
-    el: HTMLElement;
-    referenceElement?: T | string | null | undefined;
-};
-export declare function resolveReferenceElement<T extends Element>(component: ArcgisComponentBase<T>, referenceElementString?: ArcgisComponentBase<T>["referenceElement"] | string): T | undefined;
-export {};

package/dist/intl/index.d.ts

@@ -1,124 +0,0 @@
-declare const supportedLocalesArray: ["ar", "bg", "bs", "ca", "cs", "da", "de", "el", "en", "es", "et", "fi", "fr", "he", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "nl", "nb", "no", "pl", "pt-BR", "pt-PT", "ro", "ru", "sk", "sl", "sr", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-HK", "zh-TW"];
-/**
- * The list of supported locales for ArcGIS Maps SDK for JavaScript components.
- */
-export declare const supportedLocales: Set<"hr" | "th" | "tr" | "el" | "ar" | "bg" | "bs" | "ca" | "cs" | "da" | "de" | "en" | "es" | "et" | "fi" | "fr" | "he" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "nl" | "nb" | "no" | "pl" | "pt-BR" | "pt-PT" | "ro" | "ru" | "sk" | "sl" | "sr" | "sv" | "uk" | "vi" | "zh-CN" | "zh-HK" | "zh-TW">;
-/**
- * TypeScript union type for each locale supported by WebGIS SDK
- */
-export type SupportedLocale = (typeof supportedLocalesArray)[number];
-/**
- * The default locale for WebGIS SDK.
- */
-export declare const defaultLocale = "en";
-/**
- * Fetch the T9N strings bundle for the given locale, assets path and prefix.
- * The locale must be one of the supported locales.
- * If the locale is not supported, it will default to 'en'.
- * If the T9N strings bundle cannot be found, it will default to 'en'.
- *
- * @param locale The locale for which to fetch the T9N strings
- * @param assetsPath The path to the assets folder where the T9N strings are located
- * @param prefix The prefix to use for the T9N strings file name.
- *
- * @remarks
- * Rather than using this function directly, prefer the
- * [useT9n()](https://webgis.esri.com/references/lumina/controllers/useT9n)
- * controller.
- *
- * @remarks
- * The function implements cache. Frequent calls are safe.
- *
- * @example
- * ```ts
- * // Will make a request for ./assets/coding-editor/t9n/messages.en.json
- * const t9nStrings = await fetchT9nStringsBundle(
- *   "en",
- *   getAssetPath("./assets/coding-editor/t9n"),
- *   "messages."
- * );
- * ```
- *
- * @see [Lumina asset handling](https://webgis.esri.com/references/lumina/assets)
- */
-export declare const fetchT9nStringsBundle: <Strings extends GenericT9nStrings>(locale: string, assetsPath: string, prefix?: string) => Promise<Strings>;
-/**
- * The interface for translated strings.
- */
-export interface GenericT9nStrings {
-    [key: string]: GenericT9nStrings | string;
-}
-/**
- * Get the locale of the given element.
- * It will look for the lang attribute on the element and its ancestors.
- * If not lang is found, it will default to 'en'.
- *
- * @returns an object with the `lang` and `t9nLocale` properties.
- *
- * @see [lang vs t9nLocale](https://webgis.esri.com/references/lumina/controllers/useT9n#difference-between-lang-and-t9nlocale).
- */
-export declare const getElementLocale: (element: HTMLElement) => {
-    readonly lang: string;
-    readonly t9nLocale: SupportedLocale;
-};
-/**
- * Try to parse any language string into one of the locales supported by WebGIS SDK.
- *
- * @remarks
- * Follows the ArcGIS Maps SDK for JavaScript locale support:
- * https://developers.arcgis.com/javascript/latest/localization/#locale-support
- *
- * If language includes a region code, but we don't have a bundle for it, the
- * language is normalized to the language code only.
- */
-export declare const normalizeLocale: (lang: string) => SupportedLocale;
-export interface LocaleObserverResult<Strings extends GenericT9nStrings = GenericT9nStrings> {
-    /** The T9N strings of the component */
-    t9nStrings: Strings;
-    /**
-     * The locale of the component set by the `lang` attribute on the component host element or one of its ancestors.
-     */
-    lang: string;
-    /**
-     * The locale used by the component to load the T9N strings.
-     * It may be different than the locale of the component host element that was set by the `lang` attribute.
-     */
-    t9nLocale: SupportedLocale;
-}
-/**
- * Start the locale observer for the given component.
- * The callback will be called when the locale changes for the component.
- * It will observe the lang attribute on the component and its ancestors.
- * The callback is called once at the beginning.
- *
- * @param element The HTML element that is doing the fetching
- *   This is used to determine the locale to fetch, observe the `lang` attribute
- *   changes, and is used as the default value for the `assetName` parameter.
- * @param getAssetsPath The callback to get path to the assets folder where the
- *   T9N strings are located.
- * @param onUpdated The callback to call when the locale changes.
- * @param assetName Optionally override the asset file name.
- *   Default file name is the element tag name without the part before the
- *   first dash (e.g. `arcgis-map` becomes `map`).
- *
- *   Set to null if the component has no localization strings, but you still
- *   wish to use `startLocaleObserver` to get the locale information.
- *
- * @remarks
- * Rather than using this function directly, prefer the
- * [useT9n()](https://webgis.esri.com/references/lumina/controllers/useT9n)
- * controller.
- *
- * @example
- * ```ts
- * const observer = startLocaleObserver(
- *   element,
- *   () => getAssetPath("./assets"),
- *   ({ strings, lang, t9nLocale }) => console.log({ strings, lang, t9nLocale }),
- * );
- * // Later: cleanup
- * observer();
- * ```
- */
-export declare const startLocaleObserver: <Strings extends GenericT9nStrings = GenericT9nStrings>(element: HTMLElement, getAssetsPath: () => string, onUpdated: (payload: LocaleObserverResult<Strings>) => void, assetName?: string | null) => (() => void);
-export {};

package/dist/predicate/index.d.ts

@@ -1,24 +0,0 @@
-import { nil } from '../type/index.ts';
-/**
- * Safeguard to ensure that an item is not undefined.
- * @param item The item to check.
- * @returns Returns true if the item is not undefined.
- * @example
- * ```ts
- * const arr = [1, undefined, 3];
- * const result = arr.filter(isNotUndefined);
- * ```
- */
-export declare const isNotUndefined: <T>(item: T | undefined) => item is T;
-/**
- * Safeguard to ensure that an item is not null.
- * @param item The item to check.
- * @returns Returns true if the item is not null.
- */
-export declare const isNotNull: <T>(item: T | null) => item is T;
-/**
- * Safeguard to ensure that an item is not null.
- * @param item The item to check.
- * @returns Returns true if the item is not and not undefined and not null.
- */
-export declare const isNotNil: <T>(x: nil | T) => x is T;

package/dist/predicate/index.js

@@ -1,8 +0,0 @@
-const isNotUndefined = (item) => item !== void 0;
-const isNotNull = (item) => item !== null;
-const isNotNil = (x) => x != null;
-export {
-  isNotNil,
-  isNotNull,
-  isNotUndefined
-};