@aurodesignsystem/auro-formkit 2.0.0-beta.2 → 2.0.0-beta.4

package/components/input/dist/base-input.d.ts

@@ -1,42 +1,8 @@
 /**
  * Auro-input provides users a way to enter data into a text field.
  *
- * @attr {Boolean} activeLabel - If set, the label will remain fixed in the active position.
- * @attr {String}  autocapitalize - An enumerated attribute that controls whether and how text input is automatically capitalized as it is entered/edited by the user. [off/none, on/sentences, words, characters]
- * @attr {String}  autocomplete - An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete="off"` is supported.
- * @attr {String}  autocorrect - When set to `off`, stops iOS from auto correcting words when typed into a text box.
  * @attr {Boolean} bordered - Applies bordered UI variant.
  * @attr {Boolean} borderless - Applies borderless UI variant.
- * @attr {Boolean} disabled - If set, disables the input.
- * @attr {String}  error - When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.
- * @prop {String}  errorMessage - Contains the help text message for the current validity error.
- * @attr {Boolean} icon - If set, will render an icon inside the input to the left of the value. Support is limited to auro-input instances with credit card format.
- * @attr {String}  id - Sets the unique ID of the element.
- * @attr {String}  lang - defines the language of an element.
- * @attr {String}  max - The maximum value allowed. This only applies for inputs with a type of `number` and all date formats.
- * @attr {Number}  maxLength - The maximum number of characters the user can enter into the text input. This must be an integer value `0` or higher.
- * @attr {String}  min - The minimum value allowed. This only applies for inputs with a type of `number` and all date formats.
- * @attr {Number}  minLength - The minimum number of characters the user can enter into the text input. This must be an non-negative integer value smaller than or equal to the value specified by `maxlength`.
- * @attr {String}  name - Populates the `name` attribute on the input.
- * @attr {Boolean} noValidate - If set, disables auto-validation on blur.
- * @attr {Boolean} readonly - Makes the input read-only, but can be set programmatically.
- * @attr {Boolean} required - Populates the `required` attribute on the input. Used for client-side validation.
- * @attr {String}  pattern - Specifies a regular expression the form control's value should match.
- * @attr {String}  placeholder - Define custom placeholder text, only supported by date input formats.
- * @attr {String}  setCustomValidity - Sets a custom help text message to display for all validityStates.
- * @attr {String}  setCustomValidityCustomError - Custom help text message to display when validity = `customError`.
- * @attr {String}  setCustomValidityValueMissing - Custom help text message to display when validity = `valueMissing`.
- * @attr {String}  setCustomValidityBadInput - Custom help text message to display when validity = `badInput`.
- * @attr {String}  setCustomValidityTooShort - Custom help text message to display when validity = `tooShort`.
- * @attr {String}  setCustomValidityTooLong - Custom help text message to display when validity = `tooLong`.
- * @attr {String}  setCustomValidityForType - Custom help text message to display for the declared element `type` and type validity fails.
- * @attr {String}  setCustomValidityRangeOverflow - Custom help text message to display when validity = `rangeOverflow`.
- * @attr {String}  setCustomValidityRangeUnderflow - Custom help text message to display when validity = `rangeUnderflow`.
- * @attr {String}  spellcheck - An enumerated attribute defines whether the element may be checked for spelling errors. [true, false]. When set to `false` the attribute `autocorrect` is set to `off` and `autocapitalize` is set to `none`.
- * @attr {String}  type - Populates the `type` attribute on the input. Allowed values are `password`, `email`, `credit-card`, `month-day-year`, `month-year`, `year-month-day`  or `text`. If given value is not allowed or set, defaults to `text`.
- * @attr {Boolean} validateOnInput - Sets validation mode to re-eval with each input.
- * @attr {String}  validity - Specifies the `validityState` this element is in.
- * @attr {String}  value - Populates the `value` attribute on the input. Can also be read to retrieve the current value of the input.
  *
  * @slot helptext - Sets the help text displayed below the input.
  * @slot label - Sets the label text for the input.
@@ -51,69 +17,126 @@
  */
 export default class BaseInput extends LitElement {
     static get properties(): {
-        id: {
-            type: StringConstructor;
+        /**
+         * If set, the label will remain fixed in the active position.
+         */
+        activeLabel: {
+            type: BooleanConstructor;
+            reflect: boolean;
         };
-        name: {
+        /**
+         * An enumerated attribute that controls whether and how text input is automatically capitalized as it is entered/edited by the user. [off/none, on/sentences, words, characters]
+         */
+        autocapitalize: {
             type: StringConstructor;
         };
-        type: {
+        /**
+         * An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete="off"` is supported.
+         */
+        autocomplete: {
             type: StringConstructor;
             reflect: boolean;
         };
-        value: {
+        /**
+         * When set to `off`, stops iOS from auto-correcting words when typed into a text box.
+         */
+        autocorrect: {
             type: StringConstructor;
         };
-        lang: {
-            type: StringConstructor;
+        /**
+         * If set, disables the input.
+         */
+        disabled: {
+            type: BooleanConstructor;
         };
-        pattern: {
+        error: {
             type: StringConstructor;
             reflect: boolean;
         };
-        icon: {
-            type: BooleanConstructor;
-        };
-        disabled: {
-            type: BooleanConstructor;
-        };
-        required: {
-            type: BooleanConstructor;
+        /**
+         * Contains the help text message for the current validity error.
+         */
+        errorMessage: {
+            type: StringConstructor;
         };
-        noValidate: {
+        /**
+         * If set, will render an icon inside the input to the left of the value. Support is limited to auro-input instances with credit card format.
+         */
+        icon: {
             type: BooleanConstructor;
         };
-        spellcheck: {
+        /**
+         * Sets the unique ID of the element.
+         */
+        id: {
             type: StringConstructor;
         };
-        autocorrect: {
+        /**
+         * Defines the language of an element.
+         */
+        lang: {
             type: StringConstructor;
         };
-        autocapitalize: {
+        /**
+         * The maximum value allowed. This only applies for inputs with a type of `number` and all date formats.
+         */
+        max: {
             type: StringConstructor;
         };
-        autocomplete: {
+        /**
+         * The maximum number of characters the user can enter into the text input. This must be an integer value `0` or higher.
+         */
+        maxLength: {
+            type: NumberConstructor;
+        };
+        /**
+         * The minimum value allowed. This only applies for inputs with a type of `number` and all date formats.
+         */
+        min: {
             type: StringConstructor;
-            reflect: boolean;
         };
-        placeholder: {
+        /**
+         * The minimum number of characters the user can enter into the text input. This must be a non-negative integer value smaller than or equal to the value specified by `maxlength`.
+         */
+        minLength: {
+            type: NumberConstructor;
+        };
+        /**
+         * Populates the `name` attribute on the input.
+         */
+        name: {
             type: StringConstructor;
         };
-        activeLabel: {
+        /**
+         * If set, disables auto-validation on blur.
+         */
+        noValidate: {
             type: BooleanConstructor;
-            reflect: boolean;
         };
-        max: {
+        /**
+         * Specifies a regular expression the form control's value should match.
+         */
+        pattern: {
             type: StringConstructor;
+            reflect: boolean;
         };
-        min: {
+        /**
+         * Define custom placeholder text, only supported by date input formats.
+         */
+        placeholder: {
             type: StringConstructor;
         };
-        maxLength: {
-            type: NumberConstructor;
+        /**
+         * Makes the input read-only, but can be set programmatically.
+         */
+        readonly: {
+            type: BooleanConstructor;
         };
-        minLength: {
-            type: NumberConstructor;
+        /**
+         * Populates the `required` attribute on the input. Used for client-side validation.
+         */
+        required: {
+            type: BooleanConstructor;
         };
         /**
          * @ignore
@@ -121,49 +144,97 @@ export default class BaseInput extends LitElement {
         showPassword: {
             state: boolean;
         };
-        validateOnInput: {
-            type: BooleanConstructor;
+        /**
+         * Sets a custom help text message to display for all validityStates.
+         */
+        setCustomValidity: {
+            type: StringConstructor;
         };
-        readonly: {
-            type: BooleanConstructor;
+        /**
+         * Custom help text message to display when validity = `badInput`.
+         */
+        setCustomValidityBadInput: {
+            type: StringConstructor;
         };
-        error: {
+        /**
+         * Custom help text message to display when validity = `customError`.
+         */
+        setCustomValidityCustomError: {
             type: StringConstructor;
-            reflect: boolean;
         };
-        errorMessage: {
+        /**
+         * Custom help text message to display for the declared element `type` and type validity fails.
+         */
+        setCustomValidityForType: {
             type: StringConstructor;
         };
-        validity: {
+        /**
+         * Custom help text message to display when validity = `rangeOverflow`.
+         */
+        setCustomValidityRangeOverflow: {
             type: StringConstructor;
-            reflect: boolean;
         };
-        setCustomValidity: {
+        /**
+         * Custom help text message to display when validity = `rangeUnderflow`.
+         */
+        setCustomValidityRangeUnderflow: {
             type: StringConstructor;
         };
-        setCustomValidityCustomError: {
+        /**
+         * Custom help text message to display when validity = `tooLong`.
+         */
+        setCustomValidityTooLong: {
             type: StringConstructor;
         };
-        setCustomValidityValueMissing: {
+        /**
+         * Custom help text message to display when validity = `tooShort`.
+         */
+        setCustomValidityTooShort: {
             type: StringConstructor;
         };
-        setCustomValidityBadInput: {
+        /**
+         * Custom help text message to display when validity = `valueMissing`.
+         */
+        setCustomValidityValueMissing: {
             type: StringConstructor;
         };
-        setCustomValidityTooShort: {
+        /**
+         * Custom help text message for email type validity.
+         */
+        customValidityTypeEmail: {
             type: StringConstructor;
         };
-        setCustomValidityTooLong: {
+        /**
+         * An enumerated attribute defines whether the element may be checked for spelling errors. [true, false]. When set to `false` the attribute `autocorrect` is set to `off` and `autocapitalize` is set to `none`.
+         */
+        spellcheck: {
             type: StringConstructor;
         };
-        setCustomValidityRangeOverflow: {
+        /**
+         * Populates the `type` attribute on the input. Allowed values are `password`, `email`, `credit-card`, `month-day-year`, `month-year`, `year-month-day` or `text`. If given value is not allowed or set, defaults to `text`.
+         */
+        type: {
             type: StringConstructor;
+            reflect: boolean;
         };
-        setCustomValidityRangeUnderflow: {
+        /**
+         * Populates the `value` attribute on the input. Can also be read to retrieve the current value of the input.
+         */
+        value: {
             type: StringConstructor;
         };
-        customValidityTypeEmail: {
+        /**
+         * Sets validation mode to re-eval with each input.
+         */
+        validateOnInput: {
+            type: BooleanConstructor;
+        };
+        /**
+         * Specifies the `validityState` this element is in.
+         */
+        validity: {
             type: StringConstructor;
+            reflect: boolean;
         };
     };
     static get styles(): import("lit").CSSResult[];
@@ -336,7 +407,7 @@ export default class BaseInput extends LitElement {
      * @returns {void}
      */
     private processCreditCard;
-    setCustomValidity: any;
+    errorMessage: any;
     /**
      * Function to support credit-card feature type.
      * @private

package/components/input/dist/base-input.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-input.d.ts","sourceRoot":"","sources":["../src/base-input.js"],"names":[],"mappings":"AAoBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AAEH;IA+EE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAiCI;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAuBN;IAED,+CAMC;IA5IC,cAAiB;IACjB,kBAAqB;IACrB,kBAAqB;IACrB,oBAAuB;IACvB,SAAoB;IACpB,SAAoB;IACpB,eAA0B;IAC1B,eAA0B;IAC1B,qBAAwB;IACxB,iCAAyC;IAG3C;;;;OAIG;IACH,wBAsDC;IArDC,+BAA0C;IAC1C,mBAA8B;IAC9B,kBAAyB;IACzB,2BAAmC;IACnC,kBAAqB;IACrB,cAAuC;IAEvC,4BASC;IAED,yBAQC;IAED,8BAMC;IAED;;;OAGG;IACH,iCAIC;IAMD,iBAEwC;IA+M1C,qBAwEC;IAlEC,+BAA0D;IAC1D,+BAA0D;IAIxD,6BAAqD;IAmC7C,uBAA0D;IA4BtE;;;;OAIG;IACH,2BAHW,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GACd,IAAI,CA6DhB;IArDG,iBAAwB;IAuD5B;;;OAGG;IACH,2BAkBC;IAED;;;OAGG;IACH,6BAMC;IAED;;;OAGG;IACH,sBAMC;IAED;;;;OAIG;IACH,cAEC;IAED;;;;;OAKG;IACH,sBAIC;IAED;;;;OAIG;IACH,2BAUC;IAED;;;;OAIG;IACH,yBAOC;IALC,cAAe;IAOjB;;;OAGG;IACH,oBA0BC;IAED;;;;OAIG;IACH,sBAWC;IAED;;;;OAIG;IACH,mBAMC;IAED;;;;;OAKG;IACH,yBAYC;IAED;;;OAGG;IACH,YAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,IAAI,CAIhB;IAED;;;;OAIG;IACH,6BAYC;IAVG,sBAAuB;IAY3B;;;;;OAKG;IACH,qBAMC;IAED;;;;;OAKG;IACH,oBAwBC;IAED;;;;OAIG;IACH,gCAGC;IAED;;;;OAIG;IACH,uBAkBC;IAED;;;;OAIG;IACH,wBAQC;IAED;;;;OAIG;IACH,2BAQC;IAKD;;;;OAIG;IACH,0BAWC;IALC,uBAA+C;IAOjD;;;;OAIG;IACH,oCAqFC;CACF;2BA/5B+B,KAAK;+BAUN,+BAA+B"}
+{"version":3,"file":"base-input.d.ts","sourceRoot":"","sources":["../src/base-input.js"],"names":[],"mappings":"AAoBA;;;;;;;;;;;;;;;;GAgBG;AAEH;IA+EE;QAGI;;WAEG;;;;;QAMH;;WAEG;;;;QAKH;;WAEG;;;;;QAMH;;WAEG;;;;QAKH;;WAEG;;;;;;;;QAUH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;;QAMH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;;QAMH;;WAEG;;;;QAKH;;WAEG;;;;QAKH;;WAEG;;;;;MAMN;IAGD,+CAMC;IArVC,cAAiB;IACjB,kBAAqB;IACrB,kBAAqB;IACrB,oBAAuB;IACvB,SAAoB;IACpB,SAAoB;IACpB,eAA0B;IAC1B,eAA0B;IAC1B,qBAAwB;IACxB,iCAAyC;IAG3C;;;;OAIG;IACH,wBAsDC;IArDC,+BAA0C;IAC1C,mBAA8B;IAC9B,kBAAyB;IACzB,2BAAmC;IACnC,kBAAqB;IACrB,cAAuC;IAEvC,4BASC;IAED,yBAQC;IAED,8BAMC;IAED;;;OAGG;IACH,iCAIC;IAMD,iBAEwC;IAwZ1C,qBAwEC;IAlEC,+BAA0D;IAC1D,+BAA0D;IAIxD,6BAAqD;IAmC7C,uBAA0D;IA4BtE;;;;OAIG;IACH,2BAHW,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GACd,IAAI,CA6DhB;IArDG,iBAAwB;IAuD5B;;;OAGG;IACH,2BAkBC;IAED;;;OAGG;IACH,6BAMC;IAED;;;OAGG;IACH,sBAMC;IAED;;;;OAIG;IACH,cAEC;IAED;;;;;OAKG;IACH,sBAIC;IAED;;;;OAIG;IACH,2BAUC;IAED;;;;OAIG;IACH,yBAOC;IALC,cAAe;IAOjB;;;OAGG;IACH,oBA0BC;IAED;;;;OAIG;IACH,sBAWC;IAED;;;;OAIG;IACH,mBAMC;IAED;;;;;OAKG;IACH,yBAYC;IAED;;;OAGG;IACH,YAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,IAAI,CAIhB;IAED;;;;OAIG;IACH,6BAYC;IAVG,sBAAuB;IAY3B;;;;;OAKG;IACH,qBAMC;IAED;;;;;OAKG;IACH,oBAwBC;IAED;;;;OAIG;IACH,gCAGC;IAED;;;;OAIG;IACH,uBAkBC;IAED;;;;OAIG;IACH,wBAQC;IAED;;;;OAIG;IACH,2BAQC;IAKD;;;;OAIG;IACH,0BAWC;IALC,kBAAqC;IAOvC;;;;OAIG;IACH,oCAqFC;CACF;2BAtkC+B,KAAK;+BAUN,+BAA+B"}