@esri/calcite-components 5.0.0-next.66 → 5.0.0-next.67

package/dist/utils/dom.d.ts

@@ -13,51 +13,51 @@ export declare const tabbableOptions: {
  *
  * If it already has an ID, it will be preserved, otherwise a unique one will be generated and assigned.
  *
- * @param {Element} el An element.
- * @returns {string} The element's ID.
+ * @param el An element.
+ * @returns The element's ID.
  */
 export declare function ensureId(el: Element): string;
 /**
  * This helper returns an array from a NodeList.
  *
- * @param {NodeList} nodeList A NodeList.
- * @returns {Element[]} An array of elements.
+ * @param nodeList A NodeList.
+ * @returns An array of elements.
  */
 export declare function nodeListToArray<T extends Element>(nodeList: HTMLCollectionOf<T> | NodeListOf<T> | T[]): T[];
 export type Direction = "ltr" | "rtl";
 /**
  * This helper returns the Calcite "mode" of an element.
  *
- * @param {HTMLElement} el An element.
- * @returns {"light"|"dark"} The Calcite mode.
+ * @param el An element.
+ * @returns The Calcite mode.
  */
 export declare function getModeName(el: HTMLElement): "light" | "dark";
 /**
  * This helper returns the direction of a HTML element.
  *
- * @param {HTMLElement} el An element.
- * @returns {Direction} The direction.
+ * @param el An element.
+ * @returns The direction.
  */
 export declare function getElementDir(el: HTMLElement): Direction;
 /**
  * This helper returns the computed width in pixels of a rendered HTMLElement.
  *
- * @param {HTMLElement} el An element.
- * @returns {number} The element's width.
+ * @param el An element.
+ * @returns The element's width.
  */
 export declare function getElementWidth(el: HTMLElement): number;
 /**
  * This helper returns the rootNode of an element.
  *
- * @param {Element} el An element.
- * @returns {Document|ShadowRoot} The element's root node.
+ * @param el An element.
+ * @returns The element's root node.
  */
 export declare function getRootNode(el: Element): Document | ShadowRoot;
 /**
  * This helper returns the node's shadowRoot root node if it exists.
  *
- * @param {Element} el The element.
- * @returns {ShadowRoot|null} The element's root node ShadowRoot.
+ * @param el The element.
+ * @returns The element's root node ShadowRoot.
  */
 export declare function getShadowRootNode(el: Element): ShadowRoot | null;
 /**
@@ -65,27 +65,21 @@ export declare function getShadowRootNode(el: Element): ShadowRoot | null;
  *
  * See https://stackoverflow.com/questions/118241/calculate-text-width-with-javascript
  *
- * @param {string} text The string of text to measure.
- * @param {string} font The CSS font attribute's value, which should include size and face, e.g. "12px Arial".
+ * @param text The string of text to measure.
+ * @param font The CSS font attribute's value, which should include size and face, e.g. "12px Arial".
  */
 export declare function getTextWidth(text: string, font: string): number;
 /**
  * This helper returns the host of a ShadowRoot.
  *
- * @param {Document | ShadowRoot} root A root element.
- * @returns {Element | null} The host element.
+ * @param root A root element.
+ * @returns  The host element.
  */
 export declare function getHost(root: Document | ShadowRoot): Element | null;
 /**
  * This helper queries an element's rootNode and any ancestor rootNodes.
  *
  * If both an 'id' and 'selector' are supplied, 'id' will take precedence over 'selector'.
- *
- * @param {Element} el An element.
- * @param root0
- * @param root0.selector
- * @param root0.id
- * @returns {Element} An element.
  */
 export declare function queryElementRoots<T extends Element = Element>(el: Element, { selector, id, }: {
     selector?: string;
@@ -96,9 +90,9 @@ export declare function queryElementRoots<T extends Element = Element>(el: Eleme
  *
  * Based on https://stackoverflow.com/q/54520554/194216
  *
- * @param {Element} element The starting element.
- * @param {string} selector The selector.
- * @returns {Element} The targeted element.
+ * @param element The starting element.
+ * @param selector The selector.
+ * @returns The targeted element.
  */
 export declare function closestElementCrossShadowBoundary<TagName extends keyof HTMLElementTagNameMap>(element: Element, selector: TagName): HTMLElementTagNameMap[TagName] | null;
 export declare function closestElementCrossShadowBoundary<T extends Element = Element>(element: Element, selector: string): T | null;
@@ -107,9 +101,9 @@ export declare function closestElementCrossShadowBoundary<T extends Element = El
  *
  * Returning early or undefined in `onVisit` will continue traversing up the DOM tree. Otherwise, traversal will halt with the returned value as the result of the function
  *
- * @param {Element} element An element.
- * @param {(node: Node) => Element} onVisit The callback.
- * @returns {Element} The result.
+ * @param element An element.
+ * @param onVisit The callback.
+ * @returns The result.
  */
 export declare function walkUpAncestry<T = any>(element: Element, onVisit: (node: Node) => T): T;
 export type FocusableElement = SetFocusable | HTMLElement;
@@ -119,14 +113,14 @@ export interface SetFocusable extends LitElement {
 /**
  * This helper returns true when an element has a setFocus method.
  *
- * @param {Element} el An element.
- * @returns {boolean} Whether the element is focusable.
+ * @param el An element.
+ * @returns Whether the element is focusable.
  */
 export declare function isCalciteFocusable(el: FocusableElement): el is SetFocusable;
 /**
  * This helper focuses an element using the `setFocus` method if available and falls back to using the `focus` method if not available.
  *
- * @param {Element} el An element.
+ * @param el An element.
  * @param includeContainer When true, the container element will be considered as well. Note, this is only applicable when `setFocus` is not applicable.
  * @param strategy The focus strategy to use when finding the first focusable element. Defaults to "tabbable".
  * @param context The element invoking the focus – use when the host is focusable to short-circuit the focus call.
@@ -138,8 +132,8 @@ export declare function focusElement(el: FocusableElement, includeContainer?: bo
 /**
  * Helper to get the first tabbable element.
  *
- * @param {HTMLElement} element The html element containing tabbable elements.
- * @param {boolean} includeContainer When true, the container element will be considered as well.
+ * @param element The html element containing tabbable elements.
+ * @param includeContainer When true, the container element will be considered as well.
  *
  * @returns the first tabbable element.
  */
@@ -147,8 +141,8 @@ export declare function getFirstTabbable(element: HTMLElement, includeContainer?
 /**
  * Helper to focus the first tabbable element.
  *
- * @param {HTMLElement} element The html element containing tabbable elements.
- * @param {boolean} includeContainer When true, the container element will be considered as well.
+ * @param element The html element containing tabbable elements.
+ * @param includeContainer When true, the container element will be considered as well.
  * @param options - When specified an optional object customizes the component's focusing process. When `preventScroll` is `true`, scrolling will not occur on the component.
  *
  * @mdn [focus(options)](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#options)
@@ -157,34 +151,34 @@ export declare function focusFirstTabbable(element: HTMLElement, includeContaine
 /**
  * Filters direct children.
  *
- * @param {Element} el An element.
- * @param {string} selector The selector.
- * @returns {Element[]} An array of elements.
+ * @param el An element.
+ * @param selector The selector.
+ * @returns An array of elements.
  */
 export declare function filterDirectChildren<T extends Element>(el: Element, selector: string): T[];
 /**
  * Filters an array of HTML elements by the provided css selector string.
  *
- * @param {Element[]} elements An array of elements, such as one returned by HTMLSlotElement.assignedElements().
- * @param {string} selector The CSS selector string to filter the returned elements by.
- * @returns {Element[]} A filtered array of elements.
+ * @param elements An array of elements, such as one returned by HTMLSlotElement.assignedElements().
+ * @param selector The CSS selector string to filter the returned elements by.
+ * @returns A filtered array of elements.
  */
 export declare function filterElementsBySelector<T extends Element>(elements: Element[], selector: string): T[];
 /**
  * Set a default icon from a defined set or allow an override with an icon name string
  *
- * @param {Record<string, string>} iconObject The icon object.
- * @param {string | boolean} iconValue The icon value.
- * @param {string} matchedValue The matched value.
- * @returns {string|undefined} The resulting icon value.
+ * @param iconObject The icon object.
+ * @param iconValue The icon value.
+ * @param matchedValue The matched value.
+ * @returns The resulting icon value.
  */
 export declare function setRequestedIcon(iconObject: Record<string, IconName>, iconValue: IconName | boolean | "", matchedValue: string): IconName | undefined;
 /**
  * This helper returns true when two rectangles intersect.
  *
- * @param {DOMRect} rect1 The first rectangle.
- * @param {DOMRect} rect2 The second rectangle.
- * @returns {boolean} The result.
+ * @param rect1 The first rectangle.
+ * @param rect2 The second rectangle.
+ * @returns The result.
  */
 export declare function intersects(rect1: DOMRect, rect2: DOMRect): boolean;
 /**
@@ -192,8 +186,8 @@ export declare function intersects(rect1: DOMRect, rect2: DOMRect): boolean;
  *
  * It should only be used for aria attributes that require a string value of "true" or "false".
  *
- * @param {boolean} value The value.
- * @returns {string} The string conversion of a boolean value ("true" | "false").
+ * @param value The value.
+ * @returns The string conversion of a boolean value ("true" | "false").
  */
 export declare function toAriaBoolean(value: boolean): string;
 /**
@@ -203,8 +197,8 @@ export declare function toAriaBoolean(value: boolean): string;
  * <slot onSlotchange={(event) => this.mySlotHasContent = slotChangeHasContent(event)} />}
  * ```
  *
- * @param {Event} event The event.
- * @returns {boolean} Whether the slot has any content.
+ * @param event The event.
+ * @returns Whether the slot has any content.
  */
 export declare function slotChangeHasContent(event: Event): boolean;
 /**
@@ -214,15 +208,15 @@ export declare function slotChangeHasContent(event: Event): boolean;
  * <slot onSlotchange={(event) => this.mySlotText = slotChangeGetTextContent(event)} />}
  * ```
  *
- * @param {Event} event The event.
- * @returns {string} The slots text.
+ * @param event The event.
+ * @returns The slots text.
  */
 export declare function slotChangeGetTextContent(event: Event): string;
 /**
  * This helper checks if an element has visible content.
  *
- * @param {HTMLElement} element The element to check.
- * @returns {boolean} True if the element has visible content, otherwise false.
+ * @param element The element to check.
+ * @returns True if the element has visible content, otherwise false.
  */
 export declare function hasVisibleContent(element: HTMLElement): boolean;
 /**
@@ -232,8 +226,8 @@ export declare function hasVisibleContent(element: HTMLElement): boolean;
  * <slot onSlotchange={(event) => this.mySlotHasTextContent = slotChangeHasTextContent(event)} />}
  * ```
  *
- * @param {Event} event The event.
- * @returns {boolean} Whether the slot has any text content.
+ * @param event The event.
+ * @returns Whether the slot has any text content.
  */
 export declare function slotChangeHasTextContent(event: Event): boolean;
 /**
@@ -243,8 +237,8 @@ export declare function slotChangeHasTextContent(event: Event): boolean;
  * <slot onSlotchange={(event) => this.mySlotHasNode = slotChangeHasAssignedNode(event)} />}
  * ```
  *
- * @param {Event} event The event.
- * @returns {boolean} Whether the slot has any assigned nodes.
+ * @param event The event.
+ * @returns Whether the slot has any assigned nodes.
  */
 export declare function slotChangeHasAssignedNode(event: Event): boolean;
 /**
@@ -254,8 +248,8 @@ export declare function slotChangeHasAssignedNode(event: Event): boolean;
  * <slot onSlotchange={(event) => this.mySlotNodes = slotChangeGetAssignedNodes(event)} />}
  * ```
  *
- * @param {Event} event The event.
- * @returns {boolean} Whether the slot has any assigned nodes.
+ * @param event The event.
+ * @returns Whether the slot has any assigned nodes.
  */
 export declare function slotChangeGetAssignedNodes(event: Event): Node[];
 /**
@@ -265,8 +259,8 @@ export declare function slotChangeGetAssignedNodes(event: Event): Node[];
  * <slot onSlotchange={(event) => this.mySlotHasElement = slotChangeHasAssignedElement(event)} />}
  * ```
  *
- * @param {Event} event The event.
- * @returns {boolean} Whether the slot has any assigned elements.
+ * @param event The event.
+ * @returns Whether the slot has any assigned elements.
  */
 export declare function slotChangeHasAssignedElement(event: Event): boolean;
 /**
@@ -276,17 +270,17 @@ export declare function slotChangeHasAssignedElement(event: Event): boolean;
  * <slot onSlotchange={(event) => this.mySlotElements = slotChangeGetAssignedElements(event)} />}
  * ```
  *
- * @param {Event} event The event.
- * @param {string} selector The CSS selector string to filter the returned elements by.
- * @returns {Element[]} An array of elements.
+ * @param event The event.
+ * @param selector The CSS selector string to filter the returned elements by.
+ * @returns An array of elements.
  */
 export declare function slotChangeGetAssignedElements<T extends Element>(event: Event, selector?: string): T[] | null;
 /**
  * This helper returns the assigned elements on a `slot` element, filtered by an optional css selector.
  *
- * @param {HTMLSlotElement} slot The slot element.
- * @param {string} selector CSS selector string to filter the returned elements by.
- * @returns {Element[]} An array of elements.
+ * @param slot The slot element.
+ * @param selector CSS selector string to filter the returned elements by.
+ * @returns An array of elements.
  */
 export declare function getSlotAssignedElements<T extends Element>(slot: HTMLSlotElement, selector?: string): T[] | null;
 /**
@@ -294,28 +288,28 @@ export declare function getSlotAssignedElements<T extends Element>(slot: HTMLSlo
  *
  * See https://www.w3.org/TR/pointerevents/#the-button-property.
  *
- * @param {PointerEvent} event The pointer event.
- * @returns {boolean} The value.
+ * @param event The pointer event.
+ * @returns The value.
  */
 export declare function isPrimaryPointerButton(event: PointerEvent): boolean;
 /**
  * This helper returns true if the mouse event was triggered by a keyboard click.
  *
- * @param {MouseEvent} event The mouse event.
- * @returns {boolean} The value.
+ * @param event The mouse event.
+ * @returns The value.
  */
 export declare function isKeyboardTriggeredClick(event: MouseEvent): boolean;
 export type FocusElementInGroupDestination = "first" | "last" | "next" | "previous";
 /**
  * This helper sets focus on and returns a destination element from within a group of provided elements.
  *
- * @param {Element[]} elements An array of elements.
- * @param {Element} currentElement The current element.
- * @param {FocusElementInGroupDestination} destination The target destination element to focus.
- * @param {boolean} cycle Should navigation cycle through elements or stop at extent - defaults to true.
- * @param {boolean} includeContainer Determines whether the container element should be considered as well - defaults to true.
+ * @param elements An array of elements.
+ * @param currentElement The current element.
+ * @param destination The target destination element to focus.
+ * @param cycle Should navigation cycle through elements or stop at extent - defaults to true.
+ * @param includeContainer Determines whether the container element should be considered as well - defaults to true.
  * @param targetAsContext
- * @returns {Element} The focused element
+ * @returns The focused element
  */
 export declare const focusElementInGroup: <T extends Element = Element>(elements: Element[], currentElement: Element, destination: FocusElementInGroupDestination, cycle?: boolean, includeContainer?: boolean, targetAsContext?: boolean) => T;
 /**
@@ -361,8 +355,8 @@ export declare function nextFrame(): Promise<void>;
  * - If the value ends with "vh", it calculates the pixel value based on the viewport height.
  * - For unsupported units or invalid values, it returns 0.
  *
- * @param {string} value - The CSS style value to convert (e.g., "10px", "50vw", "30vh").
- * @returns {number} The pixel equivalent of the provided value.
+ * @param value - The CSS style value to convert (e.g., "10px", "50vw", "30vh").
+ * @returns The pixel equivalent of the provided value.
  */
 export declare function getStylePixelValue(value: string): number;
 /**

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

@@ -138,7 +138,6 @@ export declare function getEffectivePlacement(placement: LogicalPlacement, isRTL
  * @param options.arrowEl - A customizable arrow element.
  * @param options.type - The type of floating UI.
  * @param delayed - Reposition the component after a delay.
- * @returns {Promise<void>}
  */
 export declare function reposition(component: FloatingUIComponent, options: Parameters<typeof positionFloatingUI>[1], delayed?: boolean): Promise<void>;
 type PendingFloatingUIState = {
@@ -165,7 +164,6 @@ export declare function hideFloatingUI(component: FloatingUIComponent): void;
  * Helper to set up floating element interactions on connectedCallback.
  *
  * @param component - A floating-ui component.
- * @returns {Promise<void>}
  */
 export declare function connectFloatingUI(component: FloatingUIComponent): Promise<void>;
 /**

package/dist/utils/locale.d.ts

@@ -94,7 +94,7 @@ export declare const getSupportedNumberingSystem: (numberingSystem: string) => N
  * @see https://github.com/Esri/calcite-design-system/issues/9387
  *
  * @param locale – the BCP 47 locale code
- * @returns {string} a BCP 47 locale code
+ * @returns a BCP 47 locale code
  */
 export declare function getDateFormatSupportedLocale(locale: string): string;
 export interface NumberStringFormatOptions extends Intl.NumberFormatOptions {

package/dist/utils/math.d.ts

@@ -6,7 +6,7 @@ export declare const clamp: (value: number, min: number, max: number) => number;
  *
  * @param decimal - decimal value
  * @param value
- * @returns {number} the amount of decimal places in a number
+ * @returns the amount of decimal places in a number
  */
 export declare const decimalPlaces: (value: number | string) => number;
 export declare function getDecimals(value: number): number;

package/dist/utils/number.d.ts

@@ -29,17 +29,17 @@ export declare function sanitizeExponentialNumberString(numberString: string, fu
  * 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
+ * @param numberString - pre-validated exponential or decimal number
+ * @returns 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
+ * @param localizedValue - localized number string value
+ * @param value - current value in the input field
+ * @param formatter - numberStringFormatter instance to localize the number value
+ * @returns localized number string value
  */
 export declare function addLocalizedTrailingDecimalZeros(localizedValue: string, value: string, formatter: NumberStringFormat): string;

package/dist/utils/sortableComponent.d.ts

@@ -66,19 +66,19 @@ export interface SortableComponentItem {
 /**
  * Helper to keep track of a SortableComponent. This should be called in the `connectedCallback` lifecycle method as well as any other method necessary to rebuild the sortable instance.
  *
- * @param {SortableComponent} component - The sortable component.
+ * @param component - The sortable component.
  */
 export declare function connectSortableComponent(component: SortableComponent): void;
 /**
  * Helper to remove track of a SortableComponent. This should be called in the `disconnectedCallback` lifecycle method.
  *
- * @param {SortableComponent} component - The sortable component.
+ * @param component - The sortable component.
  */
 export declare function disconnectSortableComponent(component: SortableComponent): void;
 /**
  * Helper to determine if dragging is currently active.
  *
  * @param component The sortable component.
- * @returns {boolean} a boolean value.
+ * @returns a boolean value.
  */
 export declare function dragActive(component: SortableComponent): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/calcite-components",
-  "version": "5.0.0-next.66",
+  "version": "5.0.0-next.67",
   "description": "Web Components for Esri's Calcite Design System.",
   "homepage": "https://developers.arcgis.com/calcite-design-system/",
   "repository": {
@@ -93,7 +93,7 @@
   "devDependencies": {
     "@arcgis/lumina-compiler": ">=5.0.0-next.75 <6.0.0",
     "@esri/calcite-design-tokens": "4.0.0-next.16",
-    "@esri/calcite-tailwind-preset": "1.1.0-next.5",
+    "@esri/calcite-tailwind-preset": "1.1.0-next.6",
     "@esri/eslint-plugin-calcite-components": "2.0.4-next.8",
     "playwright": "1.57.0",
     "sass-embedded": "1.97.1",
@@ -110,5 +110,5 @@
     "dist/docs/vscode.html-custom-data.json"
   ],
   "web-types": "dist/docs/web-types.json",
-  "gitHead": "7e271c837cee637a7205c2ec4cb70c2e6259b5a6"
+  "gitHead": "dd45ca417384f585e84282bd98127711fb375415"
 }