@esri/calcite-components 1.0.0-beta.94 → 1.0.0-beta.96

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

@@ -10,53 +10,69 @@ import { FormOwner } from "../../utils/form";
 /** @slot - A slot for adding text. */
 export declare class Button implements LabelableComponent, InteractiveComponent, FormOwner {
   el: HTMLCalciteButtonElement;
-  /** optionally specify alignment of button elements. */
+  /** Specifies the alignment of the component's elements. */
   alignment?: ButtonAlignment;
-  /** specify the appearance style of the button, defaults to solid. */
+  /** Specifies the appearance style of the component. */
   appearance: ButtonAppearance;
-  /** Applies to the aria-label attribute on the button or hyperlink */
+  /** Accessible name for the component. */
   label?: string;
-  /** specify the color of the button, defaults to blue */
+  /** Specifies the color of the component. */
   color: ButtonColor;
-  /** is the button disabled  */
+  /**  When `true`, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
-  /** optionally pass a href - used to determine if the component should render as a button or an anchor */
+  /**
+   * Specifies the URL of the linked resource, which can be set as an absolute or relative path.
+   */
   href?: string;
-  /** optionally pass an icon to display at the end of a button - accepts calcite ui icon names  */
+  /** Specifies an icon to display at the end of the component. */
   iconEnd?: string;
-  /** flip the icon(s) in rtl */
+  /** When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). */
   iconFlipRtl?: FlipContext;
-  /** optionally pass an icon to display at the start of a button - accepts calcite ui icon names  */
+  /** Specifies an icon to display at the start of the component. */
   iconStart?: string;
   /**
-   * string to override English loading text
+   * Accessible name when the component is loading.
    *
    * @default "Loading"
    */
   intlLoading?: string;
-  /** optionally add a calcite-loader component to the button, disabling interaction.  */
+  /**
+   * When `true`, a busy indicator is displayed and interaction is disabled.
+   */
   loading: boolean;
-  /** The name attribute to apply to the button */
+  /** Specifies the name of the component on form submission. */
   name?: string;
-  /** The rel attribute to apply to the hyperlink */
+  /**
+   * Defines the relationship between the `href` value and the current document.
+   *
+   * @mdn [rel](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel)
+   */
   rel?: string;
   /**
-   * The form ID to associate with the component
+   * The form ID to associate with the component.
    *
-   * @deprecated – this property is no longer needed if placed inside a form.
+   * @deprecated – The property is no longer needed if the component is placed inside a form.
    */
   form?: string;
-  /** optionally add a round style to the button  */
+  /** When `true`, adds a round style to the component. */
   round: boolean;
-  /** specify the scale of the button, defaults to m */
+  /** Specifies the size of the component. */
   scale: Scale;
-  /** is the button a child of a calcite-split-button */
+  /** Specifies if the component is a child of a `calcite-split-button`. */
   splitChild?: "primary" | "secondary" | false;
-  /** The target attribute to apply to the hyperlink */
+  /**
+   * Specifies where to open the linked document defined in the `href` property.
+   *
+   * @mdn [target](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target)
+   */
   target?: string;
-  /** The type attribute to apply to the button */
+  /**
+   * Specifies the default behavior of the button.
+   *
+   * @mdn [type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type)
+   */
   type: string;
-  /** specify the width of the button, defaults to auto */
+  /** Specifies the width of the component. */
   width: Width;
   loadingChanged(newValue: boolean, oldValue: boolean): void;
   connectedCallback(): void;

package/dist/types/components/card/assets/card/t9n/index.d.ts

@@ -0,0 +1,5 @@
+export type Messages = {
+  select: string;
+  deselect: string;
+  loading: string;
+};

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

@@ -7,40 +7,41 @@ import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
  */
 /**
  * @slot - A slot for adding subheader/description content.
- * @slot thumbnail - A slot for adding a thumbnail to the card.
- * @slot title - A slot for adding a card title.
- * @slot subtitle - A slot for adding a card subtitle or short summary.
+ * @slot thumbnail - A slot for adding a thumbnail to the component.
+ * @slot title - A slot for adding a title.
+ * @slot subtitle - A slot for adding a subtitle or short summary.
  * @slot footer-leading - A slot for adding a leading footer.
  * @slot footer-trailing - A slot for adding a trailing footer.
  */
 export declare class Card implements ConditionalSlotComponent {
   el: HTMLCalciteCardElement;
-  /**  When true, the cards content is waiting to be loaded. This state shows a busy indicator.*/
+  /**  When `true`, a busy indicator is displayed. */
   loading: boolean;
-  /** Indicates whether the card is selected. */
+  /** When `true`, the component is selected. */
   selected: boolean;
-  /** Indicates whether the card is selectable. */
+  /** When `true`, the component is selectable. */
   selectable: boolean;
   /**
-   * string to override English loading text
+   * Accessible name when the component is loading.
    *
    * @default "Loading"
    */
   intlLoading?: string;
   /**
-   * string to override English select text for checkbox when selectable is true
+   * When `selectable` is `true`, the accessible name for the component's checkbox for selection.
    *
    * @default "Select"
    */
   intlSelect: string;
   /**
-   * string to override English deselect text for checkbox when selectable is true
+   * When `selectable` is `true`, the accessible name for the component's checkbox for deselection.
    *
    * @default "Deselect"
    */
   intlDeselect: string;
+  /** Sets the placement of the thumbnail defined in the `thumbnail` slot. */
   thumbnailPosition: LogicalFlowPosition;
-  /** Fired when a selectable card is selected */
+  /** Fires when `selectable` is `true` and the component is selected. */
   calciteCardSelect: EventEmitter<void>;
   connectedCallback(): void;
   disonnectedCallback(): void;

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

@@ -5,11 +5,11 @@ import { LabelableComponent } from "../../utils/label";
 import { InteractiveComponent } from "../../utils/interactive";
 export declare class Checkbox implements LabelableComponent, CheckableFormComponent, InteractiveComponent {
   el: HTMLCalciteCheckboxElement;
-  /** The checked state of the checkbox. */
+  /** When `true`, the component is checked. */
   checked: boolean;
-  /** True if the checkbox is disabled */
+  /** When `true`, interaction is prevented and the component is displayed with lower opacity. */
   disabled: boolean;
-  /** The id attribute of the checkbox.  When omitted, a globally unique identifier is used. */
+  /** The `id` attribute of the component. When omitted, a globally unique identifier is used. */
   guid: string;
   /**
    * The hovered state of the checkbox.
@@ -18,28 +18,30 @@ export declare class Checkbox implements LabelableComponent, CheckableFormCompon
    */
   hovered: boolean;
   /**
-   * True if the checkbox is initially indeterminate,
-   * which is independent from its checked state
-   * https://css-tricks.com/indeterminate-checkboxes/
+   * When `true`, the component is initially indeterminate, which is independent from its `checked` value.
+   *
+   * The state is visual only, and can look different across browsers.
+   *
+   * @mdn [indeterminate](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes)
    */
   indeterminate: boolean;
   /**
-   * The label of the checkbox input
+   * Accessible name for the component.
    *
    * @internal
    */
   label?: string;
-  /** The name of the checkbox input */
+  /** Specifies the name of the component on form submission. */
   name: any;
   /**
-   * When true, makes the component required for form-submission.
+   * When `true`, the component must have a value in order for the form to submit.
    *
    * @internal
    */
   required: boolean;
-  /** specify the scale of the checkbox, defaults to m */
+  /** Specifies the size of the component. */
   scale: Scale;
-  /** The value of the checkbox input */
+  /** The component's value. */
   value: any;
   readonly checkedPath = "M5.5 12L2 8.689l.637-.636L5.5 10.727l8.022-7.87.637.637z";
   readonly indeterminatePath = "M13 8v1H3V8z";
@@ -55,15 +57,15 @@ export declare class Checkbox implements LabelableComponent, CheckableFormCompon
   keyDownHandler: (event: KeyboardEvent) => void;
   clickHandler: () => void;
   /**
-   * Emitted when the checkbox is blurred
+   * Emits when the component is blurred.
    *
    * @internal
    */
   calciteInternalCheckboxBlur: EventEmitter<boolean>;
-  /** Emitted when the checkbox checked status changes */
+  /** Emits when the component's `checked` status changes. */
   calciteCheckboxChange: EventEmitter<void>;
   /**
-   * Emitted when the checkbox is focused
+   * Emits when the component is focused.
    *
    * @internal
    */

package/dist/types/components/chip/assets/chip/t9n/index.d.ts

@@ -0,0 +1,3 @@
+export type Messages = {
+  close: string;
+};

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

@@ -7,35 +7,35 @@ import { ConditionalSlotComponent } from "../../utils/conditionalSlot";
  * @slot image - A slot for adding an image.
  */
 export declare class Chip implements ConditionalSlotComponent {
-  /** specify the appearance style of the button, defaults to solid. */
+  /** Specifies the appearance style of the component. */
   appearance: Extract<"solid" | "clear", Appearance>;
-  /** specify the color of the button, defaults to blue */
+  /** Specifies the color for the component. */
   color: ChipColor;
   /**
-   * Optionally show a button the user can click to dismiss the chip
+   * When `true`, a close button is added to the component.
    *
-   * @deprecated use closable instead
+   * @deprecated use `closable` instead.
    */
   dismissible: boolean;
   handleDismissible(value: boolean): void;
-  /** When true, show abutton user can click to dismiss the chip. */
+  /** When `true`, a close button is added to the component. */
   closable: boolean;
   handleClosable(value: boolean): void;
   /**
-   * Aria label for the "x" button
+   * Accessible name for the component's close button.
    *
    * @default "Close"
    */
   dismissLabel?: string;
-  /** optionally pass an icon to display - accepts Calcite UI icon names  */
+  /** Specifies an icon to display. */
   icon?: string;
-  /** flip the icon in rtl */
+  /** When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). */
   iconFlipRtl: boolean;
-  /** specify the scale of the chip, defaults to m */
+  /** Specifies the size of the component. */
   scale: Scale;
-  /** The assigned value for the chip */
+  /** The component's value. */
   value: any;
-  /** When true, hides the chip  */
+  /** When `true`, hides the component. */
   closed: boolean;
   el: HTMLCalciteChipElement;
   connectedCallback(): void;
@@ -43,9 +43,9 @@ export declare class Chip implements ConditionalSlotComponent {
   /** Sets focus on the component. */
   setFocus(): Promise<void>;
   /**
-   * Emitted when the dismiss button is clicked
+   * Fires when the dismiss button is clicked.
    *
-   * **Note:**: The `el` event payload props is deprecated, please use the event's target/currentTarget instead
+   * **Note:**: The `el` event payload props is deprecated, please use the event's `target`/`currentTarget` instead.
    */
   calciteChipDismiss: EventEmitter<DeprecatedEventPayload>;
   closeClickHandler: (event: MouseEvent) => void;

package/dist/types/components/color-picker/assets/color-picker/t9n/index.d.ts

@@ -0,0 +1,21 @@
+export type Messages = {
+  b: string;
+  blue: string;
+  deleteColor: string;
+  g: string;
+  green: string;
+  h: string;
+  hsv: string;
+  hex: string;
+  hue: string;
+  noColor: string;
+  r: string;
+  red: string;
+  rgb: string;
+  s: string;
+  saturation: string;
+  saveColor: string;
+  saved: string;
+  v: string;
+  value: string;
+};

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

@@ -4,15 +4,20 @@ import { ColorAppearance, ColorMode, ColorValue, InternalColor } from "./interfa
 import { Scale } from "../interfaces";
 import { Format } from "./utils";
 import { InteractiveComponent } from "../../utils/interactive";
+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.
@@ -22,158 +27,152 @@ 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;
-  /** standard UniCode numeral system tag for localization */
-  numberingSystem?: string;
+  /** Specifies the Unicode numeral system used by the component for localization. */
+  numberingSystem?: NumberingSystem;
   /**
-   * 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 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.
    *
    * @default "#007ac2"
+   * @see [CSS Color](https://developer.mozilla.org/en-US/docs/Web/CSS/color)
    * @see [ColorValue](https://github.com/Esri/calcite-components/blob/master/src/components/color-picker/interfaces.ts#L10)
    */
   value: ColorValue | null;
@@ -219,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

@@ -1,37 +1,36 @@
 import { EventEmitter, VNode } from "../../stencil-public-runtime";
 import Color from "color";
 import { Scale } from "../interfaces";
+import { NumberingSystem } from "../../utils/locale";
 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;
-  /** standard UniCode numeral system tag for localization */
-  numberingSystem?: string;
+  /** Specifies the Unicode numeral system used by the component for localization. */
+  numberingSystem?: NumberingSystem;
   handleValueChange(value: string, oldValue: string): void;
   /**
    * Emitted when the hex value changes.

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/assets/combobox/t9n/index.d.ts

@@ -0,0 +1,3 @@
+export type Messages = {
+  removeTag: string;
+};