@esri/calcite-components 1.0.0-next.605 → 1.0.0-next.607

package/dist/types/components/color-picker/color-picker.d.ts

@@ -8,12 +8,16 @@ import { NumberingSystem } from "../../utils/locale";
 export declare class ColorPicker implements InteractiveComponent {
   el: HTMLCalciteColorPickerElement;
   /**
-   * When false, empty color (null) will be allowed as a value. Otherwise, a color value is always enforced by the component.
+   * When `false`, an empty color (`null`) will be allowed as a `value`. Otherwise, a color value is enforced on the component.
    *
-   * When true, clearing the input and blurring will restore the last valid color set. When false, it will set it to empty.
+   * When `true`, a color value is enforced, and clearing the input or blurring will restore the last valid `value`. When `false`, an empty color (`null`) will be allowed as a `value`.
    */
   allowEmpty: boolean;
-  /** specify the appearance - solid (containing border), or minimal (no containing border) */
+  /**
+   * Specifies the appearance style of the component -
+   *
+   * `"solid"` (containing border) or `"minimal"` (no containing border).
+   */
   appearance: ColorAppearance;
   /**
    * Internal prop for advanced use-cases.
@@ -23,154 +27,147 @@ export declare class ColorPicker implements InteractiveComponent {
   color: InternalColor | null;
   handleColorChange(color: Color | null, oldColor: Color | null): void;
   /**
-   * When true, disabled prevents user interaction.
+   * When `true`, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
-   * The format of the value property.
+   * The format of `value`.
    *
-   * When "auto", the format will be inferred from `value` when set.
+   * When `"auto"`, the format will be inferred from `value` when set.
    *
    * @default "auto"
    */
   format: Format;
   handleFormatChange(format: ColorPicker["format"]): void;
-  /** When true, hides the hex input */
+  /** When `true`, hides the Hex input. */
   hideHex: boolean;
-  /** When true, hides the RGB/HSV channel inputs */
+  /** When `true`, hides the RGB/HSV channel inputs. */
   hideChannels: boolean;
-  /** When true, hides the saved colors section */
+  /** When `true`, hides the saved colors section. */
   hideSaved: boolean;
   /**
-   * Label used for the blue channel
+   * Accessible name for the RGB section's blue channel.
    *
    * @default "B"
    */
   intlB: string;
   /**
-   * Label used for the blue channel description
+   * Accessible name for the RGB section's blue channel description.
    *
    * @default "Blue"
    */
   intlBlue: string;
   /**
-   * Label used for the delete color button.
+   * Accessible name for the delete color button.
    *
    * @default "Delete color"
    */
   intlDeleteColor: string;
   /**
-   * Label used for the green channel
+   * Accessible name for the RGB section's green channel.
    *
    * @default "G"
    */
   intlG: string;
   /**
-   * Label used for the green channel description
+   * Accessible name for the RGB section's green channel description.
    *
    * @default "Green"
    */
   intlGreen: string;
   /**
-   * Label used for the hue channel
+   * Accessible name for the HSV section's hue channel.
    *
    * @default "H"
    */
   intlH: string;
   /**
-   * Label used for the HSV mode
+   * Accessible name for the HSV mode.
    *
    * @default "HSV"
    */
   intlHsv: string;
   /**
-   * Label used for the hex input
+   * Accessible name for the Hex input.
    *
    * @default "Hex"
    */
   intlHex: string;
   /**
-   * Label used for the hue channel description
+   * Accessible name for the HSV section's hue channel description.
    *
    * @default "Hue"
    */
   intlHue: string;
   /**
-   * Label used for the hex input when there is no color selected.
+   * Accessible name for the Hex input when there is no color selected.
    *
    * @default "No color"
    */
   intlNoColor: string;
   /**
-   * Label used for the red channel
+   * Accessible name for the RGB section's red channel.
    *
    * @default "R"
    */
   intlR: string;
   /**
-   * Label used for the red channel description
+   * Accessible name for the RGB section's red channel description.
    *
    * @default "Red"
    */
   intlRed: string;
   /**
-   * Label used for the RGB mode
+   * Accessible name for the RGB mode.
    *
    * @default "RGB"
    */
   intlRgb: string;
   /**
-   * Label used for the saturation channel
+   * Accessible name for the HSV section's saturation channel.
    *
    * @default "S"
    */
   intlS: string;
   /**
-   * Label used for the saturation channel description
+   * Accessible name for the HSV section's saturation channel description.
    *
    * @default "Saturation"
    */
   intlSaturation: string;
   /**
-   * Label used for the save color button.
+   * Accessible name for the save color button.
    *
    * @default "Save color"
    */
   intlSaveColor: string;
   /**
-   * Label used for the saved colors section
+   * Accessible name for the saved colors section.
    *
    * @default "Saved"
    */
   intlSaved: string;
   /**
-   * Label used for the value channel
+   * Accessible name for the HSV section's value channel.
    *
    * @default "V"
    */
   intlV: string;
   /**
-   * Label used for the
+   * Accessible name for the HSV section's value channel description.
    *
    * @default "Value"
    */
   intlValue: string;
-  /**
-   * The scale of the color picker.
-   */
+  /** Specifies the size of the component. */
   scale: Scale;
   handleScaleChange(scale?: Scale): void;
-  /**
-   * Storage ID for colors.
-   */
+  /** Specifies the storage ID for colors. */
   storageId: string;
   /** Specifies the Unicode numeral system used by the component for localization. */
   numberingSystem?: NumberingSystem;
   /**
-   * The component's value.
-   *
-   * This value can be either a CSS color string,
-   * a RGB, HSL or HSV object.
+   * The component's value, where the value can be a CSS color string, or a RGB, HSL or HSV object.
    *
    * The type will be preserved as the color is updated.
    *
@@ -221,7 +218,7 @@ export declare class ColorPicker implements InteractiveComponent {
   /**
    * Fires as the color value changes.
    *
-   * This is similar to the change event with the exception of dragging. When dragging the color field or hue slider thumb, this event fires as the thumb is moved.
+   * Similar to the `calciteColorPickerChange` event with the exception of dragging. When dragging the color field or hue slider thumb, this event fires as the thumb is moved.
    */
   calciteColorPickerInput: EventEmitter<void>;
   private handleTabActivate;

package/dist/types/components/color-picker-hex-input/color-picker-hex-input.d.ts

@@ -6,29 +6,27 @@ export declare class ColorPickerHexInput {
   el: HTMLCalciteColorPickerHexInputElement;
   connectedCallback(): void;
   /**
-   * When false, empty color (null) will be allowed as a value. Otherwise, a color value is always enforced by the component.
+   * When `false`, an empty color (`null`) will be allowed as a `value`. Otherwise, a color value is enforced on the component.
    *
-   * When true, clearing the input and blurring will restore the last valid color set. When false, it will set it to empty.
+   * When `true`, a color value is enforced, and clearing the input or blurring will restore the last valid `value`. When `false`, an empty color (`null`) will be allowed as a `value`.
    */
   allowEmpty: boolean;
   /**
-   * Label used for the hex input.
+   * Accessible name for the Hex input.
    *
    * @default "Hex"
    */
   intlHex: string;
   /**
-   * Label used for the hex input when there is no color selected.
+   * Accessible name for the Hex input when there is no color selected.
    *
    * @default "No color"
    */
   intlNoColor: string;
-  /**
-   * The component's scale.
-   */
+  /** Specifies the size of the component. */
   scale: Scale;
   /**
-   * The hex value.
+   * The Hex value.
    */
   value: string;
   /** Specifies the Unicode numeral system used by the component for localization. */

package/dist/types/components/color-picker-swatch/color-picker-swatch.d.ts

@@ -2,7 +2,7 @@ import { VNode } from "../../stencil-public-runtime";
 import { Scale } from "../interfaces";
 export declare class ColorPickerSwatch {
   /**
-   * Used to display whether the swatch is active or not.
+   * When `true`, the component is active.
    */
   active: boolean;
   /**
@@ -13,7 +13,7 @@ export declare class ColorPickerSwatch {
   color: string;
   handleColorChange(color: string): void;
   /**
-   * The component scale.
+   * Specifies the size of the component.
    */
   scale: Scale;
   el: HTMLCalciteColorPickerSwatchElement;

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

@@ -16,30 +16,30 @@ interface ItemData {
 export declare class Combobox implements LabelableComponent, FormComponent, InteractiveComponent, OpenCloseComponent, FloatingUIComponent {
   el: HTMLCalciteComboboxElement;
   /**
-   * When true, opens the combobox
+   * When `true`, displays and positions the component.
    *
-   * @deprecated use open instead
+   * @deprecated use `open` instead.
    */
   active: boolean;
   activeHandler(value: boolean): void;
-  /**When true, opens the combobox */
+  /**When `true`, displays and positions the component. */
   open: boolean;
   openHandler(value: boolean): void;
-  /** Disable combobox input */
+  /** When `true`, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
   handleDisabledChange(value: boolean): void;
-  /** Aria label for combobox (required) */
+  /** Accessible name for the component. */
   label: string;
-  /** Placeholder text for input */
+  /** Specifies the placeholder text for the input. */
   placeholder?: string;
-  /** Placeholder icon for input  */
+  /** Specifies the placeholder icon for the input. */
   placeholderIcon?: string;
-  /** Specify the maximum number of combobox items (including nested children) to display before showing the scroller */
+  /** Specifies the maximum number of `calcite-combobox-item`s (including nested children) to display before displaying a scrollbar. */
   maxItems: number;
   maxItemsHandler(): void;
-  /** The name of the switch input */
+  /** Specifies the name of the component on form submission. */
   name: string;
-  /** Allow entry of custom values which are not in the original set of items */
+  /** When `true`, allows entry of custom values, which are not in the original set of items. */
   allowCustomValues: boolean;
   /**
    * Determines the type of positioning to use for the overlaid content.
@@ -52,25 +52,25 @@ export declare class Combobox implements LabelableComponent, FormComponent, Inte
   overlayPositioning: OverlayPositioning;
   overlayPositioningHandler(): void;
   /**
-   * When true, the component must have a value in order for the form to submit.
+   * When `true`, the component must have a value in order for the form to submit.
    *
    * @internal
    */
   required: boolean;
   /**
-   * specify the selection mode
-   * - multi: allow any number of selected items (default)
-   * - single: only one selection)
-   * - ancestors: like multi, but show ancestors of selected items as selected, only deepest children shown in chips
+   * Specifies the selection mode -
+   * `"multi"` (allow any number of selected items),
+   * `"single"` (allow only one selection), or
+   * `"ancestors"` (like `"multi"`, but show ancestors of selected items as selected. Only the deepest children are shown in `calcite-chip`s).
    */
   selectionMode: ComboboxSelectionMode;
-  /** Specify the scale of the combobox, defaults to m */
+  /** Specifies the size of the component. */
   scale: Scale;
-  /** The value(s) of the selectedItem(s) */
+  /** The component's value(s) from the selected `calcite-combobox-item`(s). */
   value: string | string[];
   valueHandler(value: string | string[]): void;
   /**
-   * string to override the English "Remove tag" text for when an item is selected.
+   * Accessible name for the component's remove tag when a `calcite-combobox-item` is selected.
    *
    * @default "Remove tag"
    */
@@ -82,34 +82,38 @@ export declare class Combobox implements LabelableComponent, FormComponent, Inte
   flipPlacementsHandler(): void;
   documentClickHandler(event: PointerEvent): void;
   calciteComboboxItemChangeHandler(event: CustomEvent<HTMLCalciteComboboxItemElement>): void;
-  /** Updates the position of the component. */
-  reposition(): Promise<void>;
+  /**
+   * Updates the position of the component.
+   *
+   * @param delayed
+   */
+  reposition(delayed?: boolean): Promise<void>;
   /** Sets focus on the component. */
   setFocus(): Promise<void>;
   /**
-   * Called when the selected items set changes
+   * Fires when the selected items set changes.
    *
-   * @deprecated use calciteComboboxChange instead
+   * @deprecated use `calciteComboboxChange` instead.
    */
   calciteLookupChange: EventEmitter<HTMLCalciteComboboxItemElement[]>;
   /**
-   * Called when the selected item(s) changes.
+   * Fires when the selected item(s) changes.
    */
   calciteComboboxChange: EventEmitter<{
     selectedItems: HTMLCalciteComboboxItemElement[];
   }>;
-  /** Called when the user has entered text to filter the options list */
+  /** Fires when text is added to filter the options list. */
   calciteComboboxFilterChange: EventEmitter<{
     visibleItems: HTMLCalciteComboboxItemElement[];
     text: string;
   }>;
   /**
-   * Called when a selected item in the combobox is dismissed via its chip
+   * Fires when a selected item in the component is dismissed via its `calcite-chip`.
    *
-   * **Note:**: The event payload is deprecated, please use the `value` property on the component to determine removed value instead
+   * **Note:**: The event payload is deprecated, please use the `value` property on the component to determine the removed value instead.
    */
   calciteComboboxChipDismiss: EventEmitter<DeprecatedEventPayload>;
-  /** Fires when the component is requested to be closed and before the closing transition begins. */
+  /** Fires when the component is requested to be closed, and before the closing transition begins. */
   calciteComboboxBeforeClose: EventEmitter<void>;
   /** Fires when the component is closed and animation is complete. */
   calciteComboboxClose: EventEmitter<void>;
@@ -152,7 +156,6 @@ export declare class Combobox implements LabelableComponent, FormComponent, Inte
   private ignoreSelectedEventsFlag;
   openTransitionProp: string;
   transitionEl: HTMLDivElement;
-  private debouncedReposition;
   setFilteredPlacements: () => void;
   getValue: () => string | string[];
   onLabelClick: () => void;

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

@@ -7,31 +7,33 @@ import { InteractiveComponent } from "../../utils/interactive";
  * @slot - A slot for adding nested `calcite-combobox-item`s.
  */
 export declare class ComboboxItem implements ConditionalSlotComponent, InteractiveComponent {
-  /** When true, the item cannot be clicked and is visually muted. */
+  /** When `true`, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
-  /** Set this to true to pre-select an item. Toggles when an item is checked/unchecked. */
+  /**
+   * When `true`, the component is selected.
+   */
   selected: boolean;
-  /** True when item is highlighted either from keyboard or mouse hover */
+  /** When `true`, the component is active. */
   active: boolean;
-  /** Parent and grandparent combobox items, this is set internally for use from combobox */
+  /** Specifies the parent and grandparent items, which are set on `calcite-combobox`. */
   ancestors: ComboboxChildElement[];
-  /** Unique identifier, used for accessibility */
+  /** The `id` attribute of the component. When omitted, a globally unique identifier is used. */
   guid: string;
-  /** Custom icon to display both in combobox chips and next to combobox item text */
+  /** Specifies an icon to display. */
   icon?: string;
   selectedWatchHandler(): void;
-  /** The main label for this item. */
+  /** The component's text. */
   textLabel: string;
-  /** The item's associated value */
+  /** The component's value. */
   value: any;
   /**
-   * Don't filter this item based on the search text
+   * When `true`, omits the component from the `calcite-combobox` filtered search results.
    *
-   * @deprecated use filterDisabled instead
+   * @deprecated use `filterDisabled` instead.
    */
   constant: boolean;
   /**
-   * Do not filter this item based on the search text
+   * When `true`, omits the component from the `calcite-combobox` filtered search results.
    */
   filterDisabled: boolean;
   el: HTMLCalciteComboboxItemElement;
@@ -41,7 +43,7 @@ export declare class ComboboxItem implements ConditionalSlotComponent, Interacti
   disconnectedCallback(): void;
   componentDidRender(): void;
   /**
-   * Emitted whenever the item is selected or unselected.
+   * Emits whenever the component is selected or unselected.
    *
    * **Note:**: The event's payload is deprecated, please use the event's `target`/`currentTarget` instead
    */

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

@@ -5,9 +5,9 @@ import { Scale } from "../interfaces";
  * @slot - A slot for adding `calcite-combobox-item`s.
  */
 export declare class ComboboxItemGroup {
-  /** Parent and grandparent combobox items, this is set internally for use from combobox */
+  /** Specifies the parent and grandparent `calcite-combobox-item`s, which are set on `calcite-combobox`. */
   ancestors: ComboboxChildElement[];
-  /** Title of the group */
+  /** Specifies the title of the component. */
   label: string;
   connectedCallback(): void;
   el: HTMLCalciteComboboxItemGroupElement;

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

@@ -74,8 +74,12 @@ export declare class Dropdown implements InteractiveComponent, OpenCloseComponen
   componentDidRender(): void;
   disconnectedCallback(): void;
   render(): VNode;
-  /** Updates the position of the component. */
-  reposition(): Promise<void>;
+  /**
+   * Updates the position of the component.
+   *
+   * @param delayed
+   */
+  reposition(delayed?: boolean): Promise<void>;
   /** fires when a dropdown item has been selected or deselected */
   calciteDropdownSelect: EventEmitter<Selection>;
   /** Fires when the component is requested to be closed and before the closing transition begins. */
@@ -107,7 +111,6 @@ export declare class Dropdown implements InteractiveComponent, OpenCloseComponen
   transitionEl: HTMLDivElement;
   guid: string;
   defaultAssignedElements: Element[];
-  private debouncedReposition;
   slotChangeHandler: (event: Event) => void;
   setFilteredPlacements: () => void;
   updateTriggers: (event: Event) => void;

package/dist/types/components/input-date-picker/input-date-picker.d.ts

@@ -10,11 +10,11 @@ import { LocalizedComponent, NumberingSystem } from "../../utils/locale";
 export declare class InputDatePicker implements LabelableComponent, FormComponent, InteractiveComponent, OpenCloseComponent, FloatingUIComponent, LocalizedComponent {
   el: HTMLCalciteInputDatePickerElement;
   /**
-   * When true, interaction is prevented and the component is displayed with lower opacity.
+   * When `true`, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
-   * When true, the component's value can be read, but controls are not accessible and the value cannot be modified.
+   * When `true`, the component's value can be read, but controls are not accessible and the value cannot be modified.
    *
    * @mdn [readOnly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly)
    */
@@ -57,13 +57,13 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
   max?: string;
   onMaxChanged(max: string): void;
   /**
-   * When true, the component is active.
+   * When `true`, the component is active.
    *
    * @deprecated use `open` instead.
    */
   active: boolean;
   activeHandler(value: boolean): void;
-  /** When true, displays the `calcite-date-picker` component. */
+  /** When `true`, displays the `calcite-date-picker` component. */
   open: boolean;
   openHandler(value: boolean): void;
   /**
@@ -108,10 +108,10 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
    * @default "bottom-start"
    */
   placement: MenuPlacement;
-  /** When true, activates a range for the component. */
+  /** When `true`, activates a range for the component. */
   range: boolean;
   /**
-   * When true, the component must have a value in order for the form to submit.
+   * When `true`, the component must have a value in order for the form to submit.
    *
    * @internal
    */
@@ -139,7 +139,7 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
   overlayPositioning: OverlayPositioning;
   overlayPositioningHandler(): void;
   /**
-   * When true, disables the default behavior on the third click of narrowing or extending the range.
+   * When `true`, disables the default behavior on the third click of narrowing or extending the range.
    * Instead starts a new range.
    */
   proximitySelectionDisabled: boolean;
@@ -174,8 +174,12 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
   calciteInputDatePickerOpen: EventEmitter<void>;
   /** Sets focus on the component. */
   setFocus(): Promise<void>;
-  /** Updates the position of the component. */
-  reposition(): Promise<void>;
+  /**
+   * Updates the position of the component.
+   *
+   * @param delayed
+   */
+  reposition(delayed?: boolean): Promise<void>;
   connectedCallback(): void;
   componentWillLoad(): Promise<void>;
   componentDidLoad(): void;
@@ -199,7 +203,6 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
   openTransitionProp: string;
   transitionEl: HTMLDivElement;
   setReferenceEl(): void;
-  private debouncedReposition;
   setFilteredPlacements: () => void;
   private setTransitionEl;
   onLabelClick(): void;

package/dist/types/components/input-time-picker/input-time-picker.d.ts

@@ -66,7 +66,7 @@ export declare class InputTimePicker implements LabelableComponent, FormComponen
    */
   numberingSystem?: NumberingSystem;
   /**
-   * When true, the component must have a value in order for the form to submit.
+   * When `true`, the component must have a value in order for the form to submit.
    *
    * @internal
    */
@@ -119,8 +119,12 @@ export declare class InputTimePicker implements LabelableComponent, FormComponen
   timePickerFocusHandler(event: CustomEvent): void;
   /** Sets focus on the component. */
   setFocus(): Promise<void>;
-  /** Updates the position of the component. */
-  reposition(): Promise<void>;
+  /**
+   * Updates the position of the component.
+   *
+   * @param delayed
+   */
+  reposition(delayed?: boolean): Promise<void>;
   keyDownHandler: (event: KeyboardEvent) => void;
   onLabelClick(): void;
   private shouldIncludeSeconds;

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

@@ -7,7 +7,7 @@ import { HeadingLevel } from "../functional/Heading";
  */
 export declare class Popover implements FloatingUIComponent, OpenCloseComponent {
   /**
-   * When true and clicking outside of the component, automatically closes open `calcite-popover`s.
+   * When `true`, clicking outside of the component automatically closes open `calcite-popover`s.
    */
   autoClose: boolean;
   /**
@@ -65,7 +65,7 @@ export declare class Popover implements FloatingUIComponent, OpenCloseComponent
    * When `true`, displays and positions the component.
    */
   open: boolean;
-  openHandler(): void;
+  openHandler(value: boolean): void;
   /**
    * Determines the type of positioning to use for the overlaid content.
    *
@@ -120,8 +120,12 @@ export declare class Popover implements FloatingUIComponent, OpenCloseComponent
   calcitePopoverBeforeOpen: EventEmitter<void>;
   /** Fires when the component is open and animation is complete. */
   calcitePopoverOpen: EventEmitter<void>;
-  /** Updates the position of the component. */
-  reposition(): Promise<void>;
+  /**
+   * Updates the position of the component.
+   *
+   * @param delayed
+   */
+  reposition(delayed?: boolean): Promise<void>;
   /**
    * Sets focus on the component.
    *
@@ -134,7 +138,6 @@ export declare class Popover implements FloatingUIComponent, OpenCloseComponent
    * @param value
    */
   toggle(value?: boolean): Promise<void>;
-  private debouncedReposition;
   private setTransitionEl;
   setFilteredPlacements: () => void;
   setUpReferenceElement: (warn?: boolean) => void;

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

@@ -23,7 +23,7 @@ export declare class Tip implements ConditionalSlotComponent {
    */
   headingLevel: HeadingLevel;
   /**
-   * When true and if it has a parent `calcite-tip-manager`, the component is selected.
+   * When `true`, the component is selected if it has a parent `calcite-tip-manager`.
    *
    * Only one tip can be selected within the `calcite-tip-manager` parent.
    */