@esri/calcite-components 1.0.0-beta.77 → 1.0.0-beta.80

package/dist/types/components.d.ts

@@ -7,8 +7,7 @@
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
 import { AccordionAppearance } from "./components/accordion/interfaces";
 import { Alignment, Appearance, Columns, FlipContext, Layout, Position, Scale, Status, Width } from "./components/interfaces";
-import { Placement } from "@popperjs/core";
-import { OverlayPositioning, PopperPlacement } from "./utils/popper";
+import { ComputedPlacement, MenuPlacement, OverlayPositioning, PopperPlacement } from "./utils/popper";
 import { AlertDuration, AlertPlacement, StatusColor } from "./components/alert/interfaces";
 import { HeadingLevel } from "./components/functional/Heading";
 import { BlockSectionToggleDisplay } from "./components/block-section/interfaces";
@@ -20,8 +19,8 @@ import { ComboboxChildElement, ComboboxSelectionMode } from "./components/combob
 import { DateRangeChange } from "./components/date-picker/interfaces";
 import { DateLocaleData } from "./components/date-picker/utils";
 import { HoverRange } from "./utils/date";
-import { DropdownPlacement, ItemKeyboardEvent } from "./components/dropdown/interfaces";
 import { SelectionMode } from "./components/dropdown-group/interfaces";
+import { ItemKeyboardEvent } from "./components/dropdown/interfaces";
 import { ColorStop, DataSeries } from "./components/graph/interfaces";
 import { InputPlacement } from "./components/input/interfaces";
 import { ModalBackgroundColor } from "./components/modal/interfaces";
