@esri/calcite-components 1.0.0-next.467 → 1.0.0-next.468

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

@@ -9,9 +9,13 @@ export interface ConditionalSlotComponent {
 }
 /**
  * Helper to set up a conditional slot component on connectedCallback.
+ *
+ * @param component
  */
 export declare function connectConditionalSlotComponent(component: ConditionalSlotComponent): void;
 /**
  * Helper to tear down a conditional slot component on disconnectedCallback.
+ *
+ * @param component
  */
 export declare function disconnectConditionalSlotComponent(component: ConditionalSlotComponent): void;

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

@@ -6,45 +6,73 @@ export interface HoverRange {
 }
 /**
  * Check if date is within a min and max
+ *
+ * @param date
+ * @param min
+ * @param max
  */
 export declare function inRange(date: Date, min?: Date | string, max?: Date | string): boolean;
 /**
  * Ensures date is within range,
  * returns min or max if out of bounds
+ *
+ * @param date
+ * @param min
+ * @param max
  */
 export declare function dateFromRange(date?: any, min?: Date | string, max?: Date | string): Date | null;
 /**
  * Parse an iso8601 string (YYYY-mm-dd) into a valid date.
  * TODO: handle time when time of day UI is added
+ *
+ * @param iso8601
  */
 export declare function dateFromISO(iso8601: string | Date): Date | null;
 /**
  * Return first portion of ISO string (YYYY-mm-dd)
+ *
+ * @param date
  */
 export declare function dateToISO(date?: Date | string): string;
 /**
  * Check if two dates are the same day, month, year
+ *
+ * @param d1
+ * @param d2
  */
 export declare function sameDate(d1: Date, d2: Date): boolean;
 /**
  * Get a date one month in the past
+ *
+ * @param date
  */
 export declare function prevMonth(date: Date): Date;
 /**
  * Get a date one month in the future
+ *
+ * @param date
  */
 export declare function nextMonth(date: Date): Date;
 /**
  * Translate a number into a given locals numeral system
+ *
+ * @param num
+ * @param localeData
  */
 export declare function localizeNumber(num: number, localeData: DateLocaleData): string;
 /**
  * Calculate actual number from localized string
+ *
+ * @param str
+ * @param localeData
  */
 export declare function parseNumber(str: string, localeData: DateLocaleData): number;
 /**
  * Parse numeric units for day, month, and year from a localized string
  * month starts at 0 (can pass to date constructor)
+ *
+ * @param str
+ * @param localeData
  */
 export declare function parseDateString(str: string, localeData: DateLocaleData): {
   day: number;
@@ -53,15 +81,22 @@ export declare function parseDateString(str: string, localeData: DateLocaleData)
 };
 /**
  * Convert eastern arbic numerals
+ *
+ * @param str
  */
 export declare function replaceArabicNumerals(str?: string): string;
 declare type unitOrderSignifier = "m" | "d" | "y";
 /**
  * Based on the unitOrder string, find order of month, day, and year for locale
+ *
+ * @param unitOrder
  */
 export declare function getOrder(unitOrder: string): unitOrderSignifier[];
 /**
  * Get number of days between two dates
+ *
+ * @param date1
+ * @param date2
  */
 export declare function getDaysDiff(date1: Date, date2: Date): number;
 export {};

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

@@ -3,6 +3,7 @@
  *
  * If it already has an ID, it will be preserved, otherwise a unique one will be generated and assigned.
  *
+ * @param el
  * @returns {string} The element's ID.
  */
 export declare function ensureId(el: Element): string;
@@ -16,6 +17,8 @@ export declare function getHost(root: Document | ShadowRoot): Element | null;
 /**
  * This helper queries an element's rootNodes and any ancestor rootNodes.
  *
+ * @param element
+ * @param selector
  * @returns {Element[]} The elements.
  */
 export declare function queryElementsRoots<T extends Element = Element>(element: Element, selector: string): T[];
@@ -24,6 +27,10 @@ export declare function queryElementsRoots<T extends Element = Element>(element:
  *
  * If both an 'id' and 'selector' are supplied, 'id' will take precedence over 'selector'.
  *
+ * @param element
+ * @param root0
+ * @param root0.selector
+ * @param root0.id
  * @returns {Element} The element.
  */
 export declare function queryElementRoots<T extends Element = Element>(element: Element, { selector, id }: {
@@ -56,6 +63,7 @@ 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 value
  * @returns {string} The string conversion of a boolean value ("true" | "false").
  */
 export declare function toAriaBoolean(value: boolean): string;

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

@@ -84,24 +84,35 @@ export interface CheckableFormCompoment<T = any> extends FormComponent<T> {
 }
 /**
  * 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 {
@@ -122,6 +133,9 @@ interface HiddenFormInputSlotProps {
  * }
  *
  * 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

@@ -26,10 +26,15 @@ export interface GlobalAttrComponent {
  *   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/interactive.d.ts

@@ -8,8 +8,8 @@ export interface InteractiveComponent {
    *
    * Notes:
    *
-   * * This prop should use the @Prop decorator and reflect.
-   * * The `disabled` Sass mixin must be added to the component's stylesheet.
+   * This prop should use the @Prop decorator and reflect.
+   * The `disabled` Sass mixin must be added to the component's stylesheet.
    */
   disabled: boolean;
 }
@@ -21,8 +21,11 @@ declare type HostIsTabbablePredicate = () => boolean;
  *
  * **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
+ * 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/label.d.ts

@@ -22,6 +22,7 @@ export interface LabelableComponent {
 }
 /**
  * Exported for testing purposes only
+ *
  * @internal
  */
 export declare const labelClickEvent = "calciteInternalLabelClick";
@@ -29,13 +30,19 @@ 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;