@esri/calcite-components 1.0.0-next.555 → 1.0.0-next.558

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

@@ -6,36 +6,36 @@ import { FormComponent } from "../../utils/form";
 import { InteractiveComponent } from "../../utils/interactive";
 export declare class Slider implements LabelableComponent, FormComponent, InteractiveComponent {
   el: HTMLCalciteSliderElement;
-  /** Disable and gray out the slider */
+  /** When true, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
-  /** Indicates if a histogram is present */
+  /** When true, indicates a histogram is present. */
   hasHistogram: boolean;
   /**
-   * List of x,y coordinates within the slider's min and max, displays above the slider track.
+   * A list of the histogram's x,y coordinates within the component's "min" and "max". Displays above the component's track.
    *
    * @see [DataSeries](https://github.com/Esri/calcite-components/blob/master/src/components/graph/interfaces.ts#L5)
    */
   histogram?: DataSeries;
   histogramWatcher(newHistogram: DataSeries): void;
   /**
-   * Array of values describing a single color stop, sorted by offset ascending.
+   * A set of single color stops for a histogram, sorted by offset ascending.
    */
   histogramStops: ColorStop[];
-  /** Label handles with their numeric value */
+  /** When true, displays label handles with their numeric value. */
   labelHandles: boolean;
-  /** Label tick marks with their numeric value. */
+  /** When true and "ticks" is specified, displays label tick marks with their numeric value. */
   labelTicks: boolean;
-  /** Maximum selectable value */
+  /** The component's maximum selectable value. */
   max: number;
-  /** Used as an accessible label (aria-label) for second handle if needed (ex. "Temperature, upper bound") */
+  /** For multiple selections, the accessible name for the second handle, such as "Temperature, upper bound". */
   maxLabel?: string;
-  /** Currently selected upper number (if multi-select) */
+  /** For multiple selections, the component's upper value. */
   maxValue?: number;
-  /** Minimum selectable value */
+  /** The component's minimum selectable value. */
   min: number;
-  /** Used as an accessible label (aria-label) for first (or only) handle (ex. "Temperature, lower bound") */
+  /** Accessible name for first (or only) handle, such as "Temperature, lower bound". */
   minLabel: string;
-  /** Currently selected lower number (if multi-select) */
+  /** For multiple selections, the component's lower value. */
   minValue?: number;
   /**
    * When true, the slider will display values from high to low.
@@ -43,28 +43,28 @@ export declare class Slider implements LabelableComponent, FormComponent, Intera
    * Note that this value will be ignored if the slider has an associated histogram.
    */
   mirrored: boolean;
-  /** The name of the slider */
+  /** Specifies the name of the component on form submission. */
   name: string;
-  /** Interval to move on page up/page down keys */
+  /** Specifies the interval to move with the page up, or page down keys. */
   pageStep?: number;
-  /** Use finer point for handles */
+  /** When true, sets a finer point for handles. */
   precise: boolean;
   /**
-   * When true, makes the component required for form-submission.
+   * When true, the component must have a value on form submission.
    */
   required: boolean;
-  /** When true, enables snap selection along the step interval */
+  /** When true, enables snap selection in coordination with "step" via a mouse. */
   snap: boolean;
-  /** Interval to move on up/down keys */
+  /** Specifies the interval to move with the up, or down keys. */
   step?: number;
-  /** Show tick marks on the number line at provided interval */
+  /** Displays tick marks on the number line at a specified interval. */
   ticks?: number;
-  /** Currently selected number (if single select) */
+  /** The component's value. */
   value: null | number | number[];
   valueHandler(): void;
   minMaxValueHandler(): void;
   /**
-   * Specify the scale of the slider, defaults to m
+   *  Specifies the size of the component.
    */
   scale: Scale;
   connectedCallback(): void;
@@ -78,25 +78,28 @@ export declare class Slider implements LabelableComponent, FormComponent, Intera
   pointerDownHandler(event: PointerEvent): void;
   handleTouchStart(event: TouchEvent): void;
   /**
-   * Fires on all updates to the slider.
-   * :warning: Will be fired frequently during drag. If you are performing any
+   * Fires on all updates to the component.
+   *
+   * **Note:** Will be fired frequently during drag. If you are performing any
    * expensive operations consider using a debounce or throttle to avoid
    * locking up the main thread.
    */
   calciteSliderInput: EventEmitter<void>;
   /**
-   * Fires on when the thumb is released on slider
-   * If you need to constantly listen to the drag event,
-   * please use calciteSliderInput instead
+   * Fires when the thumb is released on the component.
+   *
+   * **Note:** If you need to constantly listen to the drag event,
+   * use "calciteSliderInput" instead.
    */
   calciteSliderChange: EventEmitter<void>;
   /**
-   * Fires on all updates to the slider.
-   * :warning: Will be fired frequently during drag. If you are performing any
+   * Fires on all updates to the component.
+   *
+   * **Note:** Will be fired frequently during drag. If you are performing any
    * expensive operations consider using a debounce or throttle to avoid
    * locking up the main thread.
    *
-   * @deprecated use calciteSliderInput instead
+   * @deprecated use "calciteSliderInput" instead.
    */
   calciteSliderUpdate: EventEmitter<void>;
   /** Sets focus on the component. */

package/dist/types/components/split-button/split-button.d.ts

@@ -8,55 +8,59 @@ import { InteractiveComponent } from "../../utils/interactive";
  */
 export declare class SplitButton implements InteractiveComponent {
   el: HTMLCalciteSplitButtonElement;
-  /** specify the appearance style of the button, defaults to solid. */
+  /** Specifies the appearance style of the component. */
   appearance: ButtonAppearance;
-  /** specify the color of the control, defaults to blue */
+  /** Specifies the color of the component. */
   color: ButtonColor;
-  /** is the control disabled  */
+  /** When true, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
   handleDisabledChange(value: boolean): void;
   /**
-   * Is the dropdown currently active or not
+   * When true, the component is active.
    *
    * @internal
    */
   active: boolean;
   activeHandler(): void;
-  /** specify the icon used for the dropdown menu, defaults to chevron */
+  /** Specifies the icon used for the dropdown menu. */
   dropdownIconType: DropdownIconType;
-  /** aria label for overflow button */
+  /** Accessible name for the dropdown menu. */
   dropdownLabel?: string;
   /**
-    optionally add a calcite-loader component to the control,
-   disabling interaction. with the primary button
+    When true, a busy indicator is displayed on the primary button.
    */
   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;
-  /** optionally pass an icon to display at the end of the primary button - accepts Calcite UI icon names  */
+  /** Specifies an icon to display at the end of the primary button - accepts Calcite UI icon names. */
   primaryIconEnd?: string;
-  /** flip the primary icon(s) in rtl */
+  /**  When true, the primary button icon will be flipped when the element direction is right-to-left ("rtl"). */
   primaryIconFlipRtl?: FlipContext;
-  /** optionally pass an icon to display at the start of the primary button - accepts Calcite UI icon names  */
+  /** Specifies an icon to display at the start of the primary button - accepts Calcite UI icon names.  */
   primaryIconStart?: string;
-  /** optionally pass an aria-label for the primary button */
+  /** Accessible name for the primary button. */
   primaryLabel?: string;
-  /** text for primary action button  */
+  /** Text displayed in the primary button. */
   primaryText: string;
-  /** specify the scale of the control, defaults to m */
+  /** Specifies the size of the component. */
   scale: Scale;
-  /** specify the width of the button, defaults to auto */
+  /** Specifies the width of the component. */
   width: Width;
   /**
-   * fired when the primary button is clicked
+   * Fires when the primary button is clicked.
    *
-   * **Note:** The event payload is deprecated, please use separate mouse event listeners to get info about click.
+   * **Note:** The event payload is deprecated, use separate mouse event listeners to get info about click.
    */
   calciteSplitButtonPrimaryClick: EventEmitter<DeprecatedEventPayload>;
   /**
-   * fired when the secondary button is clicked
+   * Fires when the dropdown menu is clicked.
    *
-   * **Note:** The event payload is deprecated, please use separate mouse event listeners to get info about click.
+   * **Note:** The event payload is deprecated, use separate mouse event listeners to get info about click.
    */
   calciteSplitButtonSecondaryClick: EventEmitter<DeprecatedEventPayload>;
   componentDidRender(): void;

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

@@ -6,21 +6,21 @@ import { StepperItemChangeEventDetail, StepperItemKeyEventDetail } from "./inter
  */
 export declare class Stepper {
   el: HTMLCalciteStepperElement;
-  /** optionally display a status icon next to the step title */
+  /** When true, displays a status icon in the `calcite-stepper-item` heading. */
   icon: boolean;
-  /** specify the layout of stepper, defaults to horizontal */
+  /** Defines the layout of the component. */
   layout: Extract<"horizontal" | "vertical", Layout>;
-  /** optionally display the number next to the step title */
+  /** When true, displays the step number in the `calcite-stepper-item` heading. */
   numbered: boolean;
-  /** specify the scale of stepper, defaults to m */
+  /** Specifies the size of the component. */
   scale: Scale;
   /**
-   * This event fires when the active stepper item has changed.
+   * Fires when the active `calcite-stepper-item` changes.
    *
    */
   calciteStepperItemChange: EventEmitter<StepperItemChangeEventDetail>;
   /**
-   * This event fires when the active stepper item has changed.
+   * Fires when the active `calcite-stepper-item` changes.
    *
    * @internal
    */
@@ -31,19 +31,19 @@ export declare class Stepper {
   registerItem(event: CustomEvent): void;
   updateItem(event: CustomEvent): void;
   handleUserRequestedStepperItemSelect(event: CustomEvent<StepperItemChangeEventDetail>): void;
-  /** set the next step as active */
+  /** Set the next `calcite-stepper-item` as active. */
   nextStep(): Promise<void>;
-  /** set the previous step as active */
+  /** Set the previous `calcite-stepper-item` as active. */
   prevStep(): Promise<void>;
   /**
-   * set the requested step as active
+   * Set a specified `calcite-stepper-item` as active.
    *
    * @param step
    */
   goToStep(step: number): Promise<void>;
-  /** set the first step as active */
+  /** Set the first `calcite-stepper-item` as active. */
   startStep(): Promise<void>;
-  /** set the last step as active */
+  /** Set the last `calcite-stepper-item` as active. */
   endStep(): Promise<void>;
   private itemMap;
   /** list of sorted Stepper items */

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

@@ -7,40 +7,40 @@ import { StepperItemChangeEventDetail, StepperItemEventDetail, StepperItemKeyEve
  */
 export declare class StepperItem implements InteractiveComponent {
   el: HTMLCalciteStepperItemElement;
-  /** is the step active */
+  /** When true, the component is active. */
   active: boolean;
-  /** has the step been completed */
+  /** When true, the component's workflow has been completed. */
   complete: boolean;
-  /** does the step contain an error that needs to be resolved by the user */
+  /** When true, the component contains an error that requires resolution from the user. */
   error: boolean;
-  /** is the step disabled and not navigable to by a user */
+  /** When true, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
   /**
-   * pass a title for the stepper item
+   * The component header text.
    *
-   * @deprecated use heading instead
+   * @deprecated use "heading" instead.
    */
   itemTitle?: string;
-  /** stepper item heading */
+  /** The component header text. */
   heading?: string;
   /**
-   * pass a title for the stepper item
+   * A description for the component. Displays below the header text.
    *
-   * @deprecated use description instead
+   * @deprecated use "description" instead.
    */
   itemSubtitle?: string;
-  /** stepper item description */
+  /** A description for the component. Displays below the header text. */
   description: string;
-  /** pass a title for the stepper item */
+  /** Defines the layout of the component. */
   /** @internal */
   layout?: Extract<"horizontal" | "vertical", Layout>;
-  /** should the items display an icon based on status */
+  /** When true, displays a status icon in the `calcite-stepper-item` heading. */
   /** @internal */
   icon: boolean;
-  /** optionally display the step number next to the title and subtitle */
+  /** When true, displays the step number in the `calcite-stepper-item` heading. */
   /** @internal */
   numbered: boolean;
-  /** the scale of the item */
+  /** Specifies the size of the component. */
   /** @internal */
   scale: Scale;
   disabledWatcher(): void;
@@ -69,7 +69,7 @@ export declare class StepperItem implements InteractiveComponent {
   setFocus(): Promise<void>;
   /** position within parent */
   private itemPosition;
-  /** the latest requested item position*/
+  /** the latest requested item position */
   private activePosition;
   /** the parent stepper component */
   private parentStepperEl;

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

@@ -1,28 +1,28 @@
 import { EventEmitter, VNode } from "../../stencil-public-runtime";
 import { DeprecatedEventPayload, Scale } from "../interfaces";
 import { LabelableComponent } from "../../utils/label";
-import { CheckableFormCompoment } from "../../utils/form";
+import { CheckableFormComponent } from "../../utils/form";
 import { InteractiveComponent } from "../../utils/interactive";
-export declare class Switch implements LabelableComponent, CheckableFormCompoment, InteractiveComponent {
+export declare class Switch implements LabelableComponent, CheckableFormComponent, InteractiveComponent {
   el: HTMLCalciteSwitchElement;
-  /** True if the switch is disabled */
+  /** When true, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
-  /** Applies to the aria-label attribute on the switch */
+  /** Accessible name for the component. */
   label?: string;
-  /** The name of the switch input */
+  /** Specifies the name of the component on form submission. */
   name: string;
-  /** The scale of the switch */
+  /** Specifies the size of the component. */
   scale: Scale;
   /**
-   * True if the switch is initially on
+   * When true, the component is checked.
    *
-   * @deprecated use 'checked' instead.
+   * @deprecated use "checked" instead.
    */
   switched: boolean;
   switchedWatcher(switched: boolean): void;
-  /** True if the switch is initially on */
+  /** When true, the component is checked. */
   checked: boolean;
-  /** The value of the switch input */
+  /** The component's value. */
   value: any;
   labelEl: HTMLCalciteLabelElement;
   switchEl: HTMLDivElement;
@@ -39,7 +39,7 @@ export declare class Switch implements LabelableComponent, CheckableFormCompomen
   /**
    * Fires when the checked value has changed.
    *
-   * **Note:** The event payload is deprecated, please use the `checked` property on the component instead
+   * **Note:** The event payload is deprecated, use the component's "checked" property instead.
    */
   calciteSwitchChange: EventEmitter<DeprecatedEventPayload>;
   connectedCallback(): void;

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

@@ -25,7 +25,12 @@ export declare class Tooltip implements FloatingUIComponent {
    */
   open: boolean;
   openHandler(): void;
-  /** 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;
   overlayPositioningHandler(): void;
   /**