@aurodesignsystem/auro-formkit 5.9.0 → 5.9.2

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

@@ -2,7 +2,7 @@ export class AuroInput extends BaseInput {
     static get styles(): import("lit").CSSResult[];
     /**
      * This will register this element with the browser.
-     * @param {string} [name="auro-input"] - The name of element that you want to register to.
+     * @param {string} [name="auro-input"] - The name of the element that you want to register.
      *
      * @example
      * AuroInput.register("custom-input") // this will register this element to <custom-input/>
@@ -71,10 +71,11 @@ export class AuroInput extends BaseInput {
      * @returns {Record<string, boolean>} - Returns classmap.
      */
     private get commonInputClasses();
-    get commonDisplayValueWrapperClasses(): {
-        [x: string]: boolean;
-        displayValueWrapper: boolean;
-    };
+    /**
+     * Common display value wrapper classes.
+     * @private
+     */
+    private get commonDisplayValueWrapperClasses();
     /**
      * Returns classmap configuration for html5 inputs in each layout.
      * @private

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

@@ -1,17 +1,14 @@
 /**
- * Auro-input provides users a way to enter data into a text field.
- *
- * @prop {string} id - The id global attribute defines an identifier (ID) which must be unique in the whole document.
- * @attr id
+ * The `auro-input` element provides users a way to enter data into a text field.
+ * @customElement auro-input
  *
  * @slot ariaLabel.clear - Sets aria-label on clear button for screen reader to read
  * @slot ariaLabel.password.show - Sets aria-label on password button to toggle on showing password
  * @slot ariaLabel.password.hide - Sets aria-label on password button to toggle off showing password
  * @slot helpText - Sets the help text displayed below the input.
  * @slot label - Sets the label text for the input.
- * @slot {HTMLSlotElement} optionalLabel - Allows overriding the optional display text "(optional)", which appears next to the label.
+ * @slot optionalLabel - Allows overriding the optional display text "(optional)", which appears next to the label.
  * @slot displayValue - Allows custom HTML content to display in place of the value when the input is not focused.
- *
  * @csspart wrapper - Use for customizing the style of the root element
  * @csspart label - Use for customizing the style of the label element
  * @csspart helpText - Use for customizing the style of the helpText element
@@ -26,16 +23,16 @@
 export default class BaseInput extends AuroElement {
     static get properties(): {
         /**
-         * If defined, the display value slot content will only mask the HTML5 input element. The input's label will not be masked.
+         * The value for the role attribute.
          */
-        dvInputOnly: {
-            type: BooleanConstructor;
+        a11yRole: {
+            type: StringConstructor;
             reflect: boolean;
         };
         /**
-         * The value for the role attribute.
+         * The value for the aria-controls attribute.
          */
-        a11yRole: {
+        a11yControls: {
             type: StringConstructor;
             reflect: boolean;
         };
@@ -46,13 +43,6 @@ export default class BaseInput extends AuroElement {
             type: BooleanConstructor;
             reflect: boolean;
         };
-        /**
-         * The value for the aria-controls attribute.
-         */
-        a11yControls: {
-            type: StringConstructor;
-            reflect: boolean;
-        };
         /**
          * If set, the label will remain fixed in the active position.
          */
@@ -62,13 +52,10 @@ export default class BaseInput extends AuroElement {
         };
         /**
          * Defines whether the component will be on lighter or darker backgrounds.
-         * @property {'default', 'inverse'}
+         * @type {'default' | 'inverse'}
          * @default 'default'
          */
-        appearance: {
-            type: StringConstructor;
-            reflect: boolean;
-        };
+        appearance: "default" | "inverse";
         /**
          * 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].
          */
@@ -90,6 +77,12 @@ export default class BaseInput extends AuroElement {
             type: StringConstructor;
             reflect: boolean;
         };
+        /**
+         * Custom help text message for email type validity.
+         */
+        customValidityTypeEmail: {
+            type: StringConstructor;
+        };
         /**
          * If set, disables the input.
          */
@@ -97,6 +90,13 @@ export default class BaseInput extends AuroElement {
             type: BooleanConstructor;
             reflect: boolean;
         };
+        /**
+         * If defined, the display value slot content will only mask the HTML5 input element. The input's label will not be masked.
+         */
+        dvInputOnly: {
+            type: BooleanConstructor;
+            reflect: boolean;
+        };
         /**
          * When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.
          */
@@ -118,19 +118,17 @@ export default class BaseInput extends AuroElement {
             reflect: boolean;
         };
         /**
-         * @private
-         * Flag to indicate if the input currently has value.
+         * Flag to indicate if the input currently has focus.
          */
-        hasValue: {
+        hasFocus: {
             type: BooleanConstructor;
             reflect: boolean;
             attribute: boolean;
         };
         /**
-         * @private
-         * Flag to indicate if the input currently has focus.
+         * Flag to indicate if the input currently has value.
          */
-        hasFocus: {
+        hasValue: {
             type: BooleanConstructor;
             reflect: boolean;
             attribute: boolean;
@@ -142,6 +140,21 @@ export default class BaseInput extends AuroElement {
             type: BooleanConstructor;
             reflect: boolean;
         };
+        /**
+         * The id global attribute defines an identifier (ID) which must be unique in the whole document.
+         */
+        id: {
+            type: StringConstructor;
+        };
+        /**
+         * The id for input node.
+         * @private
+         */
+        inputId: {
+            type: StringConstructor;
+            reflect: boolean;
+            attribute: boolean;
+        };
         /** Exposes inputmode attribute for input.  */
         inputmode: {
             type: StringConstructor;
@@ -203,7 +216,7 @@ export default class BaseInput extends AuroElement {
             reflect: boolean;
         };
         /**
-         * DEPRECATED - use `appearance` instead.
+         * DEPRECATED - use `appearance="inverse"` instead.
          */
         onDark: {
             type: BooleanConstructor;
@@ -237,12 +250,6 @@ export default class BaseInput extends AuroElement {
             type: BooleanConstructor;
             reflect: boolean;
         };
-        /**
-         * @ignore
-         */
-        showPassword: {
-            state: boolean;
-        };
         /**
          * Sets a custom help text message to display for all validityStates.
          */
@@ -297,6 +304,12 @@ export default class BaseInput extends AuroElement {
         setCustomValidityValueMissing: {
             type: StringConstructor;
         };
+        /**
+         * @ignore
+         */
+        showPassword: {
+            state: boolean;
+        };
         /**
          * Simple makes the input render without a border.
          */
@@ -304,12 +317,6 @@ export default class BaseInput extends AuroElement {
             type: BooleanConstructor;
             reflect: boolean;
         };
-        /**
-         * Custom help text message for email type validity.
-         */
-        customValidityTypeEmail: {
-            type: StringConstructor;
-        };
         /**
          * 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`.
          */
@@ -318,18 +325,20 @@ export default class BaseInput extends AuroElement {
             reflect: boolean;
         };
         /**
-         * Populates the `type` attribute on the input. Allowed values are `password`, `email`, `credit-card`, `date`, `tel` or `text`. If given value is not allowed or set, defaults to `text`.
+         * Indicates whether the input is in a dirty state (has been interacted with).
+         * @private
          */
-        type: {
-            type: StringConstructor;
+        touched: {
+            type: BooleanConstructor;
             reflect: boolean;
+            attribute: boolean;
         };
         /**
-         * Populates the `value` attribute on the input. Can also be read to retrieve the current value of the input.
+         * Populates the `type` attribute on the input.
+         * @type {'text' | 'password' | 'email' | 'credit-card' | 'tel' | 'number'}
+         * @default 'text'
          */
-        value: {
-            type: StringConstructor;
-        };
+        type: "text" | "password" | "email" | "credit-card" | "tel" | "number";
         /**
          * Sets validation mode to re-eval with each input.
          */
@@ -344,20 +353,10 @@ export default class BaseInput extends AuroElement {
             reflect: boolean;
         };
         /**
-         * Indicates whether the input is in a dirty state (has been interacted with).
-         * @type {boolean}
-         * @default false
-         * @private
-         */
-        touched: boolean;
-        /**
-         * The id for input node.
-         * @private
+         * Populates the `value` attribute on the input. Can also be read to retrieve the current value of the input.
          */
-        inputId: {
+        value: {
             type: StringConstructor;
-            reflect: boolean;
-            attribute: boolean;
         };
         layout: {
             type: StringConstructor;
@@ -365,6 +364,12 @@ export default class BaseInput extends AuroElement {
             reflect: boolean;
         };
     };
+    /**
+     * Internal Defaults.
+     * @private
+     * @returns {void}
+     */
+    private _initializeDefaults;
     activeLabel: boolean;
     appearance: string;
     icon: boolean;
@@ -386,12 +391,6 @@ export default class BaseInput extends AuroElement {
      * @private
      */
     private size;
-    /**
-     * Internal Defaults.
-     * @private
-     * @returns {void}
-     */
-    private privateDefaults;
     touched: boolean;
     util: AuroInputUtilities;
     validation: AuroFormValidation;
@@ -502,7 +501,7 @@ export default class BaseInput extends AuroElement {
      */
     private handleClickClear;
     /**
-     * @param {Event} event - The input event
+     * @param {Event} event - The input event.
      * @private
      * @returns {void}
      */
@@ -608,4 +607,4 @@ export default class BaseInput extends AuroElement {
 }
 import { AuroElement } from '../../layoutElement/src/auroElement.js';
 import { AuroInputUtilities } from "./utilities.js";
-import AuroFormValidation from '@auro-formkit/form-validation';
+import AuroFormValidation from '@aurodesignsystem/form-validation';

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

@@ -1,2 +1,2 @@
-declare const _default: "9.1.0";
+declare const _default: "9.1.1";
 export default _default;