@esri/calcite-components 1.0.0-next.554 → 1.0.0-next.557

package/dist/types/components.d.ts

@@ -240,7 +240,7 @@ export namespace Components {
          */
         "open": boolean;
         /**
-          * Determines 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.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning": OverlayPositioning;
         /**
@@ -907,7 +907,7 @@ export namespace Components {
          */
         "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.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning": OverlayPositioning;
         /**
@@ -1251,7 +1251,7 @@ export namespace Components {
          */
         "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.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning": OverlayPositioning;
         /**
@@ -1762,7 +1762,7 @@ export namespace Components {
          */
         "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.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning": OverlayPositioning;
         /**
@@ -2783,7 +2783,7 @@ export namespace Components {
          */
         "open": boolean;
         /**
-          * Describes the positioning type to use for the overlaid content. If the element is in a fixed container, use the "fixed" value.
+          * Determines the type of positioning to use for the overlaid content.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning": OverlayPositioning;
         /**
@@ -2849,44 +2849,44 @@ export namespace Components {
     }
     interface CalciteRadioButton {
         /**
-          * The checked state of the radio button.
+          * When true, the component is checked.
          */
         "checked": boolean;
         /**
-          * The disabled state of the radio button.
+          * When true, interaction is prevented and the component is displayed with lower opacity.
          */
         "disabled": boolean;
         "emitCheckedChange": () => Promise<void>;
         /**
-          * The focused state of the radio button.
+          * The focused state of the component.
          */
         "focused": boolean;
         /**
-          * The id attribute of the radio button.  When omitted, a globally unique identifier is used.
+          * The id attribute of the component. When omitted, a globally unique identifier is used.
          */
         "guid": string;
         /**
-          * The radio button's hidden status.  When a radio button is hidden it 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 radio button.
+          * The hovered state of the component.
          */
         "hovered": boolean;
         /**
-          * The label of the radio input
+          * Accessible name for the component.
          */
         "label"?: string;
         /**
-          * The name of the radio button. `name` is passed as a property automatically from `calcite-radio-button-group`.
+          * Specifies the name of the component, passed from the `calcite-radio-button-group` on form submission.
          */
         "name": string;
         /**
-          * Requires that a value is selected for the radio button group before the parent form will submit.
+          * When true, the component must have a value selected from the `calcite-radio-button-group` on form submission.
          */
         "required": boolean;
         /**
-          * The scale (size) of the radio button. `scale` is passed as a property automatically from `calcite-radio-button-group`.
+          * Specifies the size of the component inherited from the `calcite-radio-button-group`.
          */
         "scale": Scale;
         /**
@@ -2894,63 +2894,63 @@ export namespace Components {
          */
         "setFocus": () => Promise<void>;
         /**
-          * The value of the radio button.
+          * The component's value.
          */
         "value": any;
     }
     interface CalciteRadioButtonGroup {
         /**
-          * The disabled state of the radio button group.
+          * When true, interaction is prevented and the component is displayed with lower opacity.
          */
         "disabled": boolean;
         /**
-          * The radio button group's hidden status.  When a radio button group is hidden none of its options are focusable or checkable.
+          * When true, the component is not displayed and its `calcite-radio-button`s are not focusable or checkable.
          */
         "hidden": boolean;
         /**
-          * The layout direction of the radio buttons in a group.
+          * Defines the layout of the component.
          */
         "layout": Layout;
         /**
-          * The name of the radio button group. `name` must be unique to other radio button group instances.
+          * Specifies the name of the component on form submission. Must be unique to other component instances.
          */
         "name": string;
         /**
-          * Requires that a value is selected for the radio button group before the parent form will submit.
+          * When true, the component must have a value on form submission.
          */
         "required": boolean;
         /**
-          * The scale (size) of the radio button group.
+          * Specifies the size of the component.
          */
         "scale": Scale;
     }
     interface CalciteRadioGroup {
         /**
-          * specify the appearance style of the radio group, defaults to solid.
+          * Specifies the appearance style of the component.
          */
         "appearance": RadioAppearance;
         /**
-          * is the radio group disabled
+          * When true, interaction is prevented and the component is displayed with lower opacity.
          */
         "disabled": boolean;
         /**
-          * specify the layout of the radio group, defaults to horizontal
+          * Defines the layout of the component.
          */
         "layout": Layout;
         /**
-          * The group's name. Gets submitted with the form.
+          * Specifies the name of the component on form submission.
          */
         "name": string;
         /**
-          * When true, makes the component required for form-submission.
+          * When true, the component must have a value on form submission.
          */
         "required": boolean;
         /**
-          * The scale of the radio group
+          * Specifies the size of the component.
          */
         "scale": Scale;
         /**
-          * The group's selected item.
+          * The component's selected item `HTMLElement`.
           * @readonly
          */
         "selectedItem": HTMLCalciteRadioGroupItemElement;
@@ -2959,73 +2959,73 @@ export namespace Components {
          */
         "setFocus": () => Promise<void>;
         /**
-          * The value of the selectedItem
+          * The component's "selectedItem" value.
          */
         "value": string;
         /**
-          * specify the width of the group, defaults to auto
+          * Specifies the width of the component.
          */
         "width": Extract<"auto" | "full", Width>;
     }
     interface CalciteRadioGroupItem {
         /**
-          * Indicates whether the control is checked.
+          * When true, the component is checked.
          */
         "checked": boolean;
         /**
-          * optionally pass an icon to display - accepts Calcite UI icon names
+          * Specifies an icon to display - accepts Calcite UI icon names.
          */
         "icon"?: string;
         /**
-          * flip the icon in rtl
+          * When true, the icon will be flipped when the element direction is right-to-left ("rtl").
          */
         "iconFlipRtl": boolean;
         /**
-          * optionally used with icon, select where to position the icon
+          * When used with "icon", specifies its position.
          */
         "iconPosition"?: Position;
         /**
-          * The control's value.
+          * The component's value.
          */
         "value": any | null;
     }
     interface CalciteRating {
         /**
-          * optionally pass a cumulative average rating to display
+          * Specifies a cumulative average from previous ratings to display.
          */
         "average"?: number;
         /**
-          * optionally pass a number of previous ratings to display
+          * Specifies the number of previous ratings to display.
          */
         "count"?: number;
         /**
-          * is the rating component in a selectable mode
+          * When true, interaction is prevented and the component is displayed with lower opacity.
          */
         "disabled": boolean;
         /**
-          * Localized string for "Rating" (used for aria label)
+          * Accessible name for the component.
           * @default "Rating"
          */
         "intlRating"?: string;
         /**
-          * Localized string for labelling each star, `${num}` in the string will be replaced by the number
+          * Accessible name for each star. The `${num}` in the string will be replaced by the number.
           * @default "Stars: ${num}"
          */
         "intlStars"?: string;
         /**
-          * The name of the rating
+          * Specifies the name of the component on form submission.
          */
         "name": string;
         /**
-          * is the rating component in a selectable mode
+          * When true, the component's value can be read, but cannot be modified.
          */
         "readOnly": boolean;
         /**
-          * When true, makes the component required for form-submission.
+          * When true, the component must have a value on form submission.
          */
         "required": boolean;
         /**
-          * specify the scale of the component, defaults to m
+          * Specifies the size of the component.
          */
         "scale": Scale;
         /**
@@ -3033,11 +3033,11 @@ export namespace Components {
          */
         "setFocus": () => Promise<void>;
         /**
-          * Show average and count data summary chip (if available)
+          * When true, and if available, displays the "average" and/or "count" data summary in a `calcite-chip`.
          */
         "showChip": boolean;
         /**
-          * the value of the rating component
+          * The component's value.
          */
         "value": number;
     }
@@ -3293,7 +3293,7 @@ export namespace Components {
          */
         "loading": boolean;
         /**
-          * Describes the type of positioning to use for the dropdown. If your element is in a fixed container, use the 'fixed' value.
+          * Determines the type of positioning to use for the overlaid content.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning": OverlayPositioning;
         /**
@@ -3443,6 +3443,7 @@ export namespace Components {
     interface CalciteTab {
         /**
           * Show this tab
+          * @deprecated Use selected instead.
          */
         "active": boolean;
         /**
@@ -3450,6 +3451,10 @@ export namespace Components {
          */
         "getTabIndex": () => Promise<number>;
         "scale": Scale;
+        /**
+          * When true, display this tab.
+         */
+        "selected": boolean;
         /**
           * Optionally include a unique name for this tab, be sure to also set this name on the associated title.
          */
@@ -3479,6 +3484,7 @@ export namespace Components {
     interface CalciteTabTitle {
         /**
           * Show this tab title as selected
+          * @deprecated Use selected instead.
          */
         "active": boolean;
         "bordered": boolean;
@@ -3506,6 +3512,10 @@ export namespace Components {
         "layout": TabLayout;
         "position": TabPosition;
         "scale": Scale;
+        /**
+          * When true, display this tab title as selected.
+         */
+        "selected": boolean;
         /**
           * Optionally include a unique name for the tab title, be sure to also set this name on the associated tab.
          */
@@ -3812,7 +3822,7 @@ export namespace Components {
          */
         "open": boolean;
         /**
-          * Describes the positioning type to use for the overlaid content. If the `referenceElement` is in a fixed container, use the "fixed" value.
+          * Determines the type of positioning to use for the overlaid content.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning": OverlayPositioning;
         /**
@@ -5103,7 +5113,7 @@ declare namespace LocalJSX {
          */
         "open"?: boolean;
         /**
-          * Determines 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.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning"?: OverlayPositioning;
         /**
@@ -5811,7 +5821,7 @@ declare namespace LocalJSX {
          */
         "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.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning"?: OverlayPositioning;
         /**
@@ -6183,7 +6193,7 @@ declare namespace LocalJSX {
          */
         "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.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning"?: OverlayPositioning;
         /**
@@ -6710,7 +6720,7 @@ declare namespace LocalJSX {
          */
         "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.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning"?: OverlayPositioning;
         /**
@@ -7719,7 +7729,7 @@ declare namespace LocalJSX {
          */
         "open"?: boolean;
         /**
-          * Describes the positioning type to use for the overlaid content. If the element is in a fixed container, use the "fixed" value.
+          * Determines the type of positioning to use for the overlaid content.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning"?: OverlayPositioning;
         /**
@@ -7771,23 +7781,23 @@ declare namespace LocalJSX {
     }
     interface CalciteRadioButton {
         /**
-          * The checked state of the radio button.
+          * When true, the component is checked.
          */
         "checked"?: boolean;
         /**
-          * The disabled state of the radio button.
+          * When true, interaction is prevented and the component is displayed with lower opacity.
          */
         "disabled"?: boolean;
         /**
-          * The id attribute of the radio button.  When omitted, a globally unique identifier is used.
+          * The id attribute of the component. When omitted, a globally unique identifier is used.
          */
         "guid"?: string;
         /**
-          * The radio button's hidden status.  When a radio button is hidden it is not focusable or checkable.
+          * When true, the component is not displayed and is not focusable or checkable.
          */
         "hidden"?: boolean;
         /**
-          * The name of the radio button. `name` is passed as a property automatically from `calcite-radio-button-group`.
+          * Specifies the name of the component, passed from the `calcite-radio-button-group` on form submission.
          */
         "name"?: string;
         /**
@@ -7795,154 +7805,154 @@ declare namespace LocalJSX {
          */
         "onCalciteRadioButtonChange"?: (event: CalciteRadioButtonCustomEvent<void>) => void;
         /**
-          * Requires that a value is selected for the radio button group before the parent form will submit.
+          * When true, the component must have a value selected from the `calcite-radio-button-group` on form submission.
          */
         "required"?: boolean;
         /**
-          * The scale (size) of the radio button. `scale` is passed as a property automatically from `calcite-radio-button-group`.
+          * Specifies the size of the component inherited from the `calcite-radio-button-group`.
          */
         "scale"?: Scale;
         /**
-          * The value of the radio button.
+          * The component's value.
          */
         "value": any;
     }
     interface CalciteRadioButtonGroup {
         /**
-          * The disabled state of the radio button group.
+          * When true, interaction is prevented and the component is displayed with lower opacity.
          */
         "disabled"?: boolean;
         /**
-          * The radio button group's hidden status.  When a radio button group is hidden none of its options are focusable or checkable.
+          * When true, the component is not displayed and its `calcite-radio-button`s are not focusable or checkable.
          */
         "hidden"?: boolean;
         /**
-          * The layout direction of the radio buttons in a group.
+          * Defines the layout of the component.
          */
         "layout"?: Layout;
         /**
-          * The name of the radio button group. `name` must be unique to other radio button group instances.
+          * Specifies the name of the component on form submission. Must be unique to other component instances.
          */
         "name": string;
         /**
-          * Emitted when the radio button group has changed.
+          * Fires when the component has changed.
          */
         "onCalciteRadioButtonGroupChange"?: (event: CalciteRadioButtonGroupCustomEvent<void>) => void;
         /**
-          * Requires that a value is selected for the radio button group before the parent form will submit.
+          * When true, the component must have a value on form submission.
          */
         "required"?: boolean;
         /**
-          * The scale (size) of the radio button group.
+          * Specifies the size of the component.
          */
         "scale"?: Scale;
     }
     interface CalciteRadioGroup {
         /**
-          * specify the appearance style of the radio group, defaults to solid.
+          * Specifies the appearance style of the component.
          */
         "appearance"?: RadioAppearance;
         /**
-          * is the radio group disabled
+          * When true, interaction is prevented and the component is displayed with lower opacity.
          */
         "disabled"?: boolean;
         /**
-          * specify the layout of the radio group, defaults to horizontal
+          * Defines the layout of the component.
          */
         "layout"?: Layout;
         /**
-          * The group's name. Gets submitted with the form.
+          * Specifies the name of the component on form submission.
          */
         "name"?: string;
         /**
-          * Fired when the selected option changes, event detail is the new value
+          * Fires when the selected option changes, where the event detail is the new value.
          */
         "onCalciteRadioGroupChange"?: (event: CalciteRadioGroupCustomEvent<string>) => void;
         /**
-          * The scale of the radio group
+          * Specifies the size of the component.
          */
         "scale"?: Scale;
         /**
-          * The group's selected item.
+          * The component's selected item `HTMLElement`.
           * @readonly
          */
         "selectedItem"?: HTMLCalciteRadioGroupItemElement;
         /**
-          * The value of the selectedItem
+          * The component's "selectedItem" value.
          */
         "value"?: string;
         /**
-          * specify the width of the group, defaults to auto
+          * Specifies the width of the component.
          */
         "width"?: Extract<"auto" | "full", Width>;
     }
     interface CalciteRadioGroupItem {
         /**
-          * Indicates whether the control is checked.
+          * When true, the component is checked.
          */
         "checked"?: boolean;
         /**
-          * optionally pass an icon to display - accepts Calcite UI icon names
+          * Specifies an icon to display - accepts Calcite UI icon names.
          */
         "icon"?: string;
         /**
-          * flip the icon in rtl
+          * When true, the icon will be flipped when the element direction is right-to-left ("rtl").
          */
         "iconFlipRtl"?: boolean;
         /**
-          * optionally used with icon, select where to position the icon
+          * When used with "icon", specifies its position.
          */
         "iconPosition"?: Position;
         /**
-          * The control's value.
+          * The component's value.
          */
         "value"?: any | null;
     }
     interface CalciteRating {
         /**
-          * optionally pass a cumulative average rating to display
+          * Specifies a cumulative average from previous ratings to display.
          */
         "average"?: number;
         /**
-          * optionally pass a number of previous ratings to display
+          * Specifies the number of previous ratings to display.
          */
         "count"?: number;
         /**
-          * is the rating component in a selectable mode
+          * When true, interaction is prevented and the component is displayed with lower opacity.
          */
         "disabled"?: boolean;
         /**
-          * Localized string for "Rating" (used for aria label)
+          * Accessible name for the component.
           * @default "Rating"
          */
         "intlRating"?: string;
         /**
-          * Localized string for labelling each star, `${num}` in the string will be replaced by the number
+          * Accessible name for each star. The `${num}` in the string will be replaced by the number.
           * @default "Stars: ${num}"
          */
         "intlStars"?: string;
         /**
-          * The name of the rating
+          * Specifies the name of the component on form submission.
          */
         "name"?: string;
         /**
-          * Fires when the rating value has changed.
+          * Fires when the component's value changes.
          */
         "onCalciteRatingChange"?: (event: CalciteRatingCustomEvent<{ value: number }>) => void;
         /**
-          * is the rating component in a selectable mode
+          * When true, the component's value can be read, but cannot be modified.
          */
         "readOnly"?: boolean;
         /**
-          * specify the scale of the component, defaults to m
+          * Specifies the size of the component.
          */
         "scale"?: Scale;
         /**
-          * Show average and count data summary chip (if available)
+          * When true, and if available, displays the "average" and/or "count" data summary in a `calcite-chip`.
          */
         "showChip"?: boolean;
         /**
-          * the value of the rating component
+          * The component's value.
          */
         "value"?: number;
     }
@@ -8216,7 +8226,7 @@ declare namespace LocalJSX {
          */
         "onCalciteSplitButtonSecondaryClick"?: (event: CalciteSplitButtonCustomEvent<DeprecatedEventPayload>) => void;
         /**
-          * Describes the type of positioning to use for the dropdown. If your element is in a fixed container, use the 'fixed' value.
+          * Determines the type of positioning to use for the overlaid content.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning"?: OverlayPositioning;
         /**
@@ -8344,8 +8354,13 @@ declare namespace LocalJSX {
     interface CalciteTab {
         /**
           * Show this tab
+          * @deprecated Use selected instead.
          */
         "active"?: boolean;
+        /**
+          * When true, display this tab.
+         */
+        "selected"?: boolean;
         /**
           * Optionally include a unique name for this tab, be sure to also set this name on the associated title.
          */
@@ -8369,6 +8384,7 @@ declare namespace LocalJSX {
     interface CalciteTabTitle {
         /**
           * Show this tab title as selected
+          * @deprecated Use selected instead.
          */
         "active"?: boolean;
         /**
@@ -8392,6 +8408,10 @@ declare namespace LocalJSX {
           * @see [TabChangeEventDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tab/interfaces.ts#L1)
          */
         "onCalciteTabsActivate"?: (event: CalciteTabTitleCustomEvent<TabChangeEventDetail>) => void;
+        /**
+          * When true, display this tab title as selected.
+         */
+        "selected"?: boolean;
         /**
           * Optionally include a unique name for the tab title, be sure to also set this name on the associated tab.
          */
@@ -8685,7 +8705,7 @@ declare namespace LocalJSX {
          */
         "open"?: boolean;
         /**
-          * Describes the positioning type to use for the overlaid content. If the `referenceElement` is in a fixed container, use the "fixed" value.
+          * Determines the type of positioning to use for the overlaid content.  Using the "absolute" value will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The "fixed" value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is "fixed".
          */
         "overlayPositioning"?: OverlayPositioning;
         /**