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

package/dist/types/components/color-picker/color-picker.d.ts

@@ -29,6 +29,7 @@ export declare class ColorPicker implements InteractiveComponent {
    * The format of the value property.
    *
    * When "auto", the format will be inferred from `value` when set.
+   *
    * @default "auto"
    */
   format: Format;
@@ -39,80 +40,117 @@ export declare class ColorPicker implements InteractiveComponent {
   hideChannels: boolean;
   /** When true, hides the saved colors section */
   hideSaved: boolean;
-  /** Label used for the blue channel
+  /**
+   * Label used for the blue channel
+   *
    * @default "B"
    */
   intlB: string;
-  /** Label used for the blue channel description
+  /**
+   * Label used for the blue channel description
+   *
    * @default "Blue"
    */
   intlBlue: string;
-  /** Label used for the delete color button.
+  /**
+   * Label used for the delete color button.
+   *
    * @default "Delete color"
    */
   intlDeleteColor: string;
-  /** Label used for the green channel
+  /**
+   * Label used for the green channel
+   *
    * @default "G"
    */
   intlG: string;
-  /** Label used for the green channel description
+  /**
+   * Label used for the green channel description
+   *
    * @default "Green"
    */
   intlGreen: string;
-  /** Label used for the hue channel
+  /**
+   * Label used for the hue channel
+   *
    * @default "H"
    */
   intlH: string;
-  /** Label used for the HSV mode
+  /**
+   * Label used for the HSV mode
+   *
    * @default "HSV"
    */
   intlHsv: string;
-  /** Label used for the hex input
+  /**
+   * Label used for the hex input
+   *
    * @default "Hex"
    */
   intlHex: string;
-  /** Label used for the hue channel description
+  /**
+   * Label used for the hue channel description
+   *
    * @default "Hue"
    */
   intlHue: string;
   /**
    * Label used for the hex input when there is no color selected.
+   *
    * @default "No color"
    */
   intlNoColor: string;
-  /** Label used for the red channel
+  /**
+   * Label used for the red channel
+   *
    * @default "R"
    */
   intlR: string;
-  /** Label used for the red channel description
+  /**
+   * Label used for the red channel description
+   *
    * @default "Red"
    */
   intlRed: string;
-  /** Label used for the RGB mode
+  /**
+   * Label used for the RGB mode
+   *
    * @default "RGB"
    */
   intlRgb: string;
-  /** Label used for the saturation channel
+  /**
+   * Label used for the saturation channel
+   *
    * @default "S"
    */
   intlS: string;
-  /** Label used for the saturation channel description
+  /**
+   * Label used for the saturation channel description
+   *
    * @default "Saturation"
    */
   intlSaturation: string;
-  /** Label used for the save color button.
+  /**
+   * Label used for the save color button.
+   *
    * @default "Save color"
    */
   intlSaveColor: string;
-  /** Label used for the saved colors section
+  /**
+   * Label used for the saved colors section
+   *
    * @default "Saved"
    */
   intlSaved: string;
-  /** Label used for the value channel
+  /**
+   * Label used for the value channel
+   *
    * @default "V"
    */
   intlV: string;
-  /** Label used for the
+  /**
+   * Label used for the
+   *
    * @default "Value"
    */
   intlValue: string;
@@ -132,6 +170,7 @@ export declare class ColorPicker implements InteractiveComponent {
    * a RGB, HSL or HSV object.
    *
    * The type will be preserved as the color is updated.
+   *
    * @default "#007ac2"
    * @see [ColorValue](https://github.com/Esri/calcite-components/blob/master/src/components/color-picker/interfaces.ts#L10)
    */

package/dist/types/components/color-picker-hex-input/color-picker-hex-input.d.ts

@@ -12,11 +12,13 @@ export declare class ColorPickerHexInput {
   allowEmpty: boolean;
   /**
    * Label used for the hex input.
+   *
    * @default "Hex"
    */
   intlHex: string;
   /**
    * Label used for the hex input when there is no color selected.
+   *
    * @default "No color"
    */
   intlNoColor: string;

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

@@ -41,7 +41,8 @@ export declare class Combobox implements LabelableComponent, FormComponent, Inte
    * @internal
    */
   required: boolean;
-  /** specify the selection mode
+  /**
+   * specify the selection mode
    * - multi: allow any number of selected items (default)
    * - single: only one selection)
    * - ancestors: like multi, but show ancestors of selected items as selected, only deepest children shown in chips
@@ -52,7 +53,9 @@ export declare class Combobox implements LabelableComponent, FormComponent, Inte
   /** The value(s) of the selectedItem(s) */
   value: string | string[];
   valueHandler(value: string | string[]): void;
-  /** string to override the English "Remove tag" text for when an item is selected.
+  /**
+   * string to override the English "Remove tag" text for when an item is selected.
+   *
    * @default "Remove tag"
    */
   intlRemoveTag: string;
@@ -69,6 +72,7 @@ export declare class Combobox implements LabelableComponent, FormComponent, Inte
   setFocus(): Promise<void>;
   /**
    * Called when the selected items set changes
+   *
    * @deprecated use calciteComboboxChange instead
    */
   calciteLookupChange: EventEmitter<HTMLCalciteComboboxItemElement[]>;
@@ -83,15 +87,17 @@ export declare class Combobox implements LabelableComponent, FormComponent, Inte
     visibleItems: HTMLCalciteComboboxItemElement[];
     text: string;
   }>;
-  /** Called when a selected item in the combobox is dismissed via its chip **/
+  /** Called when a selected item in the combobox is dismissed via its chip */
   calciteComboboxChipDismiss: EventEmitter;
   /**
    * Fired when the combobox is opened
+   *
    * @internal
    */
   calciteComboboxOpen: EventEmitter;
   /**
    *  Fired when the combobox is closed
+   *
    * @internal
    */
   calciteComboboxClose: EventEmitter;

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

@@ -39,6 +39,8 @@ export declare class ComboboxItem implements ConditionalSlotComponent, Interacti
   /**
    * Used to toggle the selection state. By default this won't trigger an event.
    * The first argument allows the value to be coerced, rather than swapping values.
+   *
+   * @param coerce
    */
   toggleSelected(coerce?: boolean): Promise<void>;
   itemClickHandler: (event: MouseEvent) => void;

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

@@ -16,11 +16,13 @@ export declare class DatePicker {
   handleValueAsDate(date: Date | Date[]): void;
   /**
    * 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;
@@ -35,15 +37,21 @@ export declare class DatePicker {
   /** Latest allowed date ("yyyy-mm-dd") */
   max?: string;
   onMaxChanged(max: string): void;
-  /** 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;
@@ -55,11 +63,13 @@ export declare class DatePicker {
   range: boolean;
   /**
    * Selected start date
+   *
    * @deprecated use value instead
    */
   start?: string;
   /**
    * Selected end date
+   *
    * @deprecated use value instead
    */
   end?: string;
@@ -71,6 +81,7 @@ export declare class DatePicker {
   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/date-picker/interfaces.ts#L1)
    */
   calciteDatePickerRangeChange: EventEmitter<DateRangeChange>;
@@ -103,14 +114,26 @@ export declare class DatePicker {
   monthMouseOutChange: () => void;
   /**
    * Render calcite-date-picker-month-header and calcite-date-picker-month
+   *
+   * @param activeDate
+   * @param maxDate
+   * @param minDate
+   * @param date
+   * @param endDate
    */
   private renderCalendar;
   /**
    * Update date instance of start if valid
+   *
+   * @param startDate
+   * @param emit
    */
   private setStartAsDate;
   /**
    * Update date instance of end if valid
+   *
+   * @param endDate
+   * @param emit
    */
   private setEndAsDate;
   /**
@@ -121,10 +144,16 @@ export declare class DatePicker {
   private setStartDate;
   /**
    * Event handler for when the selected date changes
+   *
+   * @param e
    */
   private monthDateChange;
   /**
    * Get an active date using the value, or current date as default
+   *
+   * @param value
+   * @param min
+   * @param max
    */
   private getActiveDate;
   private getActiveStartDate;

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,6 +39,7 @@ export declare class DatePickerDay implements InteractiveComponent {
   calciteDaySelect: EventEmitter;
   /**
    * Emitted when user hovers over a day
+   *
    * @internal
    */
   calciteInternalDayHover: EventEmitter;

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

@@ -32,6 +32,7 @@ export declare class DatePickerMonth {
   calciteDatePickerSelect: EventEmitter;
   /**
    * Event emitted when user hovers the date.
+   *
    * @internal
    */
   calciteInternalDatePickerHover: EventEmitter;
@@ -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,11 +60,11 @@ 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(e: Event): void;

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.

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;

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