@@ -208,7 +207,7 @@ export namespace Components {
         /**
           * Defines the available placements that can be used when a flip occurs.
          */
-        "flipPlacements"?: Placement[];
+        "flipPlacements"?: ComputedPlacement[];
         /**
           * Text string for the actions menu.
          */
@@ -223,7 +222,7 @@ export namespace Components {
         "overlayPositioning": OverlayPositioning;
         /**
           * 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)
+          * @see [PopperPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/popper.ts#L25)
          */
         "placement": PopperPlacement;
         /**
@@ -631,6 +630,10 @@ export namespace Components {
           * Internal prop for advanced use-cases.
          */
         "color": InternalColor | null;
+        /**
+          * When true, disabled prevents user interaction.
+         */
+        "disabled": boolean;
         /**
           * The format of the value property.  When "auto", the format will be inferred from `value` when set.
           * @default "auto"
@@ -756,9 +759,9 @@ export namespace Components {
          */
         "storageId": string;
         /**
-          * The color value.  This value can be either a {@link https://developer.mozilla.org/en-US/docs/Web/CSS/color|CSS string} a RGB, HSL or HSV object.  The type will be preserved as the color is updated.
+          * The color value.  This value can be either a {@link https ://developer.mozilla.org/en-US/docs/Web/CSS/color|CSS string} a RGB, HSL or HSV object.  The type will be preserved as the color is updated.
           * @default "#007ac2"
-          * @see  [ColorValue](https://github.com/Esri/calcite-components/blob/master/src/components/color-picker/interfaces.ts#L10)
+          * @see [ColorValue](https://github.com/Esri/calcite-components/blob/master/src/components/color-picker/interfaces.ts#L10)
          */
         "value": ColorValue | null;
     }
@@ -818,6 +821,10 @@ export namespace Components {
           * Disable combobox input
          */
         "disabled": boolean;
+        /**
+          * Defines the available placements that can be used when a flip occurs.
+         */
+        "flipPlacements"?: ComputedPlacement[];
         /**
           * string to override the English "Remove tag" text for when an item is selected.
           * @default "Remove tag"
@@ -1156,6 +1163,10 @@ export namespace Components {
           * is the dropdown disabled
          */
         "disabled": boolean;
+        /**
+          * Defines the available placements that can be used when a flip occurs.
+         */
+        "flipPlacements"?: ComputedPlacement[];
         /**
           * specify the maximum number of calcite-dropdown-items to display before showing the scroller, must be greater than 0 - this value does not include groupTitles passed to calcite-dropdown-group
          */
@@ -1168,7 +1179,7 @@ export namespace Components {
           * Determines where the dropdown will be positioned relative to the button.
           * @default "bottom-leading"
          */
-        "placement": DropdownPlacement;
+        "placement": MenuPlacement;
         /**
           * Updates the position of the component.
          */
@@ -1323,7 +1334,7 @@ export namespace Components {
         /**
           * Filter value.
          */
-        "value"?: string;
+        "value": string;
     }
     interface CalciteFlow {
         /**
@@ -1591,6 +1602,10 @@ export namespace Components {
           * @deprecated use valueAsDate instead
          */
         "endAsDate"?: Date;
+        /**
+          * Defines the available placements that can be used when a flip occurs.
+         */
+        "flipPlacements"?: ComputedPlacement[];
         /**
           * Number at which section headings should start for this component.
          */
@@ -1805,6 +1820,7 @@ export namespace Components {
         "disableSpacing": boolean;
         /**
           * is the label disabled
+          * @deprecated use the `disabled` property on the interactive components instead
          */
         "disabled": boolean;
         /**
@@ -1864,6 +1880,10 @@ export namespace Components {
         "target"?: string;
     }
     interface CalciteList {
+        /**
+          * When true, disabled prevents user interaction.
+         */
+        "disabled": boolean;
         /**
           * Number at which section headings should start for this component.
          */
@@ -2239,10 +2259,10 @@ export namespace Components {
         /**
           * When true, the item cannot be clicked and is visually muted.
          */
-        "disabled"?: boolean;
+        "disabled": boolean;
         /**
           * 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)
+          * @see [ICON_TYPES](https://github.com/Esri/calcite-components/blob/master/src/components/pick-list/resources.ts#L5)
          */
         "icon"?: ICON_TYPES | null;
         /**
@@ -2301,7 +2321,7 @@ export namespace Components {
         /**
           * Defines the available placements that can be used when a flip occurs.
          */
-        "flipPlacements"?: Placement[];
+        "flipPlacements"?: ComputedPlacement[];
         /**
           * Heading text.
          */
@@ -2338,7 +2358,7 @@ export namespace Components {
         "overlayPositioning": OverlayPositioning;
         /**
           * 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)
+          * @see [PopperPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/popper.ts#L25)
          */
         "placement": PopperPlacement;
         /**
@@ -2696,7 +2716,7 @@ export namespace Components {
         "hasHistogram": boolean;
         /**
           * List of x,y coordinates within the slider's min and max, displays above the slider track.
-          * @see  [DataSeries](https://github.com/Esri/calcite-components/blob/master/src/components/graph/interfaces.ts#L5)
+          * @see [DataSeries](https://github.com/Esri/calcite-components/blob/master/src/components/graph/interfaces.ts#L5)
          */
         "histogram"?: DataSeries;
         /**
@@ -3151,6 +3171,10 @@ export namespace Components {
         "width": Extract<"auto" | "full", Width>;
     }
     interface CalciteTileSelectGroup {
+        /**
+          * The disabled state of the tile select.
+         */
+        "disabled": boolean;
         /**
           * Tiles by default move horizontally, stacking with each row, vertical allows single-column layouts
          */
@@ -3332,7 +3356,7 @@ export namespace Components {
         "overlayPositioning": OverlayPositioning;
         /**
           * 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)
+          * @see [PopperPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/popper.ts#L25)
          */
         "placement": PopperPlacement;
         /**
@@ -3369,7 +3393,7 @@ export namespace Components {
         /**
           * Customize how tree selection works (single, multi, children, multi-children, ancestors)
           * @default "single"
-          * @see  [TreeSelectionMode](https://github.com/Esri/calcite-components/blob/master/src/components/tree/interfaces.ts#L5)
+          * @see [TreeSelectionMode](https://github.com/Esri/calcite-components/blob/master/src/components/tree/interfaces.ts#L5)
          */
         "selectionMode": TreeSelectionMode;
     }
@@ -3446,11 +3470,11 @@ export namespace Components {
         /**
           * When true, the item cannot be clicked and is visually muted
          */
-        "disabled"?: boolean;
+        "disabled": boolean;
         "handleActivated"?: boolean;
         /**
           * 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)
+          * @see [ICON_TYPES](https://github.com/Esri/calcite-components/blob/master/src/components/pick-list/resources.ts#L5)
          */
         "icon"?: ICON_TYPES | null;
         /**
@@ -4290,7 +4314,7 @@ declare namespace LocalJSX {
         /**
           * Defines the available placements that can be used when a flip occurs.
          */
-        "flipPlacements"?: Placement[];
+        "flipPlacements"?: ComputedPlacement[];
         /**
           * Text string for the actions menu.
          */
@@ -4309,7 +4333,7 @@ declare namespace LocalJSX {
         "overlayPositioning"?: OverlayPositioning;
         /**
           * 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)
+          * @see [PopperPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/popper.ts#L25)
          */
         "placement"?: PopperPlacement;
         /**
@@ -4709,6 +4733,10 @@ declare namespace LocalJSX {
           * specify the appearance - default (containing border), or minimal (no containing border)
          */
         "appearance"?: ColorAppearance;
+        /**
+          * When true, disabled prevents user interaction.
+         */
+        "disabled"?: boolean;
         /**
           * The format of the value property.  When "auto", the format will be inferred from `value` when set.
           * @default "auto"
@@ -4838,9 +4866,9 @@ declare namespace LocalJSX {
          */
         "storageId"?: string;
         /**
-          * The color value.  This value can be either a {@link https://developer.mozilla.org/en-US/docs/Web/CSS/color|CSS string} a RGB, HSL or HSV object.  The type will be preserved as the color is updated.
+          * The color value.  This value can be either a {@link https ://developer.mozilla.org/en-US/docs/Web/CSS/color|CSS string} a RGB, HSL or HSV object.  The type will be preserved as the color is updated.
           * @default "#007ac2"
-          * @see  [ColorValue](https://github.com/Esri/calcite-components/blob/master/src/components/color-picker/interfaces.ts#L10)
+          * @see [ColorValue](https://github.com/Esri/calcite-components/blob/master/src/components/color-picker/interfaces.ts#L10)
          */
         "value"?: ColorValue | null;
     }
@@ -4900,6 +4928,10 @@ declare namespace LocalJSX {
           * Disable combobox input
          */
         "disabled"?: boolean;
+        /**
+          * Defines the available placements that can be used when a flip occurs.
+         */
+        "flipPlacements"?: ComputedPlacement[];
         /**
           * string to override the English "Remove tag" text for when an item is selected.
           * @default "Remove tag"
@@ -5070,7 +5102,7 @@ declare namespace LocalJSX {
         "onCalciteDatePickerChange"?: (event: CustomEvent<Date>) => void;
         /**
           * Trigger calcite date change when a user changes the date range.
-          * @see  [DateRangeChange](https://github.com/Esri/calcite-components/blob/master/src/components/date-picker/interfaces.ts#L1)
+          * @see [DateRangeChange](https://github.com/Esri/calcite-components/blob/master/src/components/date-picker/interfaces.ts#L1)
          */
         "onCalciteDatePickerRangeChange"?: (event: CustomEvent<DateRangeChange>) => void;
         /**
@@ -5267,6 +5299,10 @@ declare namespace LocalJSX {
           * is the dropdown disabled
          */
         "disabled"?: boolean;
+        /**
+          * Defines the available placements that can be used when a flip occurs.
+         */
+        "flipPlacements"?: ComputedPlacement[];
         /**
           * specify the maximum number of calcite-dropdown-items to display before showing the scroller, must be greater than 0 - this value does not include groupTitles passed to calcite-dropdown-group
          */
@@ -5291,7 +5327,7 @@ declare namespace LocalJSX {
           * Determines where the dropdown will be positioned relative to the button.
           * @default "bottom-leading"
          */
-        "placement"?: DropdownPlacement;
+        "placement"?: MenuPlacement;
         /**
           * specify the scale of dropdown, defaults to m
          */
@@ -5418,7 +5454,7 @@ declare namespace LocalJSX {
         /**
           * The items to filter through. The filter uses this as the starting point, and returns items that contain the string entered in the input, using a partial match and recursive search.  This property is required.
          */
-        "items": object[];
+        "items"?: object[];
         /**
           * This event fires when the filter text changes.
          */
@@ -5703,6 +5739,10 @@ declare namespace LocalJSX {
           * @deprecated use valueAsDate instead
          */
         "endAsDate"?: Date;
+        /**
+          * Defines the available placements that can be used when a flip occurs.
+         */
+        "flipPlacements"?: ComputedPlacement[];
         /**
           * Number at which section headings should start for this component.
          */
@@ -5757,7 +5797,7 @@ declare namespace LocalJSX {
         "onCalciteDatePickerChange"?: (event: CustomEvent<Date>) => void;
         /**
           * Trigger calcite date change when a user changes the date range.
-          * @see  [DateRangeChange](https://github.com/Esri/calcite-components/blob/master/src/components/calcite-date-picker/interfaces.ts#L1)
+          * @see [DateRangeChange](https://github.com/Esri/calcite-components/blob/master/src/components/calcite-date-picker/interfaces.ts#L1)
           * @deprecated use `calciteInputDatePickerChange` instead.
          */
         "onCalciteDatePickerRangeChange"?: (event: CustomEvent<DateRangeChange>) => void;
@@ -5912,6 +5952,7 @@ declare namespace LocalJSX {
         "disableSpacing"?: boolean;
         /**
           * is the label disabled
+          * @deprecated use the `disabled` property on the interactive components instead
          */
         "disabled"?: boolean;
         /**
@@ -5967,6 +6008,10 @@ declare namespace LocalJSX {
         "target"?: string;
     }
     interface CalciteList {
+        /**
+          * When true, disabled prevents user interaction.
+         */
+        "disabled"?: boolean;
         /**
           * Number at which section headings should start for this component.
          */
@@ -6174,7 +6219,7 @@ declare namespace LocalJSX {
         "num"?: number;
         /**
           * Emitted whenever the selected page changes.
-          * @see  [PaginationDetail](https://github.com/Esri/calcite-components/blob/master/src/components/pagination/calcite-pagination.tsx#L18)
+          * @see [PaginationDetail](https://github.com/Esri/calcite-components/blob/master/src/components/pagination/calcite-pagination.tsx#L18)
          */
         "onCalcitePaginationChange"?: (event: CustomEvent<PaginationDetail>) => void;
         /**
@@ -6338,7 +6383,7 @@ declare namespace LocalJSX {
         "disabled"?: boolean;
         /**
           * 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)
+          * @see [ICON_TYPES](https://github.com/Esri/calcite-components/blob/master/src/components/pick-list/resources.ts#L5)
          */
         "icon"?: ICON_TYPES | null;
         /**
@@ -6401,7 +6446,7 @@ declare namespace LocalJSX {
         /**
           * Defines the available placements that can be used when a flip occurs.
          */
-        "flipPlacements"?: Placement[];
+        "flipPlacements"?: ComputedPlacement[];
         /**
           * Heading text.
          */
@@ -6446,7 +6491,7 @@ declare namespace LocalJSX {
         "overlayPositioning"?: OverlayPositioning;
         /**
           * 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)
+          * @see [PopperPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/popper.ts#L25)
          */
         "placement"?: PopperPlacement;
         /**
@@ -6775,7 +6820,7 @@ declare namespace LocalJSX {
         "hasHistogram"?: boolean;
         /**
           * List of x,y coordinates within the slider's min and max, displays above the slider track.
-          * @see  [DataSeries](https://github.com/Esri/calcite-components/blob/master/src/components/graph/interfaces.ts#L5)
+          * @see [DataSeries](https://github.com/Esri/calcite-components/blob/master/src/components/graph/interfaces.ts#L5)
          */
         "histogram"?: DataSeries;
         /**
@@ -7056,7 +7101,7 @@ declare namespace LocalJSX {
     interface CalciteTabNav {
         /**
           * Emitted when the active tab changes
-          * @see  [TabChangeEventDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tab/interfaces.ts#L1)
+          * @see [TabChangeEventDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tab/interfaces.ts#L1)
          */
         "onCalciteTabChange"?: (event: CustomEvent<TabChangeEventDetail>) => void;
         /**
@@ -7091,7 +7136,7 @@ declare namespace LocalJSX {
         "iconStart"?: string;
         /**
           * Fires when a specific tab is activated (`event.details`)
-          * @see  [TabChangeEventDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tab/interfaces.ts#L1)
+          * @see [TabChangeEventDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tab/interfaces.ts#L1)
          */
         "onCalciteTabsActivate"?: (event: CustomEvent<TabChangeEventDetail>) => void;
         /**
@@ -7206,6 +7251,10 @@ declare namespace LocalJSX {
         "width"?: Extract<"auto" | "full", Width>;
     }
     interface CalciteTileSelectGroup {
+        /**
+          * The disabled state of the tile select.
+         */
+        "disabled"?: boolean;
         /**
           * Tiles by default move horizontally, stacking with each row, vertical allows single-column layouts
          */
@@ -7379,7 +7428,7 @@ declare namespace LocalJSX {
         "overlayPositioning"?: OverlayPositioning;
         /**
           * 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)
+          * @see [PopperPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/popper.ts#L25)
          */
         "placement"?: PopperPlacement;
         /**
@@ -7406,7 +7455,7 @@ declare namespace LocalJSX {
         "lines"?: boolean;
         /**
           * Emitted when user selects/deselects tree items. An object including an array of selected items will be passed in the event's `detail` property.
-          * @see  [TreeSelectDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tree/interfaces.ts#L1)
+          * @see [TreeSelectDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tree/interfaces.ts#L1)
          */
         "onCalciteTreeSelect"?: (event: CustomEvent<TreeSelectDetail>) => void;
         /**
@@ -7416,7 +7465,7 @@ declare namespace LocalJSX {
         /**
           * Customize how tree selection works (single, multi, children, multi-children, ancestors)
           * @default "single"
-          * @see  [TreeSelectionMode](https://github.com/Esri/calcite-components/blob/master/src/components/tree/interfaces.ts#L5)
+          * @see [TreeSelectionMode](https://github.com/Esri/calcite-components/blob/master/src/components/tree/interfaces.ts#L5)
          */
         "selectionMode"?: TreeSelectionMode;
     }
@@ -7483,7 +7532,7 @@ declare namespace LocalJSX {
         "disabled"?: boolean;
         /**
           * 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)
+          * @see [ICON_TYPES](https://github.com/Esri/calcite-components/blob/master/src/components/pick-list/resources.ts#L5)
          */
         "icon"?: ICON_TYPES | null;
         /**