@esri/calcite-components 1.0.0-next.729 → 1.0.0-next.730

package/dist/extras/docs-json.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-01-20T03:33:14",
+  "timestamp": "2023-01-23T21:52:49",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -4750,7 +4750,7 @@
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
-          "docs": "Specifies the name of the component on form submission.",
+          "docs": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission.",
           "docsTags": [],
           "values": [
             {
@@ -8973,7 +8973,7 @@
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
-          "docs": "Specifies the name of the component on form submission.",
+          "docs": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission.",
           "docsTags": [
             {
               "name": "mdn",
@@ -9270,7 +9270,7 @@
           "mutable": false,
           "attr": "step",
           "reflectToAttr": true,
-          "docs": "Specifies the granularity the component's value must adhere to.",
+          "docs": "Specifies the granularity the component's `value` must adhere to.",
           "docsTags": [
             {
               "name": "mdn",
@@ -9672,7 +9672,7 @@
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
-          "docs": "Specifies the name of the component on form submission.",
+          "docs": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission.",
           "docsTags": [],
           "values": [
             {
@@ -10606,7 +10606,7 @@
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
-          "docs": "Specifies the name of the component.",
+          "docs": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission.",
           "docsTags": [
             {
               "name": "mdn",
@@ -11315,7 +11315,7 @@
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
-          "docs": "Specifies the name of the component.",
+          "docs": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission.",
           "docsTags": [
             {
               "name": "mdn",
@@ -13994,7 +13994,7 @@
       "docs": "`calcite-pagination` allows users to select a page from a paginated API.",
       "docsTags": [],
       "usage": {
-        "Basic": "The component is meant to interface with responses from ArcGIS REST services, so the props share names with [response properties](https://developers.arcgis.com/rest/users-groups-and-items/search.htm) from various search endpoints.\n\nFor example, after querying the search API, you'll get back a response similar to JSON below. The response can be passed straight to the `calcite-pagination` component.\n\n```JSON\n{\n  \"total\": 2021,\n  \"start\": 1,\n  \"num\": 100,\n  \"results\": []\n}\n```\n\n```html\n<calcite-pagination start=\"1\" num=\"100\" total=\"2021\"></calcite-pagination>\n```\n"
+        "Basic": "The component is meant to interface with responses from ArcGIS REST services, so the props share names with [response properties](https://developers.arcgis.com/rest/users-groups-and-items/search.htm) from various search endpoints.\n\nFor example, after querying the search API, you'll get back a response similar to JSON below. The response can be passed straight to the `calcite-pagination` component.\n\n```JSON\n{\n  \"total\": 2021,\n  \"start\": 1,\n  \"num\": 100,\n  \"results\": []\n}\n```\n\n```html\n<calcite-pagination start-item=\"1\" page-size=\"100\" total-items=\"2021\"></calcite-pagination>\n```\n"
       },
       "props": [
         {
@@ -14029,23 +14029,6 @@
           "optional": false,
           "required": false
         },
-        {
-          "name": "num",
-          "type": "number",
-          "mutable": false,
-          "attr": "num",
-          "reflectToAttr": true,
-          "docs": "Specifies the number of items per page.",
-          "docsTags": [],
-          "default": "20",
-          "values": [
-            {
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
         {
           "name": "numberingSystem",
           "type": "\"arab\" | \"arabext\" | \"bali\" | \"beng\" | \"deva\" | \"fullwide\" | \"gujr\" | \"guru\" | \"hanidec\" | \"khmr\" | \"knda\" | \"laoo\" | \"latn\" | \"limb\" | \"mlym\" | \"mong\" | \"mymr\" | \"orya\" | \"tamldec\" | \"telu\" | \"thai\" | \"tibt\"",
@@ -14147,6 +14130,23 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "pageSize",
+          "type": "number",
+          "mutable": false,
+          "attr": "page-size",
+          "reflectToAttr": true,
+          "docs": "Specifies the number of items per page.",
+          "docsTags": [],
+          "default": "20",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "scale",
           "type": "\"l\" | \"m\" | \"s\"",
@@ -14174,10 +14174,10 @@
           "required": false
         },
         {
-          "name": "start",
+          "name": "startItem",
           "type": "number",
           "mutable": true,
-          "attr": "start",
+          "attr": "start-item",
           "reflectToAttr": true,
           "docs": "Specifies the starting item number.",
           "docsTags": [],
@@ -14191,10 +14191,10 @@
           "required": false
         },
         {
-          "name": "total",
+          "name": "totalItems",
           "type": "number",
           "mutable": false,
-          "attr": "total",
+          "attr": "total-items",
           "reflectToAttr": true,
           "docs": "Specifies the total number of items.",
           "docsTags": [],
@@ -16042,7 +16042,7 @@
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
-          "docs": "Specifies the name of the component, passed from the `calcite-radio-button-group` on form submission.",
+          "docs": "Specifies the name of the component. Can be inherited from `calcite-radio-button-group`.\n\nRequired to pass the component's `value` on form submission.",
           "docsTags": [],
           "values": [
             {
@@ -16425,7 +16425,7 @@
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
-          "docs": "Specifies the name of the component on form submission.",
+          "docs": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission.",
           "docsTags": [],
           "values": [
             {
@@ -16755,7 +16755,7 @@
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
-          "docs": "Specifies the name of the component on form submission.",
+          "docs": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission.",
           "docsTags": [],
           "values": [
             {
@@ -17066,7 +17066,7 @@
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
-          "docs": "Specifies the name of the component on form submission.",
+          "docs": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission.",
           "docsTags": [],
           "values": [
             {
@@ -17904,7 +17904,7 @@
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
-          "docs": "Specifies the name of the component on form submission.",
+          "docs": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission.",
           "docsTags": [],
           "values": [
             {
@@ -19307,7 +19307,7 @@
           "mutable": false,
           "attr": "name",
           "reflectToAttr": true,
-          "docs": "Specifies the name of the component on form submission.",
+          "docs": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission.",
           "docsTags": [],
           "values": [
             {

package/dist/extras/vscode-data.json

@@ -1482,7 +1482,7 @@
         },
         {
           "name": "name",
-          "description": "Specifies the name of the component on form submission."
+          "description": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission."
         },
         {
           "name": "open",
@@ -2426,7 +2426,7 @@
         },
         {
           "name": "name",
-          "description": "Specifies the name of the component on form submission."
+          "description": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission."
         },
         {
           "name": "number-button-type",
@@ -2567,7 +2567,7 @@
         },
         {
           "name": "step",
-          "description": "Specifies the granularity the component's value must adhere to.",
+          "description": "Specifies the granularity the component's `value` must adhere to.",
           "values": [
             {
               "name": "any"
@@ -2675,7 +2675,7 @@
         },
         {
           "name": "name",
-          "description": "Specifies the name of the component on form submission."
+          "description": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission."
         },
         {
           "name": "numbering-system",
@@ -2954,7 +2954,7 @@
         },
         {
           "name": "name",
-          "description": "Specifies the name of the component."
+          "description": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission."
         },
         {
           "name": "number-button-type",
@@ -3181,7 +3181,7 @@
         },
         {
           "name": "name",
-          "description": "Specifies the name of the component."
+          "description": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission."
         },
         {
           "name": "pattern",
@@ -3933,10 +3933,6 @@
           "name": "group-separator",
           "description": "When `true`, number values are displayed with a group separator corresponding to the language and country format."
         },
-        {
-          "name": "num",
-          "description": "Specifies the number of items per page."
-        },
         {
           "name": "numbering-system",
           "description": "Specifies the Unicode numeral system used by the component for localization.",
@@ -4009,6 +4005,10 @@
             }
           ]
         },
+        {
+          "name": "page-size",
+          "description": "Specifies the number of items per page."
+        },
         {
           "name": "scale",
           "description": "Specifies the size of the component.",
@@ -4025,11 +4025,11 @@
           ]
         },
         {
-          "name": "start",
+          "name": "start-item",
           "description": "Specifies the starting item number."
         },
         {
-          "name": "total",
+          "name": "total-items",
           "description": "Specifies the total number of items."
         }
       ]
@@ -4397,7 +4397,7 @@
         },
         {
           "name": "name",
-          "description": "Specifies the name of the component, passed from the `calcite-radio-button-group` on form submission."
+          "description": "Specifies the name of the component. Can be inherited from `calcite-radio-button-group`.\n\nRequired to pass the component's `value` on form submission."
         },
         {
           "name": "required",
@@ -4500,7 +4500,7 @@
         },
         {
           "name": "name",
-          "description": "Specifies the name of the component on form submission."
+          "description": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission."
         },
         {
           "name": "read-only",
@@ -4587,7 +4587,7 @@
         },
         {
           "name": "name",
-          "description": "Specifies the name of the component on form submission."
+          "description": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission."
         },
         {
           "name": "scale",
@@ -4668,7 +4668,7 @@
         },
         {
           "name": "name",
-          "description": "Specifies the name of the component on form submission."
+          "description": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission."
         },
         {
           "name": "scale",
@@ -4879,7 +4879,7 @@
         },
         {
           "name": "name",
-          "description": "Specifies the name of the component on form submission."
+          "description": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission."
         },
         {
           "name": "numbering-system",
@@ -5364,7 +5364,7 @@
         },
         {
           "name": "name",
-          "description": "Specifies the name of the component on form submission."
+          "description": "Specifies the name of the component.\n\nRequired to pass the component's `value` on form submission."
         },
         {
           "name": "scale",

package/dist/loader/cdn.js

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.729
+ * v1.0.0-next.730
  */
 module.exports = require('../cjs/loader.cjs.js');
 module.exports.applyPolyfills = function() { return Promise.resolve() };

package/dist/loader/index.cjs.js

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.729
+ * v1.0.0-next.730
  */
 module.exports = require('../cjs/loader.cjs.js');
 module.exports.applyPolyfills = function() { return Promise.resolve() };

package/dist/loader/index.es2017.js

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.729
+ * v1.0.0-next.730
  */
 export * from '../esm/polyfills/index.js';
 export * from '../esm/loader.js';

package/dist/loader/index.js

@@ -1,7 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
- * v1.0.0-next.729
+ * v1.0.0-next.730
  */
 (function(){if("undefined"!==typeof window&&void 0!==window.Reflect&&void 0!==window.customElements){var a=HTMLElement;window.HTMLElement=function(){return Reflect.construct(a,[],this.constructor)};HTMLElement.prototype=a.prototype;HTMLElement.prototype.constructor=HTMLElement;Object.setPrototypeOf(HTMLElement,a)}})();
 export * from '../esm/polyfills/index.js';

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

@@ -35,7 +35,11 @@ export declare class Combobox implements LabelableComponent, FormComponent, Inte
   /** Specifies the maximum number of `calcite-combobox-item`s (including nested children) to display before displaying a scrollbar. */
   maxItems: number;
   maxItemsHandler(): void;
-  /** Specifies the name of the component on form submission. */
+  /**
+   * Specifies the name of the component.
+   *
+   * Required to pass the component's `value` on form submission.
+   */
   name: string;
   /** When `true`, allows entry of custom values, which are not in the original set of items. */
   allowCustomValues: boolean;

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

@@ -93,7 +93,9 @@ export declare class Input implements LabelableComponent, FormComponent, Interac
    */
   minLength: number;
   /**
-   * Specifies the name of the component on form submission.
+   * Specifies the name of the component.
+   *
+   * Required to pass the component's `value` on form submission.
    *
    * @mdn [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name)
    */
@@ -121,7 +123,7 @@ export declare class Input implements LabelableComponent, FormComponent, Interac
   /** Specifies the status of the input field, which determines message and icons. */
   status: Status;
   /**
-   * Specifies the granularity the component's value must adhere to.
+   * Specifies the granularity the component's `value` must adhere to.
    *
    * @mdn [step](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/step)
    */

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

@@ -50,7 +50,9 @@ export declare class InputDatePicker implements LabelableComponent, FormComponen
   open: boolean;
   openHandler(value: boolean): void;
   /**
-   * Specifies the name of the component on form submission.
+   * Specifies the name of the component.
+   *
+   * Required to pass the component's `value` on form submission.
    */
   name: string;
   /**

package/dist/types/components/input-number/input-number.d.ts

@@ -93,6 +93,8 @@ export declare class InputNumber implements LabelableComponent, FormComponent, I
   /**
    * Specifies the name of the component.
    *
+   * Required to pass the component's `value` on form submission.
+   *
    * @mdn [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name)
    */
   name: string;

package/dist/types/components/input-text/input-text.d.ts

@@ -62,6 +62,8 @@ export declare class InputText implements LabelableComponent, FormComponent, Int
   /**
    * Specifies the name of the component.
    *
+   * Required to pass the component's `value` on form submission.
+   *
    * @mdn [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name)
    */
   name: string;

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

@@ -5,8 +5,8 @@ import { Scale } from "../interfaces";
 import { PaginationMessages } from "./assets/pagination/t9n";
 export interface PaginationDetail {
   start: number;
-  total: number;
-  num: number;
+  totalItems: number;
+  startItem: number;
 }
 export declare class Pagination implements LocalizedComponent, LocalizedComponent, T9nComponent {
   /**
@@ -19,15 +19,15 @@ export declare class Pagination implements LocalizedComponent, LocalizedComponen
   messageOverrides: Partial<PaginationMessages>;
   onMessagesChange(): void;
   /** Specifies the number of items per page. */
-  num: number;
+  pageSize: number;
   /**
    * Specifies the Unicode numeral system used by the component for localization.
    */
   numberingSystem: NumberingSystem;
   /** Specifies the starting item number. */
-  start: number;
+  startItem: number;
   /** Specifies the total number of items. */
-  total: number;
+  totalItems: number;
   /** Specifies the size of the component. */
   scale: Scale;
   el: HTMLCalcitePaginationElement;

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

@@ -33,7 +33,11 @@ export declare class RadioButton implements LabelableComponent, CheckableFormCom
    * @internal
    */
   label?: string;
-  /** Specifies the name of the component, passed from the `calcite-radio-button-group` on form submission. */
+  /**
+   * Specifies the name of the component. Can be inherited from `calcite-radio-button-group`.
+   *
+   * Required to pass the component's `value` on form submission.
+   */
   name: string;
   nameChanged(): void;
   /** When `true`, the component must have a value selected from the `calcite-radio-button-group` in order for the form to submit. */

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

@@ -26,7 +26,11 @@ export declare class Rating implements LabelableComponent, FormComponent, Intera
    */
   messageOverrides: Partial<RatingMessages>;
   onMessagesChange(): void;
-  /** Specifies the name of the component on form submission. */
+  /**
+   * Specifies the name of the component.
+   *
+   * Required to pass the component's `value` on form submission.
+   */
   name: string;
   /** When `true`, the component's value can be read, but cannot be modified. */
   readOnly: boolean;

package/dist/types/components/segmented-control/segmented-control.d.ts

@@ -22,7 +22,9 @@ export declare class SegmentedControl implements LabelableComponent, FormCompone
   /** Defines the layout of the component. */
   layout: Layout;
   /**
-   * Specifies the name of the component on form submission.
+   * Specifies the name of the component.
+   *
+   * Required to pass the component's `value` on form submission.
    */
   name: string;
   /** Specifies the size of the component. */

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

@@ -18,7 +18,9 @@ export declare class Select implements LabelableComponent, FormComponent, Intera
    */
   label: string;
   /**
-   * Specifies the name of the component on form submission.
+   * Specifies the name of the component.
+   *
+   * Required to pass the component's `value` on form submission.
    */
   name: string;
   /**

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

@@ -49,7 +49,11 @@ export declare class Slider implements LabelableComponent, FormComponent, Intera
    * Note that this value will be ignored if the slider has an associated histogram.
    */
   mirrored: boolean;
-  /** Specifies the name of the component on form submission. */
+  /**
+   * Specifies the name of the component.
+   *
+   * Required to pass the component's `value` on form submission.
+   */
   name: string;
   /**
    * Specifies the Unicode numeral system used by the component for localization.

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

@@ -10,7 +10,11 @@ export declare class Switch implements LabelableComponent, CheckableFormComponen
   disabled: boolean;
   /** Accessible name for the component. */
   label: string;
-  /** Specifies the name of the component on form submission. */
+  /**
+   * Specifies the name of the component.
+   *
+   * Required to pass the component's `value` on form submission.
+   */
   name: string;
   /** Specifies the size of the component. */
   scale: Scale;