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

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>;
@@ -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;

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

@@ -3,6 +3,7 @@ import { HeadingLevel } from "../functional/Heading";
 import { InteractiveComponent } from "../../utils/interactive";
 /**
  * A general purpose list that enables users to construct list items that conform to Calcite styling.
+ *
  * @slot - A slot for adding calcite-list-item elements.
  */
 export declare class List implements InteractiveComponent {

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

@@ -21,6 +21,8 @@ export declare class Loader {
   render(): VNode;
   /**
    * Return the proper sizes based on the scale property
+   *
+   * @param scale
    */
   private getSize;
   private getInlineSize;

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

@@ -33,8 +33,10 @@ export declare class Modal implements ConditionalSlotComponent {
   width: Scale | number;
   /** Set the modal to always be fullscreen (overrides width) */
   fullscreen: boolean;
-  /** Adds a color bar at the top for visual impact,
-   * Use color to add importance to destructive/workflow dialogs. */
+  /**
+   * Adds a color bar at the top for visual impact,
+   * Use color to add importance to destructive/workflow dialogs.
+   */
   color?: "red" | "blue";
   /** Background color of modal content */
   backgroundColor: ModalBackgroundColor;
@@ -62,6 +64,8 @@ export declare class Modal implements ConditionalSlotComponent {
   calciteModalClose: EventEmitter;
   /**
    * Focus first interactive element
+   *
+   * @param el
    * @deprecated use `setFocus` instead.
    */
   focusElement(el?: HTMLElement): Promise<void>;
@@ -70,9 +74,16 @@ export declare class Modal implements ConditionalSlotComponent {
    *
    * By default, will try to focus on any focusable content. If there is none, it will focus on the close button.
    * If you want to focus on the close button, you can use the `close-button` focus ID.
+   *
+   * @param focusId
    */
   setFocus(focusId?: "close-button"): Promise<void>;
-  /** Set the scroll top of the modal content */
+  /**
+   * Set the scroll top of the modal content
+   *
+   * @param top
+   * @param left
+   */
   scrollContent(top?: number, left?: number): Promise<void>;
   transitionEnd: (event: TransitionEvent) => void;
   toggleModal(value: boolean, oldValue: boolean): Promise<void>;

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

@@ -2,7 +2,8 @@ import { EventEmitter, VNode } from "../../stencil-public-runtime";
 import { Scale, Width } from "../interfaces";
 import { StatusColor } from "../alert/interfaces";
 import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
-/** Notices are intended to be used to present users with important-but-not-crucial contextual tips or copy. Because
+/**
+ * Notices are intended to be used to present users with important-but-not-crucial contextual tips or copy. Because
  * notices are displayed inline, a common use case is displaying them on page-load to present users with short hints or contextual copy.
  * They are optionally dismissible - useful for keeping track of whether or not a user has dismissed the notice. You can also choose not
  * to display a notice on page load and set the "active" attribute as needed to contextually provide inline messaging to users.
@@ -21,10 +22,14 @@ export declare class Notice implements ConditionalSlotComponent {
   color: StatusColor;
   /** Optionally show a button the user can click to dismiss the notice */
   dismissible: boolean;
-  /** when used as a boolean set to true, show a default recommended icon. You can
-   * also pass a calcite-ui-icon name to this prop to display a requested icon */
+  /**
+   * when used as a boolean set to true, show a default recommended icon. You can
+   * also pass a calcite-ui-icon name to this prop to display a requested icon
+   */
   icon: string | boolean;
-  /** String for the close button.
+  /**
+   * String for the close button.
+   *
    * @default "Close"
    */
   intlClose: string;

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

@@ -12,11 +12,15 @@ export declare class Pagination {
   start: number;
   /** total number of items */
   total: number;
-  /** Used as an accessible label (aria-label) for the next button
+  /**
+   * Used as an accessible label (aria-label) for the next button
+   *
    * @default "Next"
    */
   textLabelNext: string;
-  /** Used as an accessible label (aria-label) of the previous button
+  /**
+   * Used as an accessible label (aria-label) of the previous button
+   *
    * @default "Previous"
    */
   textLabelPrevious: string;
@@ -25,11 +29,13 @@ export declare class Pagination {
   el: HTMLCalcitePaginationElement;
   /**
    * Emitted whenever the selected page changes.
+   *
    * @deprecated use calcitePaginationChange instead
    */
   calcitePaginationUpdate: EventEmitter<PaginationDetail>;
   /**
    * Emitted whenever the selected page changes.
+   *
    * @see [PaginationDetail](https://github.com/Esri/calcite-components/blob/master/src/components/pagination/calcite-pagination.tsx#L18)
    */
   calcitePaginationChange: EventEmitter<PaginationDetail>;

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

@@ -90,6 +90,7 @@ export declare class Panel implements ConditionalSlotComponent, InteractiveCompo
   calcitePanelDismiss: EventEmitter;
   /**
    * Emitted when the close button has been clicked.
+   *
    * @deprecated use calcitePanelDismiss instead.
    */
   calcitePanelDismissedChange: EventEmitter;
@@ -109,9 +110,14 @@ export declare class Panel implements ConditionalSlotComponent, InteractiveCompo
   dismiss: () => void;
   panelScrollHandler: () => void;
   backButtonClick: () => void;
-  /** Sets focus on the component. */
+  /**
+   * Sets focus on the component.
+   *
+   * @param focusId
+   */
   setFocus(focusId?: "dismiss-button" | "back-button"): Promise<void>;
-  /** Scrolls panel content to a particular set of coordinates.
+  /**
+   * Scrolls panel content to a particular set of coordinates.
    *
    * ```
    *   myCalcitePanel.scrollContentTo({
@@ -120,6 +126,8 @@ export declare class Panel implements ConditionalSlotComponent, InteractiveCompo
    *     behavior: "auto" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).
    *   });
    * ```
+   *
+   * @param options
    */
   scrollContentTo(options?: ScrollToOptions): Promise<void>;
   renderBackButton(): VNode;

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

@@ -70,7 +70,11 @@ export declare class PickList<ItemElement extends HTMLCalcitePickListItemElement
   keyDownHandler: any;
   /** Returns the currently selected items */
   getSelectedItems(): Promise<Map<string, HTMLCalcitePickListItemElement>>;
-  /** Sets focus on the component. */
+  /**
+   * Sets focus on the component.
+   *
+   * @param focusId
+   */
   setFocus(focusId?: ListFocusId): Promise<void>;
   getIconType(): ICON_TYPES;
   render(): VNode;

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

@@ -21,11 +21,12 @@ export declare class PickListItem implements ConditionalSlotComponent, Interacti
    */
   disableDeselect: boolean;
   /**
-   * @internal When true, the item cannot be selected by user interaction.
+   * @internal
    */
   nonInteractive: boolean;
   /**
    * Determines the icon SVG symbol that will be shown. Options are circle, square, grip or null.
+   *
    * @see [ICON_TYPES](https://github.com/Esri/calcite-components/blob/master/src/components/pick-list/resources.ts#L5)
    */
   icon?: ICON_TYPES | null;
@@ -50,6 +51,7 @@ export declare class PickListItem implements ConditionalSlotComponent, Interacti
   selectedWatchHandler(): void;
   /**
    * Used as an accessible label (aria-label) for the "remove item" action. Only applicable if removable is true.
+   *
    * @default "Remove"
    */
   intlRemove: string;
@@ -79,11 +81,13 @@ export declare class PickListItem implements ConditionalSlotComponent, Interacti
   calciteListItemRemove: EventEmitter<void>;
   /**
    * Emitted whenever the the item's label, description, value or metadata properties are modified.
+   *
    * @internal
    */
   calciteInternalListItemPropsChange: EventEmitter<void>;
   /**
    * Emitted whenever the the item's value property is modified.
+   *
    * @internal
    */
   calciteInternalListItemValueChange: EventEmitter<{
@@ -93,6 +97,8 @@ export declare class PickListItem 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>;
   /** Sets focus on the component. */

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

@@ -12,6 +12,7 @@ export declare class Popover {
   autoClose: boolean;
   /**
    * Display a close button within the Popover.
+   *
    * @deprecated use dismissible instead.
    */
   closeButton: boolean;
@@ -44,6 +45,7 @@ export declare class Popover {
   label: string;
   /**
    * Offset the position of the popover away from the reference element.
+   *
    * @default 6
    */
   offsetDistance: number;
@@ -62,6 +64,7 @@ export declare class Popover {
   overlayPositioning: OverlayPositioning;
   /**
    * Determines where the component will be positioned relative to the referenceElement.
+   *
    * @see [PopperPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/popper.ts#L25)
    */
   placement: PopperPlacement;
@@ -71,7 +74,13 @@ export declare class Popover {
    */
   referenceElement: HTMLElement | string;
   referenceElementHandler(): void;
-  /** Text for close button.
+  /**
+   * Disables automatically toggling a popover when its referenceElement has been triggered. This property can be set to true to manage when a popover is open.
+   */
+  triggerDisabled: boolean;
+  /**
+   * Text for close button.
+   *
    * @default "Close"
    */
   intlClose: string;
@@ -93,9 +102,17 @@ export declare class Popover {
   calcitePopoverOpen: EventEmitter;
   /** Updates the position of the component. */
   reposition(): Promise<void>;
-  /** Sets focus on the component. */
+  /**
+   * Sets focus on the component.
+   *
+   * @param focusId
+   */
   setFocus(focusId?: "close-button"): Promise<void>;
-  /** Toggles the popover's open property. */
+  /**
+   * Toggles the popover's open property.
+   *
+   * @param value
+   */
   toggle(value?: boolean): Promise<void>;
   setFilteredPlacements: () => void;
   setUpReferenceElement: () => void;

package/dist/types/components/popover-manager/popover-manager.d.ts

@@ -8,6 +8,7 @@ export declare class PopoverManager {
   mutationObserver: MutationObserver;
   /**
    * CSS Selector to match reference elements for popovers. Reference elements will be identified by this selector in order to open their associated popover.
+   *
    * @default `[data-calcite-popover-reference]`
    */
   selector: string;

package/dist/types/components/radio-button/radio-button.d.ts

@@ -12,6 +12,7 @@ export declare class RadioButton implements LabelableComponent, CheckableFormCom
   disabled: boolean;
   /**
    * The focused state of the radio button.
+   *
    * @internal
    */
   focused: boolean;
@@ -21,11 +22,13 @@ export declare class RadioButton implements LabelableComponent, CheckableFormCom
   hidden: boolean;
   /**
    * The hovered state of the radio button.
+   *
    * @internal
    */
   hovered: boolean;
   /**
    * The label of the radio input
+   *
    * @internal
    */
   label?: string;
@@ -60,6 +63,7 @@ export declare class RadioButton implements LabelableComponent, CheckableFormCom
   private getTabIndex;
   /**
    * Fires when the radio button is blurred.
+   *
    * @internal
    */
   calciteInternalRadioButtonBlur: EventEmitter;
@@ -73,11 +77,13 @@ export declare class RadioButton implements LabelableComponent, CheckableFormCom
   /**
    * Fires when the checked property changes.  This is an internal event used for styling purposes only.
    * Use calciteRadioButtonChange or calciteRadioButtonGroupChange for responding to changes in the checked value for forms.
+   *
    * @internal
    */
   calciteInternalRadioButtonCheckedChange: EventEmitter;
   /**
    * Fires when the radio button is focused.
+   *
    * @internal
    */
   calciteInternalRadioButtonFocus: EventEmitter;

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

@@ -18,6 +18,7 @@ export declare class RadioGroupItem {
   render(): VNode;
   /**
    * Fires when the item has been selected.
+   *
    * @internal
    */
   calciteInternalRadioGroupItemChange: EventEmitter;

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

@@ -21,11 +21,15 @@ export declare class Rating implements LabelableComponent, FormComponent, Intera
   average?: number;
   /** The name of the rating */
   name: string;
-  /** Localized string for "Rating" (used for aria label)
+  /**
+   * Localized string for "Rating" (used for aria label)
+   *
    * @default "Rating"
    */
   intlRating?: string;
-  /** Localized string for labelling each star, `${num}` in the string will be replaced by the number
+  /**
+   * Localized string for labelling each star, `${num}` in the string will be replaced by the number
+   *
    * @default "Stars: ${num}"
    */
   intlStars?: string;

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

@@ -3,7 +3,9 @@ import { VNode } from "../../stencil-public-runtime";
  * @slot - A slot for adding custom content, primarily loading information.
  */
 export declare class Scrim {
-  /** string to override English loading text
+  /**
+   * string to override English loading text
+   *
    * @default "Loading"
    */
   intlLoading?: string;

package/dist/types/components/shell-panel/shell-panel.d.ts

@@ -29,6 +29,7 @@ export declare class ShellPanel implements ConditionalSlotComponent {
   position: Position;
   /**
    * Accessible label for resize separator.
+   *
    * @default "Resize"
    */
   intlResize: string;
@@ -51,6 +52,7 @@ export declare class ShellPanel implements ConditionalSlotComponent {
   stepMultiplier: number;
   /**
    * Emitted when collapse has been toggled.
+   *
    * @deprecated use a resizeObserver on the shell-panel to listen for changes to its size.
    */
   calciteShellPanelToggle: EventEmitter;

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

@@ -12,6 +12,7 @@ export declare class Slider implements LabelableComponent, FormComponent, Intera
   hasHistogram: boolean;
   /**
    * List of x,y coordinates within the slider's min and max, displays above the slider track.
+   *
    * @see [DataSeries](https://github.com/Esri/calcite-components/blob/master/src/components/graph/interfaces.ts#L5)
    */
   histogram?: DataSeries;
@@ -95,6 +96,7 @@ export declare class Slider implements LabelableComponent, FormComponent, Intera
    * :warning: Will be fired frequently during drag. If you are performing any
    * expensive operations consider using a debounce or throttle to avoid
    * locking up the main thread.
+   *
    * @deprecated use calciteSliderInput instead
    */
   calciteSliderUpdate: EventEmitter;
@@ -130,28 +132,37 @@ export declare class Slider implements LabelableComponent, FormComponent, Intera
   private removeDragListeners;
   /**
    * Set the prop value if changed at the component level
+   *
    * @param valueProp
    * @param value
    */
   private setValue;
   /**
    * Set the reference of the track Element
+   *
    * @internal
    * @param node
    */
   private storeTrackRef;
   /**
    * If number is outside range, constrain to min or max
+   *
+   * @param value
+   * @param prop
    * @internal
    */
   private clamp;
   /**
    * Translate a pixel position to value along the range
+   *
+   * @param x
    * @internal
    */
   private translate;
   /**
    * Get closest allowed value along stepped values
+   *
+   * @param num
    * @internal
    */
   private getClosestStep;
@@ -160,6 +171,8 @@ export declare class Slider implements LabelableComponent, FormComponent, Intera
   private getFontSizeForElement;
   /**
    * Get position of value along range as fractional value
+   *
+   * @param num
    * @return {number} number in the unit interval [0,1]
    * @internal
    */
@@ -172,24 +185,30 @@ export declare class Slider implements LabelableComponent, FormComponent, Intera
   private hideObscuredBoundingTickLabels;
   /**
    * Returns an integer representing the number of pixels to offset on the left or right side based on desired position behavior.
+   *
+   * @param leftBounds
+   * @param rightBounds
    * @internal
    */
   private getHostOffset;
   /**
    * Returns an integer representing the number of pixels that the two given span elements are overlapping, taking into account
    * a space in between the two spans equal to the font-size set on them to account for the space needed to render a hyphen.
+   *
    * @param leftLabel
    * @param rightLabel
    */
   private getRangeLabelOverlap;
   /**
    * Returns a boolean value representing if the minLabel span element is obscured (being overlapped) by the given handle div element.
+   *
    * @param minLabel
    * @param handle
    */
   private isMinTickLabelObscured;
   /**
    * Returns a boolean value representing if the maxLabel span element is obscured (being overlapped) by the given handle div element.
+   *
    * @param maxLabel
    * @param handle
    */

package/dist/types/components/split-button/split-button.d.ts

@@ -17,6 +17,7 @@ export declare class SplitButton implements InteractiveComponent {
   handleDisabledChange(value: boolean): void;
   /**
    * Is the dropdown currently active or not
+   *
    * @internal
    */
   active: boolean;
@@ -25,8 +26,10 @@ export declare class SplitButton implements InteractiveComponent {
   dropdownIconType: DropdownIconType;
   /** aria label for overflow button */
   dropdownLabel?: string;
-  /** optionally add a calcite-loader component to the control,
-   disabling interaction. with the primary button */
+  /**
+    optionally add a calcite-loader component to the control,
+   disabling interaction. with the primary button
+   */
   loading: boolean;
   /** Describes the type of positioning to use for the dropdown. If your element is in a fixed container, use the 'fixed' value. */
   overlayPositioning: OverlayPositioning;