@esri/calcite-components 1.0.0-beta.90 → 1.0.0-beta.93

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

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

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

@@ -1,9 +1,9 @@
-export interface StepperItemEventDetail {
-  position: number;
-}
-export interface StepperItemKeyEventDetail {
-  item: KeyboardEvent;
-}
-export interface StepperItemChangeEventDetail {
-  position: number;
-}
+export interface StepperItemEventDetail {
+  position: number;
+}
+export interface StepperItemKeyEventDetail {
+  item: KeyboardEvent;
+}
+export interface StepperItemChangeEventDetail {
+  position: number;
+}

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

@@ -1,64 +1,64 @@
-import { EventEmitter, VNode } from "../../stencil-public-runtime";
-import { Layout, Scale } from "../interfaces";
-import { StepperItemChangeEventDetail, StepperItemKeyEventDetail } from "./interfaces";
-/**
- * @slot - A slot for adding `calcite-stepper-item`s.
- */
-export declare class Stepper {
-  el: HTMLCalciteStepperElement;
-  /** optionally display a status icon next to the step title */
-  icon: boolean;
-  /** specify the layout of stepper, defaults to horizontal */
-  layout: Extract<"horizontal" | "vertical", Layout>;
-  /** optionally display the number next to the step title */
-  numbered: boolean;
-  /** specify the scale of stepper, defaults to m */
-  scale: Scale;
-  /**
-   * This event fires when the active stepper item has changed.
-   *
-   */
-  calciteStepperItemChange: EventEmitter<StepperItemChangeEventDetail>;
-  /**
-   * This event fires when the active stepper item has changed.
-   *
-   * @internal
-   */
-  calciteInternalStepperItemChange: EventEmitter<StepperItemChangeEventDetail>;
-  componentDidLoad(): void;
-  render(): VNode;
-  calciteInternalStepperItemKeyEvent(event: CustomEvent<StepperItemKeyEventDetail>): void;
-  registerItem(event: CustomEvent): void;
-  updateItem(event: CustomEvent): void;
-  handleUserRequestedStepperItemSelect(event: CustomEvent<StepperItemChangeEventDetail>): void;
-  /** set the next step as active */
-  nextStep(): Promise<void>;
-  /** set the previous step as active */
-  prevStep(): Promise<void>;
-  /**
-   * set the requested step as active
-   *
-   * @param step
-   */
-  goToStep(step: number): Promise<void>;
-  /** set the first step as active */
-  startStep(): Promise<void>;
-  /** set the last step as active */
-  endStep(): Promise<void>;
-  private itemMap;
-  /** list of sorted Stepper items */
-  private items;
-  /** list of enabled Stepper items */
-  private enabledItems;
-  /** keep track of the currently active item position */
-  private currentPosition;
-  private getEnabledStepIndex;
-  private updateStep;
-  private focusFirstItem;
-  private focusLastItem;
-  private focusNextItem;
-  private focusPrevItem;
-  private itemIndex;
-  private sortItems;
-  private filterItems;
-}
+import { EventEmitter, VNode } from "../../stencil-public-runtime";
+import { Layout, Scale } from "../interfaces";
+import { StepperItemChangeEventDetail, StepperItemKeyEventDetail } from "./interfaces";
+/**
+ * @slot - A slot for adding `calcite-stepper-item`s.
+ */
+export declare class Stepper {
+  el: HTMLCalciteStepperElement;
+  /** When true, displays a status icon in the `calcite-stepper-item` heading. */
+  icon: boolean;
+  /** Defines the layout of the component. */
+  layout: Extract<"horizontal" | "vertical", Layout>;
+  /** When true, displays the step number in the `calcite-stepper-item` heading. */
+  numbered: boolean;
+  /** Specifies the size of the component. */
+  scale: Scale;
+  /**
+   * Fires when the active `calcite-stepper-item` changes.
+   *
+   */
+  calciteStepperItemChange: EventEmitter<StepperItemChangeEventDetail>;
+  /**
+   * Fires when the active `calcite-stepper-item` changes.
+   *
+   * @internal
+   */
+  calciteInternalStepperItemChange: EventEmitter<StepperItemChangeEventDetail>;
+  componentDidLoad(): void;
+  render(): VNode;
+  calciteInternalStepperItemKeyEvent(event: CustomEvent<StepperItemKeyEventDetail>): void;
+  registerItem(event: CustomEvent): void;
+  updateItem(event: CustomEvent): void;
+  handleUserRequestedStepperItemSelect(event: CustomEvent<StepperItemChangeEventDetail>): void;
+  /** Set the next `calcite-stepper-item` as active. */
+  nextStep(): Promise<void>;
+  /** Set the previous `calcite-stepper-item` as active. */
+  prevStep(): Promise<void>;
+  /**
+   * Set a specified `calcite-stepper-item` as active.
+   *
+   * @param step
+   */
+  goToStep(step: number): Promise<void>;
+  /** Set the first `calcite-stepper-item` as active. */
+  startStep(): Promise<void>;
+  /** Set the last `calcite-stepper-item` as active. */
+  endStep(): Promise<void>;
+  private itemMap;
+  /** list of sorted Stepper items */
+  private items;
+  /** list of enabled Stepper items */
+  private enabledItems;
+  /** keep track of the currently active item position */
+  private currentPosition;
+  private getEnabledStepIndex;
+  private updateStep;
+  private focusFirstItem;
+  private focusLastItem;
+  private focusNextItem;
+  private focusPrevItem;
+  private itemIndex;
+  private sortItems;
+  private filterItems;
+}

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

