@esri/calcite-components 1.0.0-next.499 → 1.0.0-next.500

package/dist/types/components.d.ts

@@ -39,98 +39,98 @@ import { TreeItemSelectDetail } from "./components/tree-item/interfaces";
 export namespace Components {
     interface CalciteAccordion {
         /**
-          * specify the appearance - default (containing border), or minimal (no containing border), defaults to default
+          * Specifies the appearance of the component.
          */
         "appearance": AccordionAppearance;
         /**
-          * specify the placement of the icon in the header, defaults to end
+          * Specifies the placement of the icon in the header.
          */
         "iconPosition": Position;
         /**
-          * specify the type of the icon in the header, defaults to chevron
+          * Specifies the type of the icon in the header.
          */
         "iconType": "chevron" | "caret" | "plus-minus";
         /**
-          * specify the scale of accordion, defaults to m
+          * Specifies the size of the component.
          */
         "scale": Scale;
         /**
-          * specify the selection mode - multi (allow any number of open items), single (allow one open item), or single-persist (allow and require one open item), defaults to multi
+          * Specifies the selection mode - "multi" (allow any number of open items), "single" (allow one open item), or "single-persist" (allow and require one open item).
          */
         "selectionMode": "multi" | "single" | "single-persist";
     }
     interface CalciteAccordionItem {
         /**
-          * Indicates whether the item is active.
+          * When true, the component is active.
          */
         "active": boolean;
         /**
-          * accordion item description
+          * Specifies a description for the component.
          */
         "description": string;
         /**
-          * accordion item heading
+          * Specifies heading text for the component.
          */
         "heading"?: string;
         /**
-          * optionally pass an icon to display - accepts Calcite UI icon names
+          * Specifies an icon to display - accepts Calcite UI icon names.
          */
         "icon"?: string;
         /**
-          * pass a title for the accordion item
-          * @deprecated use description instead
+          * Specifies a subtitle for the component.
+          * @deprecated Use `description` instead.
          */
         "itemSubtitle"?: string;
         /**
-          * pass a title for the accordion item
-          * @deprecated use heading instead
+          * Specifies a title for the component.
+          * @deprecated Use `heading` instead.
          */
         "itemTitle"?: string;
     }
     interface CalciteAction {
         /**
-          * Indicates whether the action is highlighted.
+          * When true, the component is highlighted.
          */
         "active": boolean;
         /**
-          * Optionally specify the horizontal alignment of button elements with text content.
+          * Specifies the horizontal alignment of button elements with text content.
          */
         "alignment"?: Alignment;
         /**
-          * Specify the appearance style of the action, defaults to solid.
+          * Specifies the appearance of the component.
          */
         "appearance": Extract<"solid" | "clear", Appearance>;
         /**
-          * Compact mode is used internally by components to reduce side padding, e.g. calcite-block-section.
+          * When true, the side padding of the component is reduced. Compact mode is used internally by components, e.g. `calcite-block-section`.
          */
         "compact": boolean;
         /**
-          * 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;
         /**
-          * The name of the icon to display. The value of this property must match the icon name from https://esri.github.io/calcite-ui-icons/.
+          * Specifies an icon to display - accepts Calcite UI icon names.
          */
         "icon"?: string;
         /**
-          * Indicates unread changes.
+          * When true, indicates unread changes.
          */
         "indicator": boolean;
         /**
-          * string to override English loading text
+          * Specifies the text label to display while loading.
           * @default "Loading"
          */
         "intlLoading"?: string;
         /**
-          * The label of the action. If no label is provided, the label inherits what's provided for the `text` prop.
+          * Specifies the label of the component. If no label is provided, the label inherits what's provided for the `text` prop.
          */
         "label"?: string;
         /**
-          * When true, content is waiting to be loaded. This state shows a busy indicator.
+          * When true, a busy indicator is displayed.
          */
         "loading": boolean;
         /**
-          * Specifies the size of the action.
+          * Specifies the size of the component.
          */
         "scale": Scale;
         /**
@@ -138,7 +138,7 @@ export namespace Components {
          */
         "setFocus": () => Promise<void>;
         /**
-          * Text that accompanies the action icon.
+          * Specifies text that accompanies the icon.
          */
         "text": string;
         /**
@@ -148,19 +148,19 @@ export namespace Components {
     }
     interface CalciteActionBar {
         /**
-          * When set to true, the expand-toggling behavior will be disabled.
+          * When true, the expand-toggling behavior is disabled.
          */
         "expandDisabled": boolean;
         /**
-          * Indicates whether widget is expanded.
+          * When true, the component is expanded.
          */
         "expanded": boolean;
         /**
-          * Updates the label of the collapse icon when the component is expanded.
+          * Specifies the label of the collapse icon when the component is expanded.
          */
         "intlCollapse"?: string;
         /**
-          * Updates the label of the expand icon when the component is not expanded.
+          * Specifies the label of the expand icon when the component is collapsed.
          */
         "intlExpand"?: string;
         /**
@@ -168,15 +168,15 @@ export namespace Components {
          */
         "overflowActions": () => Promise<void>;
         /**
-          * Disables automatically overflowing actions that won't fit into menus.
+          * Disables automatically overflowing `calcite-action`s that won't fit into menus.
          */
         "overflowActionsDisabled": boolean;
         /**
-          * Arranges the component depending on the elements 'dir' property.
+          * Arranges the component depending on the element's `dir` property.
          */
         "position": Position;
         /**
-          * Specifies the size of the expand action.
+          * Specifies the size of the expand `calcite-action`.
          */
         "scale": Scale;
         /**
@@ -191,29 +191,29 @@ export namespace Components {
          */
         "columns"?: Columns;
         /**
-          * Indicates whether widget is expanded.
+          * When true, the component is expanded.
          */
         "expanded": boolean;
         /**
-          * Text string for the actions menu.
+          * Specifies a text string for the `calcite-action-menu`.
          */
         "intlMore"?: string;
         /**
-          * Indicates the horizontal, vertical, or grid layout of the component.
+          * Indicates the layout of the component.
          */
         "layout": Layout;
         /**
-          * Opens the action menu.
+          * When true, the `calcite-action-menu` is open.
          */
         "menuOpen": boolean;
         /**
-          * Specifies the size of the action-menu.
+          * Specifies the size of the `calcite-action-menu`.
          */
         "scale": Scale;
     }
     interface CalciteActionMenu {
         /**
-          * Indicates whether widget is expanded.
+          * When true, the component is expanded.
          */
         "expanded": boolean;
         /**
@@ -221,24 +221,24 @@ export namespace Components {
          */
         "flipPlacements"?: ComputedPlacement[];
         /**
-          * Text string for the actions menu.
+          * Specifies the text string for the component.
          */
         "label": string;
         /**
-          * Opens the action menu.
+          * When true, the component is open.
          */
         "open": boolean;
         /**
-          * Describes the type of positioning to use for the overlaid content. If your element is in a fixed container, use the 'fixed' value.
+          * Determines the type of positioning to use for the overlaid content. If your element is in a fixed container, use the "fixed" value.
          */
         "overlayPositioning": OverlayPositioning;
         /**
-          * Determines where the 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;
         /**
-          * Specifies the size of the menu trigger action.
+          * Specifies the size of the component's trigger `calcite-action`.
          */
         "scale": Scale;
         /**
@@ -248,31 +248,31 @@ export namespace Components {
     }
     interface CalciteActionPad {
         /**
-          * When set to true, the expand-toggling behavior will be disabled.
+          * When true, the expand-toggling behavior is disabled.
          */
         "expandDisabled": boolean;
         /**
-          * Indicates whether widget is expanded.
+          * When true, the component is expanded.
          */
         "expanded": boolean;
         /**
-          * Updates the label of the collapse icon when the component is expanded.
+          * Specifies the label of the collapse icon when the component is expanded.
          */
         "intlCollapse"?: string;
         /**
-          * Updates the label of the expand icon when the component is not expanded.
+          * Specifies the label of the expand icon when the component is collapsed.
          */
         "intlExpand"?: string;
         /**
-          * Indicates the horizontal or vertical layout of the component.
+          * Indicates the layout of the component.
          */
         "layout": Layout;
         /**
-          * Arranges the component depending on the elements 'dir' property.
+          * Arranges the component depending on the element's `dir` property.
          */
         "position": Position;
         /**
-          * Specifies the size of the expand action.
+          * Specifies the size of the expand `calcite-action`.
          */
         "scale": Scale;
         /**
@@ -283,40 +283,40 @@ export namespace Components {
     }
     interface CalciteAlert {
         /**
-          * Is the alert currently active or not
+          * When true, the component is active.
          */
         "active": boolean;
         /**
-          * Close the alert automatically (recommended for passive, non-blocking alerts)
+          * When true, the component closes automatically (recommended for passive, non-blocking alerts).
          */
         "autoDismiss": boolean;
         /**
-          * Duration of autoDismiss (only used with `autoDismiss`)
+          * Specifies the duration before the component automatically closes (only use with `autoDismiss`).
          */
         "autoDismissDuration": AlertDuration;
         /**
-          * Color for the alert (will apply to top border and icon)
+          * Specifies the color for the component (will apply to top border and icon).
          */
         "color": StatusColor;
         /**
-          * 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 true, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon.
          */
         "icon": string | boolean;
         /**
-          * string to override English close text
+          * Specifies the text label for the close button.
           * @default "Close"
          */
         "intlClose": string;
         /**
-          * Accessible name for the component
+          * Specifies an accessible name for the component.
          */
         "label": string;
         /**
-          * specify the placement of the alert
+          * Specifies the placement of the component
          */
         "placement": AlertPlacement;
         /**
-          * specify the scale of the alert, defaults to m
+          * Specifies the size of the component.
          */
         "scale": Scale;
         /**
@@ -326,23 +326,23 @@ export namespace Components {
     }
     interface CalciteAvatar {
         /**
-          * full name of the user
+          * Specifies the full name of the user.
          */
         "fullName": string;
         /**
-          * specify the scale of the avatar, defaults to m
+          * Specifies the size of the component.
          */
         "scale": Scale;
         /**
-          * src to an image (remember to add a token if the user is private)
+          * Specifies the `src` to an image (remember to add a token if the user is private).
          */
         "thumbnail": string;
         /**
-          * unique id for user
+          * Specifies the unique id of the user.
          */
         "userId": string;
         /**
-          * user name
+          * Specifies the username of the user.
          */
         "username": string;
     }
@@ -395,6 +395,10 @@ export namespace Components {
           * When true, content is waiting to be loaded. This state shows a busy indicator.
          */
         "loading": boolean;
+        /**
+          * When true, removes padding for the slotted content
+         */
+        "noPadding": boolean;
         /**
           * When true, the block's content will be displayed.
          */
@@ -4493,107 +4497,107 @@ declare global {
 declare namespace LocalJSX {
     interface CalciteAccordion {
         /**
-          * specify the appearance - default (containing border), or minimal (no containing border), defaults to default
+          * Specifies the appearance of the component.
          */
         "appearance"?: AccordionAppearance;
         /**
-          * specify the placement of the icon in the header, defaults to end
+          * Specifies the placement of the icon in the header.
          */
         "iconPosition"?: Position;
         /**
-          * specify the type of the icon in the header, defaults to chevron
+          * Specifies the type of the icon in the header.
          */
         "iconType"?: "chevron" | "caret" | "plus-minus";
         /**
-          * specify the scale of accordion, defaults to m
+          * Specifies the size of the component.
          */
         "scale"?: Scale;
         /**
-          * specify the selection mode - multi (allow any number of open items), single (allow one open item), or single-persist (allow and require one open item), defaults to multi
+          * Specifies the selection mode - "multi" (allow any number of open items), "single" (allow one open item), or "single-persist" (allow and require one open item).
          */
         "selectionMode"?: "multi" | "single" | "single-persist";
     }
     interface CalciteAccordionItem {
         /**
-          * Indicates whether the item is active.
+          * When true, the component is active.
          */
         "active"?: boolean;
         /**
-          * accordion item description
+          * Specifies a description for the component.
          */
         "description"?: string;
         /**
-          * accordion item heading
+          * Specifies heading text for the component.
          */
         "heading"?: string;
         /**
-          * optionally pass an icon to display - accepts Calcite UI icon names
+          * Specifies an icon to display - accepts Calcite UI icon names.
          */
         "icon"?: string;
         /**
-          * pass a title for the accordion item
-          * @deprecated use description instead
+          * Specifies a subtitle for the component.
+          * @deprecated Use `description` instead.
          */
         "itemSubtitle"?: string;
         /**
-          * pass a title for the accordion item
-          * @deprecated use heading instead
+          * Specifies a title for the component.
+          * @deprecated Use `heading` instead.
          */
         "itemTitle"?: string;
     }
     interface CalciteAction {
         /**
-          * Indicates whether the action is highlighted.
+          * When true, the component is highlighted.
          */
         "active"?: boolean;
         /**
-          * Optionally specify the horizontal alignment of button elements with text content.
+          * Specifies the horizontal alignment of button elements with text content.
          */
         "alignment"?: Alignment;
         /**
-          * Specify the appearance style of the action, defaults to solid.
+          * Specifies the appearance of the component.
          */
         "appearance"?: Extract<"solid" | "clear", Appearance>;
         /**
-          * Compact mode is used internally by components to reduce side padding, e.g. calcite-block-section.
+          * When true, the side padding of the component is reduced. Compact mode is used internally by components, e.g. `calcite-block-section`.
          */
         "compact"?: boolean;
         /**
-          * 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;
         /**
-          * The name of the icon to display. The value of this property must match the icon name from https://esri.github.io/calcite-ui-icons/.
+          * Specifies an icon to display - accepts Calcite UI icon names.
          */
         "icon"?: string;
         /**
-          * Indicates unread changes.
+          * When true, indicates unread changes.
          */
         "indicator"?: boolean;
         /**
-          * string to override English loading text
+          * Specifies the text label to display while loading.
           * @default "Loading"
          */
         "intlLoading"?: string;
         /**
-          * The label of the action. If no label is provided, the label inherits what's provided for the `text` prop.
+          * Specifies the label of the component. If no label is provided, the label inherits what's provided for the `text` prop.
          */
         "label"?: string;
         /**
-          * When true, content is waiting to be loaded. This state shows a busy indicator.
+          * When true, a busy indicator is displayed.
          */
         "loading"?: boolean;
         /**
-          * Emitted when the action has been clicked.
+          * Emits when the component has been clicked.
           * @deprecated use onClick instead.
          */
         "onCalciteActionClick"?: (event: CalciteActionCustomEvent<any>) => void;
         /**
-          * Specifies the size of the action.
+          * Specifies the size of the component.
          */
         "scale"?: Scale;
         /**
-          * Text that accompanies the action icon.
+          * Specifies text that accompanies the icon.
          */
         "text": string;
         /**
@@ -4603,35 +4607,35 @@ declare namespace LocalJSX {
     }
     interface CalciteActionBar {
         /**
-          * When set to true, the expand-toggling behavior will be disabled.
+          * When true, the expand-toggling behavior is disabled.
          */
         "expandDisabled"?: boolean;
         /**
-          * Indicates whether widget is expanded.
+          * When true, the component is expanded.
          */
         "expanded"?: boolean;
         /**
-          * Updates the label of the collapse icon when the component is expanded.
+          * Specifies the label of the collapse icon when the component is expanded.
          */
         "intlCollapse"?: string;
         /**
-          * Updates the label of the expand icon when the component is not expanded.
+          * Specifies the label of the expand icon when the component is collapsed.
          */
         "intlExpand"?: string;
         /**
-          * Emitted when expanded has been toggled.
+          * Emits when the `expanded` property is toggled.
          */
         "onCalciteActionBarToggle"?: (event: CalciteActionBarCustomEvent<any>) => void;
         /**
-          * Disables automatically overflowing actions that won't fit into menus.
+          * Disables automatically overflowing `calcite-action`s that won't fit into menus.
          */
         "overflowActionsDisabled"?: boolean;
         /**
-          * Arranges the component depending on the elements 'dir' property.
+          * Arranges the component depending on the element's `dir` property.
          */
         "position"?: Position;
         /**
-          * Specifies the size of the expand action.
+          * Specifies the size of the expand `calcite-action`.
          */
         "scale"?: Scale;
     }
@@ -4641,29 +4645,29 @@ declare namespace LocalJSX {
          */
         "columns"?: Columns;
         /**
-          * Indicates whether widget is expanded.
+          * When true, the component is expanded.
          */
         "expanded"?: boolean;
         /**
-          * Text string for the actions menu.
+          * Specifies a text string for the `calcite-action-menu`.
          */
         "intlMore"?: string;
         /**
-          * Indicates the horizontal, vertical, or grid layout of the component.
+          * Indicates the layout of the component.
          */
         "layout"?: Layout;
         /**
-          * Opens the action menu.
+          * When true, the `calcite-action-menu` is open.
          */
         "menuOpen"?: boolean;
         /**
-          * Specifies the size of the action-menu.
+          * Specifies the size of the `calcite-action-menu`.
          */
         "scale"?: Scale;
     }
     interface CalciteActionMenu {
         /**
-          * Indicates whether widget is expanded.
+          * When true, the component is expanded.
          */
         "expanded"?: boolean;
         /**
@@ -4671,93 +4675,93 @@ declare namespace LocalJSX {
          */
         "flipPlacements"?: ComputedPlacement[];
         /**
-          * Text string for the actions menu.
+          * Specifies the text string for the component.
          */
         "label": string;
         /**
-          * Emitted when the open property has changed.
+          * Emits when the `open` property has changed.
          */
         "onCalciteActionMenuOpenChange"?: (event: CalciteActionMenuCustomEvent<any>) => void;
         /**
-          * Opens the action menu.
+          * When true, the component is open.
          */
         "open"?: boolean;
         /**
-          * Describes the type of positioning to use for the overlaid content. If your element is in a fixed container, use the 'fixed' value.
+          * Determines the type of positioning to use for the overlaid content. If your element is in a fixed container, use the "fixed" value.
          */
         "overlayPositioning"?: OverlayPositioning;
         /**
-          * Determines where the 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;
         /**
-          * Specifies the size of the menu trigger action.
+          * Specifies the size of the component's trigger `calcite-action`.
          */
         "scale"?: Scale;
     }
     interface CalciteActionPad {
         /**
-          * When set to true, the expand-toggling behavior will be disabled.
+          * When true, the expand-toggling behavior is disabled.
          */
         "expandDisabled"?: boolean;
         /**
-          * Indicates whether widget is expanded.
+          * When true, the component is expanded.
          */
         "expanded"?: boolean;
         /**
-          * Updates the label of the collapse icon when the component is expanded.
+          * Specifies the label of the collapse icon when the component is expanded.
          */
         "intlCollapse"?: string;
         /**
-          * Updates the label of the expand icon when the component is not expanded.
+          * Specifies the label of the expand icon when the component is collapsed.
          */
         "intlExpand"?: string;
         /**
-          * Indicates the horizontal or vertical layout of the component.
+          * Indicates the layout of the component.
          */
         "layout"?: Layout;
         /**
-          * Emitted when expanded has been toggled.
+          * Emits when the `expanded` property is toggled.
          */
         "onCalciteActionPadToggle"?: (event: CalciteActionPadCustomEvent<any>) => void;
         /**
-          * Arranges the component depending on the elements 'dir' property.
+          * Arranges the component depending on the element's `dir` property.
          */
         "position"?: Position;
         /**
-          * Specifies the size of the expand action.
+          * Specifies the size of the expand `calcite-action`.
          */
         "scale"?: Scale;
     }
     interface CalciteAlert {
         /**
-          * Is the alert currently active or not
+          * When true, the component is active.
          */
         "active"?: boolean;
         /**
-          * Close the alert automatically (recommended for passive, non-blocking alerts)
+          * When true, the component closes automatically (recommended for passive, non-blocking alerts).
          */
         "autoDismiss"?: boolean;
         /**
-          * Duration of autoDismiss (only used with `autoDismiss`)
+          * Specifies the duration before the component automatically closes (only use with `autoDismiss`).
          */
         "autoDismissDuration"?: AlertDuration;
         /**
-          * Color for the alert (will apply to top border and icon)
+          * Specifies the color for the component (will apply to top border and icon).
          */
         "color"?: StatusColor;
         /**
-          * 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 true, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon.
          */
         "icon"?: string | boolean;
         /**
-          * string to override English close text
+          * Specifies the text label for the close button.
           * @default "Close"
          */
         "intlClose"?: string;
         /**
-          * Accessible name for the component
+          * Specifies an accessible name for the component.
          */
         "label": string;
         "onCalciteAlertBeforeClose"?: (event: CalciteAlertCustomEvent<any>) => void;
@@ -4765,33 +4769,33 @@ declare namespace LocalJSX {
         "onCalciteAlertClose"?: (event: CalciteAlertCustomEvent<any>) => void;
         "onCalciteAlertOpen"?: (event: CalciteAlertCustomEvent<any>) => void;
         /**
-          * specify the placement of the alert
+          * Specifies the placement of the component
          */
         "placement"?: AlertPlacement;
         /**
-          * specify the scale of the alert, defaults to m
+          * Specifies the size of the component.
          */
         "scale"?: Scale;
     }
     interface CalciteAvatar {
         /**
-          * full name of the user
+          * Specifies the full name of the user.
          */
         "fullName"?: string;
         /**
-          * specify the scale of the avatar, defaults to m
+          * Specifies the size of the component.
          */
         "scale"?: Scale;
         /**
-          * src to an image (remember to add a token if the user is private)
+          * Specifies the `src` to an image (remember to add a token if the user is private).
          */
         "thumbnail"?: string;
         /**
-          * unique id for user
+          * Specifies the unique id of the user.
          */
         "userId"?: string;
         /**
-          * user name
+          * Specifies the username of the user.
          */
         "username"?: string;
     }
@@ -4844,6 +4848,10 @@ declare namespace LocalJSX {
           * When true, content is waiting to be loaded. This state shows a busy indicator.
          */
         "loading"?: boolean;
+        /**
+          * When true, removes padding for the slotted content
+         */
+        "noPadding"?: boolean;
         /**
           * Emitted when the header has been clicked.
          */