@esri/calcite-components 1.0.0-next.466 → 1.0.0-next.469

package/dist/types/components/date-picker/utils.d.ts

@@ -1,5 +1,6 @@
 /**
  * Translation resource data structure
+ *
  * @private
  */
 export interface DateLocaleData {
@@ -27,17 +28,21 @@ export interface DateLocaleData {
 /**
  * CLDR cache.
  * Exported for testing purposes.
+ *
  * @private
  */
 export declare const translationCache: Record<string, DateLocaleData>;
 /**
  * CLDR request cache.
  * Exported for testing purposes.
+ *
  * @private
  */
 export declare const requestCache: Record<string, Promise<DateLocaleData>>;
 /**
  * Fetch calendar data for a given locale from list of supported languages
+ *
+ * @param lang
  * @public
  */
 export declare function getLocaleData(lang: string): Promise<DateLocaleData>;

package/dist/types/components/date-picker-day/date-picker-day.d.ts

@@ -39,9 +39,10 @@ export declare class DatePickerDay implements InteractiveComponent {
   calciteDaySelect: EventEmitter;
   /**
    * Emitted when user hovers over a day
+   *
    * @internal
    */
-  calciteDayHover: EventEmitter;
+  calciteInternalDayHover: EventEmitter;
   render(): VNode;
   componentDidRender(): void;
   isTabbable(): boolean;

package/dist/types/components/date-picker-month/date-picker-month.d.ts

@@ -32,9 +32,10 @@ export declare class DatePickerMonth {
   calciteDatePickerSelect: EventEmitter;
   /**
    * Event emitted when user hovers the date.
+   *
    * @internal
    */
-  calciteDatePickerHover: EventEmitter;
+  calciteInternalDatePickerHover: EventEmitter;
   /**
    * Active date for the user keyboard access.
    */
@@ -42,7 +43,7 @@ export declare class DatePickerMonth {
   /**
    * @internal
    */
-  calciteDatePickerMouseOut: EventEmitter;
+  calciteInternalDatePickerMouseOut: EventEmitter;
   keyDownHandler: (e: KeyboardEvent) => void;
   /**
    * Once user is not interacting via keyboard,
@@ -54,34 +55,55 @@ export declare class DatePickerMonth {
   private activeFocus;
   /**
    * Add n months to the current month
+   *
+   * @param step
    */
   private addMonths;
   /**
    * Add n days to the current date
+   *
+   * @param step
    */
   private addDays;
   /**
    * Get dates for last days of the previous month
+   *
+   * @param month
+   * @param year
+   * @param startOfWeek
    */
   private getPrevMonthdays;
   /**
    * Get dates for the current month
+   *
+   * @param month
+   * @param year
    */
   private getCurrentMonthDays;
   /**
    * Get dates for first days of the next month
+   *
+   * @param month
+   * @param year
+   * @param startOfWeek
    */
   private getNextMonthDays;
   /**
    * Determine if the date is in between the start and end dates
+   *
+   * @param date
    */
   private betweenSelectedRange;
   /**
    * Determine if the date should be in selected state
+   *
+   * @param date
    */
   private isSelected;
   /**
    * Determine if the date is the start of the date range
+   *
+   * @param date
    */
   private isStartOfRange;
   private isEndOfRange;
@@ -89,6 +111,12 @@ export declare class DatePickerMonth {
   daySelect: (e: CustomEvent) => void;
   /**
    * Render calcite-date-picker-day
+   *
+   * @param active
+   * @param day
+   * @param date
+   * @param currentMonth
+   * @param ref
    */
   private renderDateDay;
   private isFocusedOnStart;

package/dist/types/components/date-picker-month-header/date-picker-month-header.d.ts

@@ -41,6 +41,8 @@ export declare class DatePickerMonthHeader {
   setNextPrevMonthDates(): void;
   /**
    * Increment year on UP/DOWN keys
+   *
+   * @param e
    */
   private onYearKey;
   private onYearChange;
@@ -54,6 +56,11 @@ export declare class DatePickerMonthHeader {
   /**
    * Parse localized year string from input,
    * set to active if in range
+   *
+   * @param root0
+   * @param root0.localizedYear
+   * @param root0.commit
+   * @param root0.offset
    */
   private setYear;
 }

package/dist/types/components/dropdown/dropdown.d.ts

@@ -29,13 +29,14 @@ export declare class Dropdown implements InteractiveComponent {
   /**
    specify the maximum number of calcite-dropdown-items to display before showing the scroller, must be greater than 0 -
    this value does not include groupTitles passed to calcite-dropdown-group
-  */
+   */
   maxItems: number;
   maxItemsHandler(): void;
   /** Describes the type of positioning to use for the overlaid content. If your element is in a fixed container, use the 'fixed' value. */
   overlayPositioning: OverlayPositioning;
   /**
    * Determines where the dropdown will be positioned relative to the button.
+   *
    * @default "bottom-leading"
    */
   placement: MenuPlacement;
@@ -59,18 +60,18 @@ export declare class Dropdown implements InteractiveComponent {
   render(): VNode;
   /** Updates the position of the component. */
   reposition(): Promise<void>;
-  /** fires when a dropdown item has been selected or deselected **/
+  /** fires when a dropdown item has been selected or deselected */
   calciteDropdownSelect: EventEmitter<void>;
-  /** fires when a dropdown has been opened **/
+  /** fires when a dropdown has been opened */
   calciteDropdownOpen: EventEmitter<void>;
-  /** fires when a dropdown has been closed **/
+  /** fires when a dropdown has been closed */
   calciteDropdownClose: EventEmitter<void>;
   closeCalciteDropdownOnClick(e: Event): void;
-  closeCalciteDropdownOnEvent(): void;
+  closeCalciteDropdownOnEvent(e: Event): void;
   closeCalciteDropdownOnOpenEvent(e: Event): void;
   mouseEnterHandler(): void;
   mouseLeaveHandler(): void;
-  calciteDropdownItemKeyEvent(e: CustomEvent<ItemKeyboardEvent>): void;
+  calciteInternalDropdownItemKeyEvent(e: CustomEvent<ItemKeyboardEvent>): void;
   handleItemSelect(event: CustomEvent): void;
   filteredFlipPlacements: ComputedPlacement[];
   private items;

package/dist/types/components/dropdown-group/dropdown-group.d.ts

@@ -8,8 +8,10 @@ export declare class DropdownGroup {
   el: HTMLCalciteDropdownGroupElement;
   /** optionally set a group title for display */
   groupTitle?: string;
-  /** specify the selection mode - multi (allow any number of (or no) active items), single (allow and require one active item),
-   none (no active items), defaults to single */
+  /**
+    specify the selection mode - multi (allow any number of (or no) active items), single (allow and require one active item),
+   none (no active items), defaults to single
+   */
   selectionMode: SelectionMode;
   /**
    * Specifies the size of the action.
@@ -18,7 +20,7 @@ export declare class DropdownGroup {
   /**
    * @internal
    */
-  calciteDropdownItemChange: EventEmitter;
+  calciteInternalDropdownItemChange: EventEmitter;
   componentWillLoad(): void;
   render(): VNode;
   updateActiveItemOnChange(event: CustomEvent): void;

package/dist/types/components/dropdown-item/dropdown-item.d.ts

@@ -25,11 +25,11 @@ export declare class DropdownItem {
   /**
    * @internal
    */
-  calciteDropdownItemSelect: EventEmitter;
+  calciteInternalDropdownItemSelect: EventEmitter;
   /** @internal */
-  calciteDropdownItemKeyEvent: EventEmitter<ItemKeyboardEvent>;
+  calciteInternalDropdownItemKeyEvent: EventEmitter<ItemKeyboardEvent>;
   /** @internal */
-  calciteDropdownCloseRequest: EventEmitter;
+  calciteInternalDropdownCloseRequest: EventEmitter;
   /** Sets focus on the component. */
   setFocus(): Promise<void>;
   componentWillLoad(): void;

package/dist/types/components/fab/fab.d.ts

@@ -17,6 +17,7 @@ export declare class Fab implements InteractiveComponent {
   disabled: boolean;
   /**
    * The name of the icon to display. The value of this property must match the icon name from https://esri.github.io/calcite-ui-icons/.
+   *
    * @default "plus"
    */
   icon?: string;

package/dist/types/components/graph/util.d.ts

@@ -2,14 +2,28 @@ import { DataSeries, Graph, TranslateOptions, Translator, Extent } from "../grap
 /**
  * Generate a function which will translate a point
  * from the data coordinate space to svg viewbox oriented pixels
+ *
+ * @param root0
+ * @param root0.width
+ * @param root0.height
+ * @param root0.min
+ * @param root0.max
  */
 export declare function translate({ width, height, min, max }: TranslateOptions): Translator;
 /**
  * Get the min and max values from the dataset
+ *
+ * @param data
  */
 export declare function range(data: DataSeries): Extent;
 /**
  * Generate drawing commands for an area graph
  * returns a string can can be passed directly to a path element's `d` attribute
+ *
+ * @param root0
+ * @param root0.data
+ * @param root0.min
+ * @param root0.max
+ * @param root0.t
  */
 export declare function area({ data, min, max, t }: Graph): string;

package/dist/types/components/handle/handle.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter, VNode } from "../../stencil-public-runtime";
 export declare class Handle {
   /**
-   * @internal - stores the activated state of the drag handle.
+   * @internal
    */
   activated: boolean;
   /**

package/dist/types/components/icon/utils.d.ts

@@ -7,12 +7,14 @@ export interface FetchIconProps {
 /**
  * Icon data cache.
  * Exported for testing purposes.
+ *
  * @private
  */
 export declare const iconCache: Record<string, CalciteIconPath>;
 /**
  * Icon request cache.
  * Exported for testing purposes.
+ *
  * @private
  */
 export declare const requestCache: Record<string, Promise<CalciteIconPath>>;
@@ -21,6 +23,8 @@ export declare function fetchIcon({ icon, scale }: FetchIconProps): Promise<Calc
 /**
  * Normalize the icon name to match the path data module exports.
  * Exported for testing purposes.
+ *
+ * @param name
  * @private
  */
 export declare function normalizeIconName(name: string): string;

package/dist/types/components/inline-editable/inline-editable.d.ts

@@ -17,15 +17,21 @@ export declare class InlineEditable implements InteractiveComponent, LabelableCo
   loading: boolean;
   /** specify whether save/cancel controls should be displayed when editingEnabled is true, defaults to false */
   controls: boolean;
-  /** specify text to be user for the enable editing button's aria-label, defaults to `Click to edit`
+  /**
+   * specify text to be user for the enable editing button's aria-label, defaults to `Click to edit`
+   *
    * @default "Click to edit"
    */
   intlEnableEditing: string;
-  /** specify text to be user for the cancel editing button's aria-label, defaults to `Cancel`
+  /**
+   * specify text to be user for the cancel editing button's aria-label, defaults to `Cancel`
+   *
    * @default "Cancel"
    */
   intlCancelEditing: string;
-  /** specify text to be user for the confirm changes button's aria-label, defaults to `Save`
+  /**
+   * specify text to be user for the confirm changes button's aria-label, defaults to `Save`
+   *
    * @default "Save"
    */
   intlConfirmChanges: string;
@@ -48,7 +54,7 @@ export declare class InlineEditable implements InteractiveComponent, LabelableCo
   /**
    * @internal
    */
-  calciteInlineEditableEnableEditingChange: EventEmitter;
+  calciteInternalInlineEditableEnableEditingChange: EventEmitter;
   blurHandler(): void;
   private inputElement;
   private valuePriorToEditing;

package/dist/types/components/input/input.d.ts

@@ -15,9 +15,11 @@ export declare class Input implements LabelableComponent, FormComponent, Interac
   alignment: Position;
   /** should the input autofocus */
   autofocus: boolean;
-  /** optionally display a clear button that displays when field has a value
+  /**
+   * optionally display a clear button that displays when field has a value
    * shows by default for search, time, date
-   * will not display for type="textarea" */
+   * will not display for type="textarea"
+   */
   clearable: boolean;
   /** is the input disabled  */
   disabled: boolean;
@@ -26,9 +28,11 @@ export declare class Input implements LabelableComponent, FormComponent, Interac
   groupSeparator: boolean;
   /** when true, the component will not be visible */
   hidden: boolean;
-  /** when used as a boolean set to true, show a default recommended icon for certain
+  /**
+   * when used as a boolean set to true, show a default recommended icon for certain
    * input types (tel, password, email, date, time, search). You can also pass a
-   * calcite-ui-icon name to this prop to display a requested icon for any input type */
+   * calcite-ui-icon name to this prop to display a requested icon for any input type
+   */
   icon: string | boolean;
   /**
    * A text label that will appear on the clear button for screen readers.
@@ -36,6 +40,7 @@ export declare class Input implements LabelableComponent, FormComponent, Interac
   intlClear?: string;
   /**
    * string to override English loading text
+   *
    * @default "Loading"
    */
   intlLoading?: string;
@@ -49,6 +54,7 @@ export declare class Input implements LabelableComponent, FormComponent, Interac
   locale?: string;
   /**
    * Toggles locale formatting for numbers.
+   *
    * @internal
    */
   localeFormat: boolean;
@@ -62,6 +68,7 @@ export declare class Input implements LabelableComponent, FormComponent, Interac
   minWatcher(): void;
   /**
    * Maximum length of text input.
+   *
    * @deprecated use maxLength instead
    */
   maxlength?: number;
@@ -87,9 +94,11 @@ export declare class Input implements LabelableComponent, FormComponent, Interac
   status: Status;
   /** input step */
   step?: number | "any";
-  /** optionally add suffix  **/
+  /** optionally add suffix  */
   suffixText?: string;
-  /** @internal adds inline styles for text input when slotted in calcite-inline-editable */
+  /**
+   * @internal
+   */
   editingEnabled: boolean;
   /**
    * specify the input type
@@ -132,11 +141,11 @@ export declare class Input implements LabelableComponent, FormComponent, Interac
   /**
    * @internal
    */
-  calciteInputFocus: EventEmitter;
+  calciteInternalInputFocus: EventEmitter;
   /**
    * @internal
    */
-  calciteInputBlur: EventEmitter;
+  calciteInternalInputBlur: EventEmitter;
   /**
    * This event fires each time a new value is typed.
    */

package/dist/types/components/input-date-picker/input-date-picker.d.ts

@@ -29,11 +29,13 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
   valueAsDate?: Date | Date[];
   /**
    * Selected start date as full date object
+   *
    * @deprecated use valueAsDate instead
    */
   startAsDate?: Date;
   /**
    * Selected end date as full date object
+   *
    * @deprecated use valueAsDate instead
    */
   endAsDate?: Date;
@@ -54,15 +56,21 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
    * The picker's name. Gets submitted with the form.
    */
   name: string;
-  /** Localized string for "previous month" (used for aria label)
+  /**
+   * Localized string for "previous month" (used for aria label)
+   *
    * @default "Previous month"
    */
   intlPrevMonth?: string;
-  /** Localized string for "next month" (used for aria label)
+  /**
+   * Localized string for "next month" (used for aria label)
+   *
    * @default "Next month"
    */
   intlNextMonth?: string;
-  /** Localized string for "year" (used for aria label)
+  /**
+   * Localized string for "year" (used for aria label)
+   *
    * @default "Year"
    */
   intlYear?: string;
@@ -72,6 +80,7 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
   scale: "s" | "m" | "l";
   /**
    * Determines where the date-picker component will be positioned relative to the input.
+   *
    * @default "bottom-leading"
    */
   placement: MenuPlacement;
@@ -85,11 +94,13 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
   required: boolean;
   /**
    * Selected start date
+   *
    * @deprecated use value instead
    */
   start?: string;
   /**
    * Selected end date
+   *
    * @deprecated use value instead
    */
   end?: string;
@@ -109,8 +120,8 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
   calciteDatePickerChange: EventEmitter<Date>;
   /**
    * Trigger calcite date change when a user changes the date range.
-   * @see [DateRangeChange](https://github.com/Esri/calcite-components/blob/master/src/components/calcite-date-picker/interfaces.ts#L1)
    *
+   * @see [DateRangeChange](https://github.com/Esri/calcite-components/blob/master/src/components/calcite-date-picker/interfaces.ts#L1)
    * @deprecated use `calciteInputDatePickerChange` instead.
    */
   calciteDatePickerRangeChange: EventEmitter<DateRangeChange>;
@@ -121,11 +132,11 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
   /**
    * @internal
    */
-  calciteInputDatePickerOpen: EventEmitter;
+  calciteInternalInputDatePickerOpen: EventEmitter;
   /**
    * @internal
    */
-  calciteInputDatePickerClose: EventEmitter;
+  calciteInternalInputDatePickerClose: EventEmitter;
   /** Updates the position of the component. */
   setFocus(): Promise<void>;
   /** Updates the position of the component. */
@@ -174,14 +185,20 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
   private clearCurrentValue;
   /**
    * If inputted string is a valid date, update value/active
+   *
+   * @param value
    */
   private input;
   /**
    * Clean up invalid date from input on blur
+   *
+   * @param target
    */
   private blur;
   /**
    * Event handler for when the selected date changes
+   *
+   * @param event
    */
   handleDateChange: (event: CustomEvent<Date>) => void;
   private shouldFocusRangeStart;
@@ -190,6 +207,8 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
   /**
    * Find a date from input string
    * return false if date is invalid, or out of range
+   *
+   * @param value
    */
   private getDateFromInput;
 }

package/dist/types/components/input-message/input-message.d.ts

@@ -7,14 +7,18 @@ export declare class InputMessage {
   el: HTMLCalciteInputMessageElement;
   /** Indicates whether the message is displayed. */
   active: boolean;
-  /** when used as a boolean set to true, show a default icon based on status. You can
-   * also pass a calcite-ui-icon name to this prop to display a custom icon */
+  /**
+   * when used as a boolean set to true, show a default icon based on status. You can
+   * also pass a calcite-ui-icon name to this prop to display a custom icon
+   */
   icon: boolean | string;
   /** specify the scale of the input, defaults to m */
   scale: Scale;
   /** specify the status of the input field, determines message and icons */
   status: Status;
-  /** specify the appearance of any slotted message - default (displayed under input), or floating (positioned absolutely under input)
+  /**
+   * specify the appearance of any slotted message - default (displayed under input), or floating (positioned absolutely under input)
+   *
    * @deprecated "floating" type is no longer supported
    */
   type: "default";

package/dist/types/components/input-time-picker/input-time-picker.d.ts

@@ -38,6 +38,7 @@ export declare class InputTimePicker implements LabelableComponent, FormComponen
   intlSecondUp?: string;
   /**
    * BCP 47 language tag for desired language and country format
+   *
    * @internal
    */
   locale: string;
@@ -54,6 +55,7 @@ export declare class InputTimePicker implements LabelableComponent, FormComponen
   scale: Scale;
   /**
    * Determines where the popover will be positioned relative to the input.
+   *
    * @see [PopperPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/popper.ts#L25)
    */
   placement: PopperPlacement;
@@ -77,8 +79,8 @@ export declare class InputTimePicker implements LabelableComponent, FormComponen
    * Fires when the time value is changed as a result of user input.
    */
   calciteInputTimePickerChange: EventEmitter<string>;
-  private calciteInputBlurHandler;
-  private calciteInputFocusHandler;
+  private calciteInternalInputBlurHandler;
+  private calciteInternalInputFocusHandler;
   private calciteInputInputHandler;
   clickHandler(event: MouseEvent): void;
   keyUpHandler(event: KeyboardEvent): void;

package/dist/types/components/label/label.d.ts

@@ -9,6 +9,7 @@ export declare class Label {
   alignment: Alignment;
   /**
    * specify the status of the label and any child input / input messages
+   *
    * @deprecated set directly on child element instead
    */
   status: Status;

package/dist/types/components/link/link.d.ts

@@ -9,7 +9,8 @@ export declare class Link implements InteractiveComponent {
   el: HTMLCalciteLinkElement;
   /** is the link disabled  */
   disabled: boolean;
-  /** Prompts the user to save the linked URL instead of navigating to it. Can be used with or without a value:
+  /**
+   * Prompts the user to save the linked URL instead of navigating to it. Can be used with or without a value:
    * Without a value, the browser will suggest a filename/extension
    * See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-download
    */

package/dist/types/components/list/list.d.ts

@@ -7,11 +7,11 @@ import { InteractiveComponent } from "../../utils/interactive";
  */
 export declare class List implements InteractiveComponent {
   /**
-   * When true, disabled prevents user interaction.
+   * When true, prevents user interaction.
    */
   disabled: boolean;
   /**
-   * Number at which section headings should start for this component.
+   * Number at which section headings should start for the list.
    */
   headingLevel: HeadingLevel;
   componentDidRender(): void;

package/dist/types/components/list-item/list-item.d.ts

@@ -14,15 +14,15 @@ export declare class ListItem implements ConditionalSlotComponent, InteractiveCo
    */
   nonInteractive: boolean;
   /**
-   * An optional description for this item.  This will appear below the label text.
+   * An optional description for the list item. Displays below the label text.
    */
   description: string;
   /**
-   * When true, disabled prevents interaction.
+   * When true, prevents user interaction.
    */
   disabled: boolean;
   /**
-   * The label text of the list item. This will appear above the description text.
+   * The label text of the list item. Displays above the description text.
    */
   label: string;
   el: HTMLCalciteListItemElement;

package/dist/types/components/list-item-group/list-item-group.d.ts

@@ -5,12 +5,12 @@ import { HeadingLevel } from "../functional/Heading";
  */
 export declare class ListItemGroup {
   /**
-   * The title used for all nested `calcite-list-item` rows.
+   * The title for all nested `calcite-list-item` rows.
    *
    */
   heading: string;
   /**
-   * Number at which section headings should start for this component.
+   * Number at which section headings should start for the group.
    */
   headingLevel: HeadingLevel;
   el: HTMLCalciteListItemGroupElement;