@esri/calcite-components 1.0.0-beta.95 → 1.0.0-beta.96

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

@@ -5,30 +5,30 @@ import { Alignment, Scale, Status } from "../interfaces";
  */
 export declare class Label {
   el: HTMLCalciteLabelElement;
-  /** specify the text alignment of the label */
+  /** Specifies the text alignment of the component. */
   alignment: Alignment;
   /**
-   * specify the status of the label and any child input / input messages
+   * Specifies the status of the component and any child input, or input messages.
    *
-   * @deprecated set directly on child element instead
+   * @deprecated Set directly on the component the label is bound to instead.
    */
   status: Status;
-  /** The id of the input associated with the label */
+  /** Specifies the `id` of the component the label is bound to. Use when the component the label is bound to does not reside within the component. */
   for: string;
-  /** specify the scale of the label, defaults to m */
+  /** Specifies the size of the component. */
   scale: Scale;
-  /** is the wrapped element positioned inline with the label slotted text */
+  /** Defines the layout of the label in relation to the component. Use `"inline"` positions to wrap the label and component on the same line. */
   layout: "inline" | "inline-space-between" | "default";
   /**
-   * is the label disabled
+   * When `true`, interaction is prevented and the component is displayed with lower opacity.
    *
-   * @deprecated use the `disabled` property on the interactive components instead
+   * @deprecated Use the `disabled` property on the component the label is bound to instead.
    */
   disabled: boolean;
   /**
-   * eliminates any space around the label
+   * When `true`, disables the component's spacing.
    *
-   * @deprecated set the --calcite-label-margin-bottom css variable to 0 instead
+   * @deprecated Set the `--calcite-label-margin-bottom` css variable to `0` instead.
    */
   disableSpacing: boolean;
   /**

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

@@ -7,25 +7,25 @@ import { InteractiveComponent } from "../../utils/interactive";
 /** @slot - A slot for adding text. */
 export declare class Link implements InteractiveComponent {
   el: HTMLCalciteLinkElement;
-  /** is the link disabled  */
+  /** When `true`, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
   /**
    * 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
+   * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-download.
    */
   download: string | boolean;
-  /** optionally pass a href - used to determine if the component should render as a link or an anchor */
+  /** Specifies the URL of the linked resource, which can be set as an absolute or relative path. */
   href?: string;
-  /** optionally pass an icon to display at the end of a button - accepts calcite ui icon names  */
+  /** Specifies an icon to display at the end of the component. */
   iconEnd?: string;
-  /** flip the icon(s) in rtl */
+  /** When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). */
   iconFlipRtl?: FlipContext;
-  /** optionally pass an icon to display at the start of a button - accepts calcite ui icon names  */
+  /** Specifies an icon to display at the start of the component. */
   iconStart?: string;
-  /** The rel attribute to apply to the hyperlink */
+  /** Specifies the relationship to the linked document defined in `href`. */
   rel?: string;
-  /** The target attribute to apply to the hyperlink */
+  /** Specifies the frame or window to open the linked document. */
   target?: string;
   componentDidRender(): void;
   render(): VNode;

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

@@ -8,7 +8,7 @@ import { InteractiveComponent } from "../../utils/interactive";
  */
 export declare class List 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;
   /**

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

@@ -10,7 +10,7 @@ import { InteractiveComponent } from "../../utils/interactive";
  */
 export declare class ListItem implements ConditionalSlotComponent, InteractiveComponent {
   /**
-   * When true, prevents the content of the component from user interaction.
+   * When `true`, prevents the content of the component from user interaction.
    */
   nonInteractive: boolean;
   /**
@@ -18,7 +18,7 @@ export declare class ListItem implements ConditionalSlotComponent, InteractiveCo
    */
   description?: string;
   /**
-   * 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/loader/loader.d.ts

@@ -2,17 +2,27 @@ import { VNode } from "../../stencil-public-runtime";
 import { Scale } from "../interfaces";
 export declare class Loader {
   el: HTMLCalciteLoaderElement;
-  /** When true, the component is active. */
+  /**
+   * When `true`, the component is active.
+   *
+   * @deprecated use global `hidden` attribute instead.
+   * @mdn [hidden](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/hidden)
+   */
   active: boolean;
-  /** When true, displays smaller and appears to the left of the text. */
+  /** When `true`, displays smaller and appears to the left of the text. */
   inline: boolean;
   /** Accessible name for the component. */
   label: string;
   /** Specifies the size of the component. */
   scale: Scale;
-  /** 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 value. Valid only for determinate indicators. Percent complete of 100. */
+  /** The component's value. Valid only for `"determinate"` indicators. Percent complete of 100. */
   value: number;
   /** Text that displays under the component's indicator. */
   text?: string;

package/dist/types/components/modal/assets/modal/t9n/index.d.ts

@@ -0,0 +1,3 @@
+export type Messages = {
+  close: string;
+};

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

@@ -13,30 +13,30 @@ import { OpenCloseComponent } from "../../utils/openCloseComponent";
 export declare class Modal implements ConditionalSlotComponent, OpenCloseComponent {
   el: HTMLCalciteModalElement;
   /**
-   * When true, the `calcite-modal` is active.
+   * When `true`, the component is active.
    *
-   * @deprecated use open instead
+   * @deprecated use `open` instead.
    */
   active: boolean;
-  /** When true,`calcite-modal`  opens  */
+  /** When `true`, displays and positions the component.  */
   open: boolean;
-  /** Passes a function to run before the `calcite-modal` closes. */
+  /** Passes a function to run before the component closes. */
   beforeClose?: (el: HTMLElement) => Promise<void>;
-  /** When true, disables the component's close button. */
+  /** When `true`, disables the component's close button. */
   disableCloseButton: boolean;
-  /** When true, disables the closing of the component when clicked outside. */
+  /** When `true`, disables the closing of the component when clicked outside. */
   disableOutsideClose: boolean;
   /** Accessible name for the component's close button. */
   intlClose: string;
-  /** When true, prevents the component from expanding to the entire screen on mobile devices. */
+  /** When `true`, prevents the component from expanding to the entire screen on mobile devices. */
   docked: boolean;
-  /** When true, disables the default close on escape behavior. */
+  /** When `true`, disables the default close on escape behavior. */
   disableEscape: boolean;
   /** Specifies the size of the component. */
   scale: Scale;
   /** Specifies the width of the component. Can use scale sizes or pass a number (displays in pixels). */
   width: Scale | number;
-  /** Sets the component to always be fullscreen (overrides width). */
+  /** Sets the component to always be fullscreen (overrides `width`). */
   fullscreen: boolean;
   /**
    * Adds a color bar to the top of component for visual impact.
@@ -46,7 +46,7 @@ export declare class Modal implements ConditionalSlotComponent, OpenCloseCompone
   /** Sets the background color of the component's content. */
   backgroundColor: ModalBackgroundColor;
   /**
-   * When true, disables spacing to the content area slot.
+   * When `true`, disables spacing to the content area slot.
    *
    * @deprecated  Use `--calcite-modal-padding` CSS variable instead.
    */

package/dist/types/components/notice/assets/notice/t9n/index.d.ts

@@ -0,0 +1,3 @@
+export type Messages = {
+  close: string;
+};

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

@@ -17,30 +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 present, shows a default recommended icon. You can
-   * also pass a calcite-ui-icon name to display a requested 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/assets/pagination/t9n/index.d.ts

@@ -0,0 +1,4 @@
+export type Messages = {
+  nextLabel: string;
+  previousLabel: string;
+};

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

@@ -1,25 +1,22 @@
 import { EventEmitter, VNode } from "../../stencil-public-runtime";
 import { Scale } from "../interfaces";
-import { GlobalAttrComponent } from "../../utils/globalAttributes";
-import { LangComponent } from "../../utils/locale";
+import { LocalizedComponent, NumberingSystem } from "../../utils/locale";
 export interface PaginationDetail {
   start: number;
   total: number;
   num: number;
 }
-export declare class Pagination implements GlobalAttrComponent, LangComponent {
+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. */
   num: number;
   /**
    * Specifies the Unicode numeral system used by the component for localization.
-   *
-   * @mdn [numberingSystem](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/numberingSystem)
    */
-  numberingSystem?: string;
+  numberingSystem?: NumberingSystem;
   /** Specifies the starting item number. */
   start: number;
   /** Specifies the total number of items. */
@@ -39,7 +36,7 @@ export declare class Pagination implements GlobalAttrComponent, LangComponent {
   /** Specifies the size of the component. */
   scale: Scale;
   el: HTMLCalcitePaginationElement;
-  globalAttributes: {};
+  effectiveLocale: string;
   /**
    * Emits when the selected page changes.
    *

package/dist/types/components/panel/assets/panel/t9n/index.d.ts

@@ -0,0 +1,6 @@
+export type Messages = {
+  back: string;
+  close: string;
+  open: string;
+  options: string;
+};

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>;
   /**
@@ -161,14 +161,12 @@ export declare class Panel implements InteractiveComponent {
   /**
    * Scrolls the component's content to a specified set of coordinates.
    *
-   * ```
-   *   myCalcitePanel.scrollContentTo({
-   *     left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.
-   *     top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element
-   *     behavior: "auto" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).
-   *   });
-   * ```
-   *
+   * @example
+   * myCalciteFlowItem.scrollContentTo({
+   *   left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.
+   *   top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element
+   *   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>;

package/dist/types/components/pick-list/assets/pick-list/t9n/index.d.ts

@@ -0,0 +1,3 @@
+export type Messages = {
+  filterResults: string;
+};

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,25 +25,25 @@ 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>;
   dataForFilter: ItemData;
   items: ItemElement[];
   lastSelectedItem: ItemElement;
-  mutationObserver: MutationObserver;
+  mutationObserver: import("../../utils/observers").ExtendedMutationObserver;
   el: HTMLCalcitePickListElement;
   emitCalciteListChange: () => void;
   filterEl: HTMLCalciteFilterElement;

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

@@ -0,0 +1,3 @@
+export type Messages = {
+  remove: string;
+};

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/assets/popover/t9n/index.d.ts

@@ -0,0 +1,3 @@
+export type Messages = {
+  close: string;
+};