@@ -1,83 +1,94 @@
-import { EventEmitter, VNode } from "../../stencil-public-runtime";
-import { Layout, Scale } from "../interfaces";
-import { InteractiveComponent } from "../../utils/interactive";
-import { StepperItemChangeEventDetail, StepperItemEventDetail, StepperItemKeyEventDetail } from "../stepper/interfaces";
-/**
- * @slot - A slot for adding custom content.
- */
-export declare class StepperItem implements InteractiveComponent {
-  el: HTMLCalciteStepperItemElement;
-  /** is the step active */
-  active: boolean;
-  /** has the step been completed */
-  complete: boolean;
-  /** does the step contain an error that needs to be resolved by the user */
-  error: boolean;
-  /** is the step disabled and not navigable to by a user */
-  disabled: boolean;
-  /**
-   * pass a title for the stepper item
-   *
-   * @deprecated use heading instead
-   */
-  itemTitle?: string;
-  /** stepper item heading */
-  heading?: string;
-  /**
-   * pass a title for the stepper item
-   *
-   * @deprecated use description instead
-   */
-  itemSubtitle?: string;
-  /** stepper item description */
-  description: string;
-  /** pass a title for the stepper item */
-  /** @internal */
-  layout?: Extract<"horizontal" | "vertical", Layout>;
-  /** should the items display an icon based on status */
-  /** @internal */
-  icon: boolean;
-  /** optionally display the step number next to the title and subtitle */
-  /** @internal */
-  numbered: boolean;
-  /** the scale of the item */
-  /** @internal */
-  scale: Scale;
-  disabledWatcher(): void;
-  activeWatcher(active: boolean): void;
-  headerEl: HTMLDivElement;
-  /**
-   * @internal
-   */
-  calciteInternalStepperItemKeyEvent: EventEmitter<StepperItemKeyEventDetail>;
-  /**
-   * @internal
-   */
-  calciteInternalStepperItemSelect: EventEmitter<StepperItemEventDetail>;
-  /**
-   * @internal
-   */
-  calciteInternalUserRequestedStepperItemSelect: EventEmitter<StepperItemChangeEventDetail>;
-  /**
-   * @internal
-   */
-  calciteInternalStepperItemRegister: EventEmitter<StepperItemEventDetail>;
-  componentWillLoad(): void;
-  componentDidRender(): void;
-  render(): VNode;
-  updateActiveItemOnChange(event: CustomEvent<StepperItemChangeEventDetail>): void;
-  setFocus(): Promise<void>;
-  /** position within parent */
-  private itemPosition;
-  /** the latest requested item position*/
-  private activePosition;
-  /** the parent stepper component */
-  private parentStepperEl;
-  private keyDownHandler;
-  private renderIcon;
-  private determineActiveItem;
-  private registerStepperItem;
-  private emitUserRequestedItem;
-  private emitRequestedItem;
-  private getItemPosition;
-}
+import { EventEmitter, VNode } from "../../stencil-public-runtime";
+import { Layout, Scale } from "../interfaces";
+import { InteractiveComponent } from "../../utils/interactive";
+import { StepperItemChangeEventDetail, StepperItemEventDetail, StepperItemKeyEventDetail } from "../stepper/interfaces";
+/**
+ * @slot - A slot for adding custom content.
+ */
+export declare class StepperItem implements InteractiveComponent {
+  el: HTMLCalciteStepperItemElement;
+  /**
+   *  is the step active
+   *
+   * @deprecated Use selected instead.
+   */
+  active: boolean;
+  activeHandler(value: boolean): void;
+  /**
+   * When true, step is selected
+   */
+  selected: boolean;
+  selectedHandler(value: boolean): void;
+  /** has the step been completed */
+  complete: boolean;
+  /** When true, the component contains an error that requires resolution from the user. */
+  error: boolean;
+  /** When true, interaction is prevented and the component is displayed with lower opacity. */
+  disabled: boolean;
+  /**
+   * The component header text.
+   *
+   * @deprecated use "heading" instead.
+   */
+  itemTitle?: string;
+  /** The component header text. */
+  heading?: string;
+  /**
+   * A description for the component. Displays below the header text.
+   *
+   * @deprecated use "description" instead.
+   */
+  itemSubtitle?: string;
+  /** A description for the component. Displays below the header text. */
+  description: string;
+  /** Defines the layout of the component. */
+  /** @internal */
+  layout?: Extract<"horizontal" | "vertical", Layout>;
+  /** When true, displays a status icon in the `calcite-stepper-item` heading. */
+  /** @internal */
+  icon: boolean;
+  /** When true, displays the step number in the `calcite-stepper-item` heading. */
+  /** @internal */
+  numbered: boolean;
+  /** Specifies the size of the component. */
+  /** @internal */
+  scale: Scale;
+  disabledWatcher(): void;
+  headerEl: HTMLDivElement;
+  /**
+   * @internal
+   */
+  calciteInternalStepperItemKeyEvent: EventEmitter<StepperItemKeyEventDetail>;
+  /**
+   * @internal
+   */
+  calciteInternalStepperItemSelect: EventEmitter<StepperItemEventDetail>;
+  /**
+   * @internal
+   */
+  calciteInternalUserRequestedStepperItemSelect: EventEmitter<StepperItemChangeEventDetail>;
+  /**
+   * @internal
+   */
+  calciteInternalStepperItemRegister: EventEmitter<StepperItemEventDetail>;
+  connectedCallback(): void;
+  componentWillLoad(): void;
+  componentDidRender(): void;
+  render(): VNode;
+  updateActiveItemOnChange(event: CustomEvent<StepperItemChangeEventDetail>): void;
+  setFocus(): Promise<void>;
+  /** position within parent */
+  private itemPosition;
+  /** the latest requested item position*/
+  private selectedPosition;
+  /** the parent stepper component */
+  private parentStepperEl;
+  private keyDownHandler;
+  private renderIcon;
+  private determineSelectedItem;
+  private registerStepperItem;
+  private handleItemClick;
+  private emitUserRequestedItem;
+  private emitRequestedItem;
+  private getItemPosition;
+}

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

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

package/dist/types/components/tab/interfaces.d.ts

@@ -1,6 +1,6 @@
-export interface TabChangeEventDetail {
-  /**
-   * The tab that just became active
-   */
-  tab: number | string;
-}
+export interface TabChangeEventDetail {
+  /**
+   * The tab that just became active
+   */
+  tab: number | string;
+}