@esri/calcite-components 1.0.0-beta.83 → 1.0.0-beta.84

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

@@ -9,44 +9,41 @@ import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
  * to display a notice on page load and set the "active" attribute as needed to contextually provide inline messaging to users.
  */
 /**
- * @slot title - A slot for adding the title (optional).
+ * @slot title - A slot for adding the title.
  * @slot message - A slot for adding the message.
- * @slot link - A slot for adding actions to take, such as: undo, try again, link to page, etc. (optional).
- * @slot actions-end - A slot for adding actions to the end of the `calcite-notice` (optional). It is recommended to use two or less actions.
+ * @slot link - A slot for adding actions to take, such as: undo, try again, link to page, etc.
+ * @slot actions-end - A slot for adding actions to the end of the component. It is recommended to use two or less actions.
  */
 export declare class Notice implements ConditionalSlotComponent {
   el: HTMLCalciteNoticeElement;
-  /** When true, the `calcite-notice` is active. */
+  /** When true, the component is active. */
   active: boolean;
-  /** The color for the `calcite-notice`. Color will apply to top border and icon. */
+  /** The color for the component's top border and icon. */
   color: StatusColor;
-  /** Shows a button the user can click to dismiss the `calcite-notice`. */
+  /** When true, a close button is added to the component. */
   dismissible?: boolean;
-  /**
-   * When present, shows a default recommended icon. You can
-   * also pass a calcite-ui-icon name to display a requested icon.
-   */
+  /** Specifies an icon to display - accepts Calcite UI icon names. */
   icon: string | boolean;
   /**
-   * Accessible label for the close button.
+   * Accessible name for the close button.
    *
    * @default "Close"
    */
   intlClose: string;
-  /** Specify the scale of `calcite-notice`. */
+  /** Specifies the size of the component. */
   scale: Scale;
-  /** Specify the width of the `calcite-notice`. */
+  /** Specifies the width of the component. */
   width: Width;
   updateRequestedIcon(): void;
   connectedCallback(): void;
   disconnectedCallback(): void;
   componentWillLoad(): void;
   render(): VNode;
-  /** Fired when `calcite-notice` is closed. */
+  /** Fired when the component is closed. */
   calciteNoticeClose: EventEmitter;
-  /** Fired when `calcite-notice` is opened. */
+  /** Fired when the component is opened. */
   calciteNoticeOpen: EventEmitter;
-  /** Sets focus on the `calcite-notice`. */
+  /** Sets focus on the component. */
   setFocus(): Promise<void>;
   private close;
   /** The close button element. */

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

@@ -1,19 +1,19 @@
 import { VNode } from "../../stencil-public-runtime";
 export declare class Option {
   /**
-   * When true, it prevents the option from being selected.
+   * When true, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
-   * The option label.
+   * Accessible name for the component.
    */
   label: string;
   /**
-   * When true, this option is selected. Otherwise, false.
+   * When true, the component is selected.
    */
   selected: boolean;
   /**
-   * The value associated with this option.
+   * The component's value.
    */
   value: any;
   protected handlePropChange(_newValue: any, _oldValue: any, propName: string): void;

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

@@ -4,11 +4,11 @@ import { VNode } from "../../stencil-public-runtime";
  */
 export declare class OptionGroup {
   /**
-   * When true, it prevents selection from any of its associated options.
+   * When true, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
-   * The group label. This property is required.
+   * Accessible name for the component.
    */
   label: string;
   protected handlePropChange(): void;

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

@@ -7,45 +7,45 @@ export interface PaginationDetail {
   num: number;
 }
 export declare class Pagination implements GlobalAttrComponent {
-  /** number of items per page */
+  /** Specifies the number of items per page. */
   num: number;
-  /** index of item that should begin the page */
+  /** Specifies the starting item number. */
   start: number;
-  /** total number of items */
+  /** Specifies the total number of items. */
   total: number;
   /**
-   * Used as an accessible label (aria-label) for the next button
+   * Accessible name for the component's next button.
    *
    * @default "Next"
    */
   textLabelNext: string;
   /**
-   * Used as an accessible label (aria-label) of the previous button
+   * Accessible name for the component's previous button.
    *
    * @default "Previous"
    */
   textLabelPrevious: string;
-  /** The scale of the pagination */
+  /** Specifies the size of the component. */
   scale: Scale;
   el: HTMLCalcitePaginationElement;
   globalAttributes: {};
   /**
-   * Emitted whenever the selected page changes.
+   * Emits when the selected page changes.
    *
    * @deprecated use calcitePaginationChange instead
    */
   calcitePaginationUpdate: EventEmitter<PaginationDetail>;
   /**
-   * Emitted whenever the selected page changes.
+   * Emits when the selected page changes.
    *
-   * @see [PaginationDetail](https://github.com/Esri/calcite-components/blob/master/src/components/pagination/calcite-pagination.tsx#L18)
+   * @see [PaginationDetail](https://github.com/Esri/calcite-components/blob/master/src/components/pagination/pagination.tsx#L23)
    */
   calcitePaginationChange: EventEmitter<PaginationDetail>;
   connectedCallback(): void;
   disconnectedCallback(): void;
-  /** Go to the next page of results */
+  /** Go to the next page of results. */
   nextPage(): Promise<void>;
-  /** Go to the previous page of results */
+  /** Go to the previous page of results. */
   previousPage(): Promise<void>;
   private getLastStart;
   private previousClicked;

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

@@ -5,17 +5,17 @@ import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
 import { InteractiveComponent } from "../../utils/interactive";
 /**
  * @slot - A slot for adding custom content.
- * @slot header-actions-start - A slot for adding actions or content to the start side of the panel header.
- * @slot header-actions-end - A slot for adding actions or content to the end side of the panel header.
+ * @slot header-actions-start - A slot for adding actions or content to the start side of the header.
+ * @slot header-actions-end - A slot for adding actions or content to the end side of the header.
  * @slot header-content - A slot for adding custom content to the header.
- * @slot header-menu-actions - A slot for adding an overflow menu with actions inside a dropdown.
+ * @slot header-menu-actions - A slot for adding an overflow menu with actions inside a `calcite-dropdown`.
  * @slot fab - A slot for adding a `calcite-fab` (floating action button) to perform an action.
  * @slot footer-actions - A slot for adding buttons to the footer.
  * @slot footer - A slot for adding custom content to the footer.
  */
 export declare class Panel implements ConditionalSlotComponent, InteractiveComponent {
   /**
-   * Hides the panel.
+   * When true, hides the component.
    */
   dismissed: boolean;
   dismissedHandler(): void;
@@ -24,55 +24,59 @@ export declare class Panel implements ConditionalSlotComponent, InteractiveCompo
    */
   beforeBack?: () => Promise<void>;
   /**
-   * When true, disabled prevents interaction. This state shows items with lower opacity/grayed.
+   *  When true, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
-   * Displays a close button in the trailing side of the header.
+   * When true, a close button is added to the component.
    */
   dismissible: boolean;
   /**
-   * Number at which section headings should start for this component.
+   * Specifies the number at which section headings should start.
    */
   headingLevel: HeadingLevel;
   /**
-   * Shows a back button in the header.
+   * When true, displays a back button in the header.
    */
   showBackButton: boolean;
   /**
-   * 'Back' text string.
+   * Accessible name for the component's back button. The back button will only be shown when 'showBackButton' is true.
    */
   intlBack?: string;
   /**
-   * Specifies the maximum height of the panel.
+   * Specifies the maximum height of the component.
    */
   heightScale?: Scale;
   /**
-   * This sets width of the panel.
+   * Specifies the width of the component.
    */
   widthScale?: Scale;
   /**
-   * When true, content is waiting to be loaded. This state shows a busy indicator.
+   * When true, a busy indicator is displayed.
    */
   loading: boolean;
   /**
-   * 'Close' text string for the close button. The close button will only be shown when 'dismissible' is true.
+   * Accessible name for the component's close button. The close button will only be shown when 'dismissible' is true.
    */
   intlClose?: string;
   /**
-   * 'Options' text string for the actions menu.
+   * Accessible name for the component's actions menu.
    */
   intlOptions?: string;
   /**
-   * Heading text.
+   * The component header text.
    */
   heading?: string;
   /**
    * Summary text. A description displayed underneath the heading.
+   *
+   * @deprecated use description instead
    */
   summary?: string;
+  /** A description for the component. */
+  description: string;
   /**
-   * Opens the action menu.
+   * When true, the action menu items in the `header-menu-actions` slot are open.
    */
   menuOpen: boolean;
   componentDidRender(): void;
@@ -85,21 +89,21 @@ export declare class Panel implements ConditionalSlotComponent, InteractiveCompo
   connectedCallback(): void;
   disconnectedCallback(): void;
   /**
-   * Emitted when the close button has been clicked.
+   * Fires when the close button is clicked.
    */
   calcitePanelDismiss: EventEmitter;
   /**
-   * Emitted when the close button has been clicked.
+   * Fires when the close button is clicked.
    *
    * @deprecated use calcitePanelDismiss instead.
    */
   calcitePanelDismissedChange: EventEmitter;
   /**
-   * Emitted when the content has been scrolled.
+   * Fires when the content is scrolled.
    */
   calcitePanelScroll: EventEmitter;
   /**
-   * Emitted when the back button has been clicked.
+   * Fires when the back button is clicked.
    */
   calcitePanelBackClick: EventEmitter;
   resizeHandler: () => void;
@@ -117,7 +121,7 @@ export declare class Panel implements ConditionalSlotComponent, InteractiveCompo
    */
   setFocus(focusId?: "dismiss-button" | "back-button"): Promise<void>;
   /**
-   * Scrolls panel content to a particular set of coordinates.
+   * Scrolls the component's content to a specified set of coordinates.
    *
    * ```
    *   myCalcitePanel.scrollContentTo({

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

@@ -4,6 +4,7 @@ export declare const CSS: {
   header: string;
   heading: string;
   summary: string;
+  description: string;
   headerContent: string;
   headerActions: string;
   headerActionsEnd: string;

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

@@ -4,12 +4,12 @@ import { ListFocusId, ItemData } from "./shared-list-logic";
 import { HeadingLevel } from "../functional/Heading";
 import { InteractiveComponent } from "../../utils/interactive";
 /**
- * @slot - A slot for adding `calcite-pick-list-item` elements or `calcite-pick-list-group` elements. Items are displayed as a vertical list.
- * @slot menu-actions - A slot for adding a button + menu combo for performing actions like sorting.
+ * @slot - A slot for adding `calcite-pick-list-item` or `calcite-pick-list-group` elements. Items are displayed as a vertical list.
+ * @slot menu-actions - A slot for adding a button and menu combination for performing actions, such as sorting.
  */
 export declare class PickList<ItemElement extends HTMLCalcitePickListItemElement = HTMLCalcitePickListItemElement> implements InteractiveComponent {
   /**
-   * When true, disabled prevents interaction. This state shows items with lower opacity/grayed.
+   * When true, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
@@ -21,22 +21,22 @@ export declare class PickList<ItemElement extends HTMLCalcitePickListItemElement
    */
   filterPlaceholder: string;
   /**
-   * Number at which section headings should start for this component.
+   * Specifies the number at which section headings should start.
    */
   headingLevel: HeadingLevel;
   /**
-   * When true, content is waiting to be loaded. This state shows a busy indicator.
+   * When true, a busy indicator is displayed.
    */
   loading: boolean;
   /**
-   * Multiple works similar to standard radio buttons and checkboxes.
-   * When true, a user can select multiple items at a time.
-   * When false, only a single item can be selected at a time
-   * and selecting a new item will deselect any other selected items.
+   * Similar to standard radio buttons and checkboxes.
+   * When true, a user can select multiple `calcite-pick-list-item`s at a time.
+   * When false, only a single `calcite-pick-list-item` can be selected at a time,
+   * and a new selection will deselect previous selections.
    */
   multiple: boolean;
   /**
-   * When true and single-selection is enabled, the selection will change when navigating items via the keyboard.
+   * When true and single-selection is enabled, the selection changes when navigating `calcite-pick-list-item`s via keyboard.
    */
   selectionFollowsFocus: boolean;
   selectedValues: Map<string, ItemElement>;
@@ -51,7 +51,7 @@ export declare class PickList<ItemElement extends HTMLCalcitePickListItemElement
   disconnectedCallback(): void;
   componentDidRender(): void;
   /**
-   * Emitted when any of the item selections have changed.
+   * Emits when any of the `calcite-pick-list-item` selections have changed.
    */
   calciteListChange: EventEmitter<Map<string, HTMLCalcitePickListItemElement>>;
   calciteListItemRemoveHandler(event: CustomEvent<void>): void;
@@ -68,7 +68,7 @@ export declare class PickList<ItemElement extends HTMLCalcitePickListItemElement
   handleFilter: any;
   getItemData: any;
   keyDownHandler: any;
-  /** Returns the currently selected items */
+  /** Returns the component's selected `calcite-pick-list-item`s. */
   getSelectedItems(): Promise<Map<string, HTMLCalcitePickListItemElement>>;
   /**
    * Sets focus on the component.

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

@@ -6,12 +6,12 @@ import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
  */
 export declare class PickListGroup implements ConditionalSlotComponent {
   /**
-   * The title used for all nested `calcite-pick-list` rows.
+   * Specifies the title for all nested `calcite-pick-list-item`s.
    *
    */
   groupTitle: string;
   /**
-   * Number at which section headings should start for this component.
+   * Specifies the number at which section headings should start.
    */
   headingLevel: HeadingLevel;
   el: HTMLCalcitePickListGroupElement;

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

@@ -3,21 +3,21 @@ import { ICON_TYPES } from "../pick-list/resources";
 import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
 import { InteractiveComponent } from "../../utils/interactive";
 /**
- * @slot actions-end - a slot for adding actions or content to the end side of the item.
- * @slot actions-start - a slot for adding actions or content to the start side of the item.
+ * @slot actions-end - A slot for adding actions or content to the end side of the component.
+ * @slot actions-start - A slot for adding actions or content to the start side of the component.
  */
 export declare class PickListItem implements ConditionalSlotComponent, InteractiveComponent {
   /**
-   * An optional description for this item.  This will appear below the label text.
+   * A description for the component that displays below the label text.
    */
   description?: string;
   descriptionWatchHandler(): void;
   /**
-   * When true, the item cannot be clicked and is visually muted.
+   * When true, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
-   * When false, the item cannot be deselected by user interaction.
+   * When false, the component cannot be deselected by user interaction.
    */
   disableDeselect: boolean;
   /**
@@ -31,32 +31,32 @@ export declare class PickListItem implements ConditionalSlotComponent, Interacti
    */
   icon?: ICON_TYPES | null;
   /**
-   * The main label for this item. This will appear next to the icon.
+   * Label and accessible name for the component. Appears next to the icon.
    */
   label: string;
   labelWatchHandler(): void;
   /**
-   * Used to provide additional metadata to an item, primarily used when the parent list has a filter.
+   * Provides additional metadata to the component. Primary use is for a filter on the parent list.
    */
   metadata?: Record<string, unknown>;
   metadataWatchHandler(): void;
   /**
-   * Set this to true to display a remove action that removes the item from the list.
+   * When true, displays a remove action that removes the item from the list.
    */
   removable?: boolean;
   /**
-   * Set this to true to pre-select an item. Toggles when an item is checked/unchecked.
+   * When true, selects an item. Toggles when an item is checked/unchecked.
    */
   selected: boolean;
   selectedWatchHandler(): void;
   /**
-   * Used as an accessible label (aria-label) for the "remove item" action. Only applicable if removable is true.
+   * Accessible name for the component's remove button. Only applicable if removable is "true".
    *
    * @default "Remove"
    */
   intlRemove: string;
   /**
-   * The item's associated value.
+   * The component's value.
    */
   value: any;
   valueWatchHandler(newValue: any, oldValue: any): void;
@@ -67,7 +67,7 @@ export declare class PickListItem implements ConditionalSlotComponent, Interacti
   disconnectedCallback(): void;
   componentDidRender(): void;
   /**
-   * Emitted whenever the item is selected or unselected.
+   * Fires when the component is selected or unselected.
    */
   calciteListItemChange: EventEmitter<{
     item: HTMLCalcitePickListItemElement;
@@ -76,17 +76,17 @@ export declare class PickListItem implements ConditionalSlotComponent, Interacti
     shiftPressed: boolean;
   }>;
   /**
-   * Emitted whenever the remove button is pressed.
+   * Fires when the remove button is pressed.
    */
   calciteListItemRemove: EventEmitter<void>;
   /**
-   * Emitted whenever the the item's label, description, value or metadata properties are modified.
+   * Emits when the the component's label, description, value, or metadata properties are modified.
    *
    * @internal
    */
   calciteInternalListItemPropsChange: EventEmitter<void>;
   /**
-   * Emitted whenever the the item's value property is modified.
+   * Emits when the the component's value property is modified.
    *
    * @internal
    */
@@ -95,7 +95,7 @@ export declare class PickListItem implements ConditionalSlotComponent, Interacti
     newValue: any;
   }>;
   /**
-   * Used to toggle the selection state. By default this won't trigger an event.
+   * Toggles 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

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

@@ -7,25 +7,25 @@ import { HeadingLevel } from "../functional/Heading";
  */
 export declare class Popover {
   /**
-   * Automatically closes any currently open popovers when clicking outside of a popover.
+   * When true and clicking outside of the component, automatically closes open `calcite-popover`s.
    */
   autoClose: boolean;
   /**
-   * Display a close button within the Popover.
+   * When true, a close button is added to the component.
    *
    * @deprecated use dismissible instead.
    */
   closeButton: boolean;
   /**
-   * Display a close button within the Popover.
+   * When true, a close button is added to the component.
    */
   dismissible: boolean;
   /**
-   * Prevents flipping the popover's placement when it starts to overlap its reference element.
+   * When true, prevents flipping the component's placement when overlapping its `referenceElement`.
    */
   disableFlip: boolean;
   /**
-   * Removes the caret pointer.
+   * When true, removes the caret pointer.
    */
   disablePointer: boolean;
   /**
@@ -34,52 +34,52 @@ export declare class Popover {
   flipPlacements?: ComputedPlacement[];
   flipPlacementsHandler(): void;
   /**
-   * Heading text.
+   * The component header text.
    */
   heading?: string;
   /**
-   * Number at which section headings should start for this component.
+   * Specifies the number at which section headings should start.
    */
   headingLevel: HeadingLevel;
-  /** Accessible name for the component */
+  /** Accessible name for the component. */
   label: string;
   /**
-   * Offset the position of the popover away from the reference element.
+   * Offsets the position of the popover away from the `referenceElement`.
    *
    * @default 6
    */
   offsetDistance: number;
   offsetDistanceOffsetHandler(): void;
   /**
-   * Offset the position of the popover along the reference element.
+   * Offsets the position of the popover along the `referenceElement`.
    */
   offsetSkidding: number;
   offsetSkiddingHandler(): void;
   /**
-   * Display and position the component.
+   * When true, displays and positions the component.
    */
   open: boolean;
   openHandler(): void;
-  /** Describes the type of positioning to use for the overlaid content. If your element is in a fixed container, use the 'fixed' value. */
+  /** Describes the positioning type to use for the overlaid content. If the element is in a fixed container, use the "fixed" value. */
   overlayPositioning: OverlayPositioning;
   /**
-   * Determines where the component will be positioned relative to the referenceElement.
+   * 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;
   placementHandler(): void;
   /**
-   * Reference HTMLElement used to position this component according to the placement property. As a convenience, a string ID of the reference element can be used. However, setting this property to use an HTMLElement is preferred so that the component does not need to query the DOM for the referenceElement.
+   *  The `referenceElement` used to position the component according to its "placement" value. Setting to an `HTMLElement` is preferred so the component does not need to query the DOM. However, a string `id` of the reference element can also be used.
    */
   referenceElement: ReferenceElement | string;
   referenceElementHandler(): void;
   /**
-   * 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.
+   * When true, disables automatically toggling the component 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.
+   * Accessible name for the component's close button.
    *
    * @default "Close"
    */
@@ -96,9 +96,9 @@ export declare class Popover {
   componentWillLoad(): void;
   componentDidLoad(): void;
   disconnectedCallback(): void;
-  /** Fired when the popover is closed */
+  /** Fired when the component is closed. */
   calcitePopoverClose: EventEmitter;
-  /** Fired when the popover is opened */
+  /** Fired when the component is opened. */
   calcitePopoverOpen: EventEmitter;
   /** Updates the position of the component. */
   reposition(): Promise<void>;
@@ -109,7 +109,7 @@ export declare class Popover {
    */
   setFocus(focusId?: "close-button"): Promise<void>;
   /**
-   * Toggles the popover's open property.
+   * Toggles the component's open property.
    *
    * @param value
    */

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

@@ -1,15 +1,15 @@
 import { VNode } from "../../stencil-public-runtime";
 export declare class Progress {
   el: HTMLCalciteProgressElement;
-  /** Use indeterminate if finding actual progress value is impossible */
+  /** Use indeterminate if finding actual progress value is impossible. */
   type: "indeterminate" | "determinate";
-  /** Fraction completed, in the range of 0 - 1.0 */
+  /** The component's progress value, with a range of 0.0 - 1.0. */
   value: number;
-  /** Label for the progress indicator */
+  /** Accessible name for the component. */
   label: string;
-  /** Text to display for the progress indicator */
+  /** Text that displays under the component's indicator. */
   text: string;
-  /** For indeterminate progress bars, reverse the animation direction */
+  /** When true and for indeterminate progress bars, reverses the animation direction. */
   reversed: boolean;
   render(): VNode;
 }

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

@@ -43,6 +43,7 @@ export declare class RadioButton implements LabelableComponent, CheckableFormCom
   value: any;
   labelEl: HTMLCalciteLabelElement;
   formEl: HTMLFormElement;
+  defaultChecked: boolean;
   defaultValue: RadioButton["value"];
   rootNode: HTMLElement;
   containerEl: HTMLDivElement;

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

@@ -32,12 +32,15 @@ export declare class RadioGroup implements LabelableComponent, FormComponent, In
   valueHandler(value: string): void;
   /**
    * The group's selected item.
+   *
+   * @readonly
    */
   selectedItem: HTMLCalciteRadioGroupItemElement;
   protected handleSelectedItemChange<T extends HTMLCalciteRadioGroupItemElement>(newItem: T, oldItem: T): void;
   /** specify the width of the group, defaults to auto */
   width: Extract<"auto" | "full", Width>;
   componentWillLoad(): void;
+  componentDidLoad(): void;
   connectedCallback(): void;
   disconnectedCallback(): void;
   componentDidRender(): void;

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

@@ -53,6 +53,8 @@ export declare class Rating implements LabelableComponent, FormComponent, Intera
   render(): any;
   onLabelClick(): void;
   private updateValue;
+  private onKeyboardPressed;
+  private onFocusChange;
   /** Sets focus on the component. */
   setFocus(): Promise<void>;
   labelEl: HTMLCalciteLabelElement;