@esri/calcite-components 1.0.0-next.597 → 1.0.0-next.599

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

@@ -17,29 +17,29 @@ import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
 export declare class Notice implements ConditionalSlotComponent {
   el: HTMLCalciteNoticeElement;
   /**
-   * When true, the component is active.
+   * When `true`, the component is active.
    *
-   * @deprecated Use open instead.
+   * @deprecated Use `open` instead.
    */
   active: boolean;
   activeHandler(value: boolean): void;
-  /** When true, the component is visible */
+  /** When `true`, the component is visible. */
   open: boolean;
   openHandler(value: boolean): void;
   /** The color for the component's top border and icon. */
   color: StatusColor;
   /**
-   * When true, a close button is added to the component.
+   * When `true`, a close button is added to the component.
    *
-   * @deprecated use closable instead
+   * @deprecated use `closable` instead.
    */
   dismissible?: boolean;
   handleDismissible(value: boolean): void;
-  /** When true, displays a button user can click to dismiss the `calcite-notice` */
+  /** When `true`, a close button is added to the component. */
   closable?: boolean;
   handleClosable(value: boolean): void;
   /**
-   * When true, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon.
+   * When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon.
    */
   icon: string | boolean;
   /**

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

@@ -1,7 +1,7 @@
 import { VNode } from "../../stencil-public-runtime";
 export declare class Option {
   /**
-   * When true, interaction is prevented and the component is displayed with lower opacity.
+   * When `true`, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
@@ -9,7 +9,7 @@ export declare class Option {
    */
   label: string;
   /**
-   * When true, the component is selected.
+   * When `true`, the component is selected.
    */
   selected: boolean;
   /**

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

@@ -4,7 +4,7 @@ import { VNode } from "../../stencil-public-runtime";
  */
 export declare class OptionGroup {
   /**
-   * When true, interaction is prevented and the component is displayed with lower opacity.
+   * When `true`, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**

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

@@ -8,7 +8,7 @@ export interface PaginationDetail {
 }
 export declare class Pagination implements LocalizedComponent {
   /**
-   * When true, number values are displayed with a group separator corresponding to the language and country format.
+   * When `true`, number values are displayed with a group separator corresponding to the language and country format.
    */
   groupSeparator: boolean;
   /** Specifies the number of items per page. */

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

@@ -14,12 +14,12 @@ import { InteractiveComponent } from "../../utils/interactive";
  */
 export declare class Panel implements InteractiveComponent {
   /**
-   * When true, hides the component.
+   * When `true`, hides the component.
    *
-   * @deprecated use closed instead
+   * @deprecated use `closed` instead.
    */
   dismissed: boolean;
-  /** When true, panel will be hidden */
+  /** When `true`, the component will be hidden. */
   closed: boolean;
   dismissedHandler(value: boolean): void;
   closedHandler(value: boolean): void;
@@ -30,17 +30,17 @@ export declare class Panel implements InteractiveComponent {
    */
   beforeBack?: () => Promise<void>;
   /**
-   *  When true, interaction is prevented and the component is displayed with lower opacity.
+   *  When `true`, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
-   * When true, a close button is added to the component.
+   * When `true`, a close button is added to the component.
    *
-   * @deprecated use closable instead
+   * @deprecated use `closable` instead
    */
   dismissible: boolean;
   dismissibleHandler(value: boolean): void;
-  /** When true, displays a close button in the trailing side of the header */
+  /** When `true`, displays a close button in the trailing side of the header. */
   closable: boolean;
   closableHandler(value: boolean): void;
   /**
@@ -48,13 +48,13 @@ export declare class Panel implements InteractiveComponent {
    */
   headingLevel: HeadingLevel;
   /**
-   * When true, displays a back button in the header.
+   * When `true`, displays a back button in the header.
    *
    * @deprecated use `calcite-flow-item` instead.
    */
   showBackButton: boolean;
   /**
-   * Accessible name for the component's back button. The back button will only be shown when 'showBackButton' is true.
+   * Accessible name for the component's back button. The back button will only be shown when `showBackButton` is `true`.
    *
    * @deprecated use `calcite-flow-item` instead.
    */
@@ -68,11 +68,11 @@ export declare class Panel implements InteractiveComponent {
    */
   widthScale?: Scale;
   /**
-   * When true, a busy indicator is displayed.
+   * When `true`, a busy indicator is displayed.
    */
   loading: boolean;
   /**
-   * Accessible name for the component's 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 `closeable` is `true`.
    */
   intlClose?: string;
   /**
@@ -86,13 +86,13 @@ export declare class Panel implements InteractiveComponent {
   /**
    * Summary text. A description displayed underneath the heading.
    *
-   * @deprecated use description instead
+   * @deprecated use `description` instead.
    */
   summary?: string;
   /** A description for the component. */
   description: string;
   /**
-   * When true, the action menu items in the `header-menu-actions` slot are open.
+   * When `true`, the action menu items in the `header-menu-actions` slot are open.
    */
   menuOpen: boolean;
   componentDidRender(): void;
@@ -118,13 +118,13 @@ export declare class Panel implements InteractiveComponent {
   /**
    * Fires when the close button is clicked.
    *
-   * @deprecated use calcitePanelClose instead.
+   * @deprecated use `calcitePanelClose` instead.
    */
   calcitePanelDismiss: EventEmitter<void>;
   /**
    * Fires when there is a change to the `dismissed` property value .
    *
-   * @deprecated use calcitePanelClose instead.
+   * @deprecated use `calcitePanelClose` instead.
    */
   calcitePanelDismissedChange: EventEmitter<void>;
   /**

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

@@ -9,11 +9,11 @@ import { InteractiveComponent } from "../../utils/interactive";
  */
 export declare class PickList<ItemElement extends HTMLCalcitePickListItemElement = HTMLCalcitePickListItemElement> implements InteractiveComponent {
   /**
-   * When true, interaction is prevented and the component is displayed with lower opacity.
+   * When `true`, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
-   * When true, an input appears at the top of the list that can be used by end users to filter items in the list.
+   * When `true`, an input appears at the top of the list that can be used by end users to filter items in the list.
    */
   filterEnabled: boolean;
   /**
@@ -25,18 +25,18 @@ export declare class PickList<ItemElement extends HTMLCalcitePickListItemElement
    */
   headingLevel: HeadingLevel;
   /**
-   * When true, a busy indicator is displayed.
+   * When `true`, a busy indicator is displayed.
    */
   loading: boolean;
   /**
    * 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,
+   * 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 changes when navigating `calcite-pick-list-item`s via 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>;

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

@@ -3,8 +3,8 @@ 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 component.
- * @slot actions-start - A slot for adding actions or content to the start side of the component.
+ * @slot actions-end - A slot for adding `calcite-action`s or content to the end side of the component.
+ * @slot actions-start - A slot for adding `calcite-action`s or content to the start side of the component.
  */
 export declare class PickListItem implements ConditionalSlotComponent, InteractiveComponent {
   /**
@@ -13,11 +13,11 @@ export declare class PickListItem implements ConditionalSlotComponent, Interacti
   description?: string;
   descriptionWatchHandler(): void;
   /**
-   * When true, interaction is prevented and the component is displayed with lower opacity.
+   * When `true`, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
-   * When false, the component cannot be deselected by user interaction.
+   * When `false`, the component cannot be deselected by user interaction.
    */
   disableDeselect: boolean;
   /**
@@ -25,7 +25,7 @@ export declare class PickListItem implements ConditionalSlotComponent, Interacti
    */
   nonInteractive: boolean;
   /**
-   * Determines the icon SVG symbol that will be shown. Options are circle, square, grip or null.
+   * 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)
    */
@@ -41,16 +41,16 @@ export declare class PickListItem implements ConditionalSlotComponent, Interacti
   metadata?: Record<string, unknown>;
   metadataWatchHandler(): void;
   /**
-   * When true, displays 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;
   /**
-   * When true, selects 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;
   /**
-   * Accessible name for the component's remove button. Only applicable if removable is "true".
+   * When `removable` is `true`, the accessible name for the component's remove button.
    *
    * @default "Remove"
    */

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

@@ -11,27 +11,27 @@ export declare class Popover implements FloatingUIComponent, OpenCloseComponent
    */
   autoClose: boolean;
   /**
-   * When true, a close button is added to the component.
+   * When `true`, a close button is added to the component.
    *
    * @deprecated use dismissible instead.
    */
   closeButton: boolean;
   /**
-   * When true, a close button is added to the component.
+   * When `true`, a close button is added to the component.
    *
-   * @deprecated use closable instead
+   * @deprecated use `closable` instead.
    */
   dismissible: boolean;
   handleDismissible(value: boolean): void;
-  /** When true, display a close button within the Popover */
+  /** When `true`, display a close button within the component. */
   closable: boolean;
   handleClosable(value: boolean): void;
   /**
-   * When true, prevents flipping the component's placement when overlapping its `referenceElement`.
+   * When `true`, prevents flipping the component's placement when overlapping its `referenceElement`.
    */
   disableFlip: boolean;
   /**
-   * When true, removes the caret pointer.
+   * When `true`, removes the caret pointer.
    */
   disablePointer: boolean;
   /**
@@ -50,19 +50,19 @@ export declare class Popover implements FloatingUIComponent, OpenCloseComponent
   /** Accessible name for the component. */
   label: string;
   /**
-   * Offsets the position of the popover away from the `referenceElement`.
+   * Offsets the position of the component away from the `referenceElement`.
    *
    * @default 6
    */
   offsetDistance: number;
   offsetDistanceOffsetHandler(): void;
   /**
-   * Offsets the position of the popover along the `referenceElement`.
+   * Offsets the position of the component along the `referenceElement`.
    */
   offsetSkidding: number;
   offsetSkiddingHandler(): void;
   /**
-   * When true, displays and positions the component.
+   * When `true`, displays and positions the component.
    */
   open: boolean;
   openHandler(): void;
@@ -84,12 +84,14 @@ export declare class Popover implements FloatingUIComponent, OpenCloseComponent
   placement: LogicalPlacement;
   placementHandler(): void;
   /**
-   *  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.
+   *  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;
   /**
-   * 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.
+   * When `true`, disables automatically toggling the component when its `referenceElement` has been triggered.
+   *
+   * This property can be set to `true` to manage when the component is open.
    */
   triggerDisabled: boolean;
   /**

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

@@ -1,7 +1,12 @@
 import { VNode } from "../../stencil-public-runtime";
 export declare class Progress {
   el: HTMLCalciteProgressElement;
-  /** Use indeterminate if finding actual progress value is impossible. */
+  /**
+   * Specifies the component type.
+   *
+   * Use `"indeterminate"` if finding actual progress value is impossible.
+   *
+   */
   type: "indeterminate" | "determinate";
   /** The component's progress value, with a range of 0.0 - 1.0. */
   value: number;
@@ -9,7 +14,7 @@ export declare class Progress {
   label: string;
   /** Text that displays under the component's indicator. */
   text: string;
-  /** When true and for indeterminate progress bars, reverses 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

@@ -5,10 +5,10 @@ import { CheckableFormComponent } from "../../utils/form";
 import { InteractiveComponent } from "../../utils/interactive";
 export declare class RadioButton implements LabelableComponent, CheckableFormComponent, InteractiveComponent {
   el: HTMLCalciteRadioButtonElement;
-  /** When true, the component is checked. */
+  /** When `true`, the component is checked. */
   checked: boolean;
   checkedChanged(newChecked: boolean): void;
-  /** When true, interaction is prevented and the component is displayed with lower opacity. */
+  /** When `true`, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
   /**
    * The focused state of the component.
@@ -16,9 +16,9 @@ export declare class RadioButton implements LabelableComponent, CheckableFormCom
    * @internal
    */
   focused: boolean;
-  /** The id attribute of the component. When omitted, a globally unique identifier is used. */
+  /** The `id` of the component. When omitted, a globally unique identifier is used. */
   guid: string;
-  /** When true, the component is not displayed and is not focusable or checkable. */
+  /** When `true`, the component is not displayed and is not focusable or checkable. */
   hidden: boolean;
   /**
    * The hovered state of the component.
@@ -35,7 +35,7 @@ export declare class RadioButton implements LabelableComponent, CheckableFormCom
   /** Specifies the name of the component, passed from the `calcite-radio-button-group` on form submission. */
   name: string;
   nameChanged(): void;
-  /** When true, the component must have a value selected from the `calcite-radio-button-group` in order for the form to submit. */
+  /** When `true`, the component must have a value selected from the `calcite-radio-button-group` in order for the form to submit. */
   required: boolean;
   /** Specifies the size of the component inherited from the `calcite-radio-button-group`. */
   scale: Scale;
@@ -72,7 +72,7 @@ export declare class RadioButton implements LabelableComponent, CheckableFormCom
    * Fires only when the radio button is checked.  This behavior is identical to the native HTML input element.
    * Since this event does not fire when the radio button is unchecked, it's not recommended to attach a listener for this event
    * directly on the element, but instead either attach it to a node that contains all of the radio buttons in the group
-   * or use the calciteRadioButtonGroupChange event if using this with calcite-radio-button-group.
+   * or use the `calciteRadioButtonGroupChange` event if using this with `calcite-radio-button-group`.
    */
   calciteRadioButtonChange: EventEmitter<void>;
   /**

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

@@ -5,10 +5,10 @@ import { Layout, Scale } from "../interfaces";
  */
 export declare class RadioButtonGroup {
   el: HTMLCalciteRadioButtonGroupElement;
-  /** When true, interaction is prevented and the component is displayed with lower opacity. */
+  /** When `true`, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
   onDisabledChange(): void;
-  /** When true, the component is not displayed and its `calcite-radio-button`s are not focusable or checkable. */
+  /** When `true`, the component is not displayed and its `calcite-radio-button`s are not focusable or checkable. */
   hidden: boolean;
   onHiddenChange(): void;
   /** Defines the layout of the component. */
@@ -16,7 +16,7 @@ export declare class RadioButtonGroup {
   onLayoutChange(): void;
   /** Specifies the name of the component on form submission. Must be unique to other component instances. */
   name: string;
-  /** When true, the component must have a value in order for the form to submit. */
+  /** When `true`, the component must have a value in order for the form to submit. */
   required: boolean;
   /** Specifies the size of the component. */
   scale: Scale;

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

@@ -11,10 +11,10 @@ export declare class RadioGroup implements LabelableComponent, FormComponent, In
   el: HTMLCalciteRadioGroupElement;
   /** Specifies the appearance style of the component. */
   appearance: RadioAppearance;
-  /** When true, interaction is prevented and the component is displayed with lower opacity. */
+  /** When `true`, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
   /**
-   * When true, the component must have a value in order for the form to submit.
+   * When `true`, the component must have a value in order for the form to submit.
    *
    * @internal
    */
@@ -27,7 +27,7 @@ export declare class RadioGroup implements LabelableComponent, FormComponent, In
   name: string;
   /** Specifies the size of the component. */
   scale: Scale;
-  /** The component's "selectedItem" value. */
+  /** The component's `selectedItem` value. */
   value: string;
   valueHandler(value: string): void;
   /**

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

@@ -2,7 +2,7 @@ import { EventEmitter, VNode } from "../../stencil-public-runtime";
 import { Position } from "../interfaces";
 export declare class RadioGroupItem {
   el: HTMLCalciteRadioGroupItemElement;
-  /** When true, the component is checked. */
+  /** When `true`, the component is checked. */
   checked: boolean;
   protected handleCheckedChange(): void;
   /**
@@ -11,7 +11,7 @@ export declare class RadioGroupItem {
    * @deprecated Use either `iconStart` or `iconEnd` but do not combine them with `icon` and `iconPosition`.
    */
   icon?: string;
-  /** When true, the icon will be flipped when the element direction is right-to-left (`"rtl"`). */
+  /** When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). */
   iconFlipRtl: boolean;
   /**
    * Specifies the placement of the icon.

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

@@ -9,11 +9,11 @@ export declare class Rating implements LabelableComponent, FormComponent, Intera
   scale: Scale;
   /** The component's value. */
   value: number;
-  /** When true, the component's value can be read, but cannot be modified. */
+  /** When `true`, the component's value can be read, but cannot be modified. */
   readOnly: boolean;
-  /** When true, interaction is prevented and the component is displayed with lower opacity. */
+  /** When `true`, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
-  /** When true, and if available, displays the "average" and/or "count" data summary in a `calcite-chip`. */
+  /** When `true`, and if available, displays the `average` and/or `count` data summary in a `calcite-chip`. */
   showChip: boolean;
   /** Specifies the number of previous ratings to display. */
   count?: number;
@@ -34,7 +34,7 @@ export declare class Rating implements LabelableComponent, FormComponent, Intera
    */
   intlStars?: string;
   /**
-   * When true, the component must have a value in order for the form to submit.
+   * When `true`, the component must have a value in order for the form to submit.
    *
    * @internal
    */

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

@@ -10,7 +10,7 @@ export declare class Scrim {
    */
   intlLoading?: string;
   /**
-   * When true, a busy indicator is displayed.
+   * When `true`, a busy indicator is displayed.
    */
   loading: boolean;
   el: HTMLCalciteScrimElement;

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

@@ -8,7 +8,7 @@ import { InteractiveComponent } from "../../utils/interactive";
  */
 export declare class Select implements LabelableComponent, FormComponent, InteractiveComponent {
   /**
-   * When true, interaction is prevented and the component is displayed with lower opacity.
+   * When `true`, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
@@ -21,7 +21,7 @@ export declare class Select implements LabelableComponent, FormComponent, Intera
    */
   name: string;
   /**
-   * When true, the component must have a value in order for the form to submit.
+   * When `true`, the component must have a value in order for the form to submit.
    *
    * @internal
    */
@@ -30,7 +30,7 @@ export declare class Select implements LabelableComponent, FormComponent, Intera
    * Specifies the size of the component.
    */
   scale: Scale;
-  /** The component's "selectedOption" value. */
+  /** The component's `selectedOption` value. */
   value: string;
   valueHandler(value: string): void;
   /**
@@ -58,7 +58,7 @@ export declare class Select implements LabelableComponent, FormComponent, Intera
   /** Sets focus on the component. */
   setFocus(): Promise<void>;
   /**
-   * Fires when the selected option changes.
+   * Fires when the `selectedOption` changes.
    */
   calciteSelectChange: EventEmitter<void>;
   private handleInternalSelectChange;

package/dist/types/components/shell-center-row/shell-center-row.d.ts

@@ -7,7 +7,7 @@ import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
  */
 export declare class ShellCenterRow implements ConditionalSlotComponent {
   /**
-   * When true, the content area displays like a floating panel.
+   * When `true`, the content area displays like a floating panel.
    */
   detached: boolean;
   /**

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

@@ -7,16 +7,16 @@ import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
  */
 export declare class ShellPanel implements ConditionalSlotComponent {
   /**
-   * When true, hides the component's content area.
+   * When `true`, hides the component's content area.
    */
   collapsed: boolean;
   watchHandler(): void;
   /**
-   * When true, the content area displays like a floating panel.
+   * When `true`, the content area displays like a floating panel.
    */
   detached: boolean;
   /**
-   * When "detached", specifies the maximum height of the component.
+   * When `detached`, specifies the maximum height of the component.
    */
   detachedHeightScale: Scale;
   /**
@@ -34,7 +34,7 @@ export declare class ShellPanel implements ConditionalSlotComponent {
    */
   intlResize: string;
   /**
-   * When true and not "detached", the component's content area is resizable.
+   * When `true` and not `detached`, the component's content area is resizable.
    */
   resizable: boolean;
   connectedCallback(): void;
@@ -53,7 +53,7 @@ export declare class ShellPanel implements ConditionalSlotComponent {
   /**
    * Emitted when collapse has been toggled.
    *
-   * @deprecated use a resizeObserver on the component to listen for changes to its size.
+   * @deprecated use a `ResizeObserver` on the component to listen for changes to its size.
    */
   calciteShellPanelToggle: EventEmitter<void>;
   renderHeader(): VNode;