@esri/calcite-components 1.0.0-next.647 → 1.0.0-next.649

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

@@ -4,39 +4,43 @@ import { InteractiveComponent } from "../../utils/interactive";
 import { LoadableComponent } from "../../utils/loadable";
 export declare class Filter implements InteractiveComponent, LoadableComponent {
   /**
-   * The items to filter through. The filter uses this as the starting point, and returns items
+   * Defines the items to filter. The component uses the values 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.
+   * This property is needed to conduct filtering.
+   *
    */
   items: object[];
   watchItemsHandler(): void;
   /**
-   * When true, disabled prevents interaction. This state shows items with lower opacity/grayed.
+   * When `true`, interaction is prevented and the component is displayed with lower opacity.
    */
   disabled: boolean;
   /**
-   * The resulting items after filtering.
+   * The component's resulting items after filtering.
    *
    * @readonly
    */
   filteredItems: object[];
   /**
-   * A text label that will appear on the clear button.
+   * Accessible name for the component's clear button.
+   */
+  intlClear: string;
+  /**
+   * Accessible name for the component.
    */
-  intlClear?: string;
+  intlLabel: string;
   /**
-   * A text label that will appear next to the input field.
+   * Specifies placeholder text for the input element.
    */
-  intlLabel?: string;
+  placeholder: string;
   /**
-   * Placeholder text for the input element's placeholder attribute
+   * Specifies the size of the component.
    */
-  placeholder?: string;
-  /** specify the scale of filter, defaults to m */
   scale: Scale;
   /**
-   * Filter value.
+   * The component's value.
    */
   value: string;
   valueHandler(value: string): void;
@@ -46,7 +50,7 @@ export declare class Filter implements InteractiveComponent, LoadableComponent {
   componentDidLoad(): void;
   componentDidRender(): void;
   /**
-   * This event fires when the filter text changes.
+   * Fires when the component's text changes.
    */
   calciteFilterChange: EventEmitter<void>;
   /** Sets focus on the component. */

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

@@ -5,33 +5,33 @@ import { InteractiveComponent } from "../../utils/interactive";
 import { LoadableComponent } from "../../utils/loadable";
 /**
  * @slot - A slot for adding custom content.
- * @slot header-actions-start - A slot for adding actions or content to the start side of the header.
- * @slot header-actions-end - A slot for adding actions or content to the end side of the header.
- * @slot header-content - A slot for adding custom content to the header.
- * @slot header-menu-actions - A slot for adding an overflow menu with actions inside a `calcite-dropdown`.
+ * @slot header-actions-start - A slot for adding `calcite-action`s or content to the start side of the component's header.
+ * @slot header-actions-end - A slot for adding `calcite-action`s or content to the end side of the component's header.
+ * @slot header-content - A slot for adding custom content to the component's header.
+ * @slot header-menu-actions - A slot for adding an overflow menu with `calcite-action`s inside a `calcite-dropdown`.
  * @slot fab - A slot for adding a `calcite-fab` (floating action button) to perform an action.
- * @slot footer-actions - A slot for adding buttons to the footer.
- * @slot footer - A slot for adding custom content to the footer.
+ * @slot footer-actions - A slot for adding `calcite-button`s to the component's footer.
+ * @slot footer - A slot for adding custom content to the component's footer.
  */
 export declare class FlowItem implements InteractiveComponent, LoadableComponent {
-  /** When true, displays a close button in the trailing side of the header */
+  /** When `true`, displays a close button in the trailing side of the component's header. */
   closable: boolean;
-  /** When true, flow-item will be hidden */
+  /** When `true`, the component will be hidden. */
   closed: boolean;
   /**
-   * When provided, this method will be called before it is removed from the parent flow.
+   * When provided, the method will be called before it is removed from its parent `calcite-flow`.
    */
-  beforeBack?: () => Promise<void>;
+  beforeBack: () => Promise<void>;
   /** A description for the component. */
   description: string;
   /**
-   *  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;
   /**
    * The component header text.
    */
-  heading?: string;
+  heading: string;
   /**
    * Specifies the number at which section headings should start.
    */
@@ -39,35 +39,35 @@ export declare class FlowItem implements InteractiveComponent, LoadableComponent
   /**
    * Specifies the maximum height of the component.
    */
-  heightScale?: Scale;
+  heightScale: Scale;
   /**
-   * Accessible name for the component's back button. The back button will only be shown when 'showBackButton' is true.
+   * When `showBackButton` is `true`, the accessible name for the component's back button.
    */
-  intlBack?: string;
+  intlBack: string;
   /**
-   * Accessible name for the component's close button. The close button will only be shown when 'closable' is true.
+   * When `closable` is `true`, the accessible name for the component's close button.
    */
-  intlClose?: string;
+  intlClose: string;
   /**
    * Accessible name for the component's actions menu.
    */
-  intlOptions?: string;
+  intlOptions: string;
   /**
-   * When true, a busy indicator is displayed.
+   * When `true`, a busy indicator is displayed.
    */
   loading: boolean;
   /**
-   * When true, the action menu items in the `header-menu-actions` slot are open.
+   * When `true`, the action menu items in the `header-menu-actions` slot are open.
    */
   menuOpen: boolean;
   /**
-   * When true, displays a back button in the header.
+   * When `true`, displays a back button in the component's header.
    */
   showBackButton: boolean;
   /**
    * Specifies the width of the component.
    */
-  widthScale?: Scale;
+  widthScale: Scale;
   componentWillLoad(): void;
   componentDidRender(): void;
   componentDidLoad(): void;

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

@@ -3,19 +3,21 @@ import { Scale } from "../interfaces";
 export declare class Icon {
   el: HTMLCalciteIconElement;
   /**
-   * The name of the icon to display. The value of this property must match the icon name from https://esri.github.io/calcite-ui-icons/.
+   * Displays a specific icon.
+   *
+   * @see [Icons](https://esri.github.io/calcite-ui-icons)
    */
   icon: string;
   /**
-   * When true, the icon will be flipped when the element direction is 'rtl'.
+   * When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`).
    */
   flipRtl: boolean;
   /**
-   * Icon scale.
+   * Specifies the size of the component.
    */
   scale: Scale;
   /**
-   * The icon label.
+   * Accessible name for the component.
    *
    * It is recommended to set this value if your icon is semantic.
    */

package/dist/types/components/inline-editable/inline-editable.d.ts

@@ -8,38 +8,42 @@ import { LoadableComponent } from "../../utils/loadable";
  */
 export declare class InlineEditable implements InteractiveComponent, LabelableComponent, LoadableComponent {
   el: HTMLCalciteInlineEditableElement;
-  /** specify whether editing can be enabled */
+  /**
+   * When `true`, interaction is prevented and the component is displayed with lower opacity.
+   */
   disabled: boolean;
   disabledWatcher(disabled: boolean): void;
-  /** specify whether the wrapped input element is editable, defaults to false */
+  /**
+   * When `true`, inline editing is enabled on the component.
+   */
   editingEnabled: boolean;
   editingEnabledWatcher(newValue: boolean, oldValue: boolean): void;
-  /** specify whether the confirm button should display a loading state, defaults to false */
+  /** When `true`, a busy indicator is displayed. */
   loading: boolean;
-  /** specify whether save/cancel controls should be displayed when editingEnabled is true, defaults to false */
+  /** When `true` and `editingEnabled` is `true`, displays save and cancel controls on the component. */
   controls: boolean;
   /**
-   * specify text to be user for the enable editing button's aria-label, defaults to `Click to edit`
+   * Accessible name for the component's enable editing button.
    *
    * @default "Click to edit"
    */
   intlEnableEditing: string;
   /**
-   * specify text to be user for the cancel editing button's aria-label, defaults to `Cancel`
+   * Accessible name for the component's cancel editing button.
    *
    * @default "Cancel"
    */
   intlCancelEditing: string;
   /**
-   * specify text to be user for the confirm changes button's aria-label, defaults to `Save`
+   * Accessible name for the component's confirm edits button.
    *
    * @default "Save"
    */
   intlConfirmChanges: string;
-  /** specify the scale of the inline-editable component, defaults to the scale of the wrapped calcite-input or the scale of the closest wrapping component with a set scale */
-  scale?: Scale;
-  /** when controls, specify a callback to be executed prior to disabling editing. when provided, loading state will be handled automatically. */
-  afterConfirm?: () => Promise<void>;
+  /** Specifies the size of the component. Defaults to the scale of the wrapped `calcite-input` or the scale of the closest wrapping component with a set scale. */
+  scale: Scale;
+  /** Specifies a callback to be executed prior to disabling editing via the controls. When provided, the component's loading state will be handled automatically. */
+  afterConfirm: () => Promise<void>;
   connectedCallback(): void;
   componentWillLoad(): void;
   componentDidLoad(): void;
@@ -47,11 +51,11 @@ export declare class InlineEditable implements InteractiveComponent, LabelableCo
   componentDidRender(): void;
   render(): VNode;
   /**
-   * Emitted when the cancel button gets clicked.
+   * Emits when the component's "cancel editing" button is pressed.
    */
   calciteInlineEditableEditCancel: EventEmitter<void>;
   /**
-   * Emitted when the check button gets clicked.
+   * Emits when the component's "confirm edits" button is pressed.
    */
   calciteInlineEditableEditConfirm: EventEmitter<void>;
   /**