koval-ui 0.12.25 → 0.12.27

package/dist/index.d.ts

@@ -12,6 +12,7 @@ import { FormHTMLAttributes } from 'react';
 import { ForwardedRef } from 'react';
 import { ForwardRefExoticComponent } from 'react';
 import { HTMLAttributes } from 'react';
+import { HTMLInputAutoCompleteAttribute } from 'react';
 import { ImgHTMLAttributes } from 'react';
 import { InputHTMLAttributes } from 'react';
 import { InvalidEvent } from 'react';
@@ -129,21 +130,14 @@ declare type CallbackPropsInteractive = {
      * Provide default checked state for non-controlled CheckboxInput.
      * Setting this prop enables non-controlled mode.
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#additional_attributes
-     * @see https://naspersclassifieds.atlassian.net/wiki/spaces/NDS/pages/57169350329/RFC+Nexus+Input+API#Uncontrolled-input
      */
     defaultChecked?: InputHTMLAttributes<HTMLInputElement>['checked'];
     /**
      * Provide checked state for controlled CheckboxInput.
      * Setting this prop enables controlled mode.
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#additional_attributes
-     * @see https://naspersclassifieds.atlassian.net/wiki/spaces/NDS/pages/57169350329/RFC+Nexus+Input+API#Controllable-state
      */
     checked?: InputHTMLAttributes<HTMLInputElement>['checked'];
-    /**
-     * Disable input.
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#disabled
-     */
-    disabled?: InputHTMLAttributes<HTMLInputElement>['disabled'];
     /**
      * Set on change callback to get Event object.
      * @see https://reactjs.org/docs/events.html#form-events
@@ -176,21 +170,19 @@ declare type CallbackPropsTextual<TElement = HTMLInputElement> = {
      * Provide value for controlled TextInput.
      * Setting this prop enables controlled mode.
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#value
-     * @see https://naspersclassifieds.atlassian.net/wiki/spaces/NDS/pages/57169350329/RFC+Nexus+Input+API#Controllable-state
      */
     value?: InputHTMLAttributes<TElement>['value'];
     /**
      * Provide value for non-controlled TextInput.
      * Setting this prop enables non-controlled mode.
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#value
-     * @see https://naspersclassifieds.atlassian.net/wiki/spaces/NDS/pages/57169350329/RFC+Nexus+Input+API#Uncontrolled-input
      */
     defaultValue?: InputHTMLAttributes<TElement>['defaultValue'];
     /**
-     * Disable input.
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#disabled
+     * Makes the element not mutable, meaning the user can not edit the control
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly
      */
-    disabled?: InputHTMLAttributes<TElement>['disabled'];
+    readOnly?: InputHTMLAttributes<HTMLInputElement>['readOnly'];
     /**
      * Set on change callback to get Event object.
      * @see https://reactjs.org/docs/events.html#form-events
@@ -475,7 +467,7 @@ export declare const InputCheckbox: ForwardRefExoticComponent<DataAttributes & A
 id?: string | undefined;
 role?: AriaRole | undefined;
 className?: string | undefined;
-} & NativePropsInteractive & CallbackPropsInteractive & ValidationProps & {
+} & NativeProps_2 & CallbackPropsInteractive & ValidationProps & {
 label?: string | undefined;
 } & RefAttributes<HTMLInputElement>>;
 
@@ -483,7 +475,7 @@ export declare const InputColor: ForwardRefExoticComponent<DataAttributes & Aria
 id?: string | undefined;
 role?: AriaRole | undefined;
 className?: string | undefined;
-} & NativePropsInteractive & CallbackPropsTextual & Omit<ValidationProps, "validatorFn"> & {
+} & NativeProps_2 & CallbackPropsTextual & Omit<ValidationProps, "validatorFn"> & {
 /**
 * Set text for placeholder.
 * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder
@@ -519,7 +511,6 @@ id?: string | undefined;
 role?: AriaRole | undefined;
 className?: string | undefined;
 } & {
-validation?: "error" | "valid" | "inProgress" | undefined;
 label?: string | undefined;
 children: ReactElement<ChildProps & unknown>[];
 name: string;
@@ -551,7 +542,7 @@ export declare const InputRadio: ForwardRefExoticComponent<DataAttributes & Aria
 id?: string | undefined;
 role?: AriaRole | undefined;
 className?: string | undefined;
-} & NativePropsInteractive & CallbackPropsInteractive & Omit<ValidationProps, "validatorFn"> & {
+} & NativeProps_2 & CallbackPropsInteractive & Omit<ValidationProps, "validatorFn"> & {
 label?: string | undefined;
 } & RefAttributes<HTMLInputElement>>;
 
@@ -571,7 +562,15 @@ export declare const InputText: ForwardRefExoticComponent<DataAttributes & AriaA
 id?: string | undefined;
 role?: AriaRole | undefined;
 className?: string | undefined;
-} & NativePropsTextual & CallbackPropsTextual & ValidationProps & {
+} & NativeProps_2 & {
+inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined;
+placeholder?: string | undefined;
+autoComplete?: HTMLInputAutoCompleteAttribute | undefined;
+maxLength?: number | undefined;
+minLength?: number | undefined;
+pattern?: string | undefined;
+size?: number | undefined;
+} & CallbackPropsTextual & ValidationProps & {
 /**
 * Define a type of TextInput. Allows developer to optionally set one from supported
 * text-like input types instead of default 'text'.
@@ -692,7 +691,30 @@ declare type NativeProps = {
     noValidate?: FormHTMLAttributes<HTMLFormElement>['noValidate'];
 };
 
-declare type NativePropsInteractive = Omit<NativePropsTextual, 'inputMode' | 'pattern' | 'readOnly' | 'minLength' | 'maxLength' | 'autoComplete' | 'placeholder' | 'size'>;
+declare type NativeProps_2 = {
+    /**
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name
+     */
+    name?: InputHTMLAttributes<HTMLInputElement>['name'];
+    /**
+     * Set native HTML `required` attribute.
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/required
+     */
+    required?: InputHTMLAttributes<HTMLInputElement>['required'];
+    /**
+     * Provides substitute for native autofocus functionality.
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus
+     * @see https://github.com/facebook/react/issues/11851#issuecomment-351672131
+     */
+    autoFocus?: InputHTMLAttributes<HTMLInputElement>['autoFocus'];
+    /**
+     * Disable input.
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#disabled
+     */
+    disabled?: InputHTMLAttributes<HTMLInputElement>['disabled'];
+    /** Set native HTML `form` attribute. */
+    form?: InputHTMLAttributes<HTMLInputElement>['form'];
+};
 
 declare type NativePropsNumeric = Omit<NativePropsTextual, 'inputMode' | 'pattern' | 'maxLength' | 'minLength'> & {
     min?: InputHTMLAttributes<HTMLInputElement>['min'];
@@ -708,13 +730,7 @@ declare type NativePropsNumeric = Omit<NativePropsTextual, 'inputMode' | 'patter
     step?: InputHTMLAttributes<HTMLInputElement>['step'];
 };
 
-declare type NativePropsTextual = {
-    /**
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name
-     */
-    name?: InputHTMLAttributes<HTMLInputElement>['name'];
-    /** Set input id attribute. */
-    id?: string;
+declare type NativePropsTextual = NativeProps_2 & {
     /**
      * Provides a hint about the type of data that might be entered by the user while
      * editing the element or its contents. This allows the browser to display an
@@ -722,17 +738,6 @@ declare type NativePropsTextual = {
      * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inputMode
      */
     inputMode?: InputHTMLAttributes<HTMLInputElement>['inputMode'];
-    /**
-     * Set native HTML `required` attribute.
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/required
-     */
-    required?: InputHTMLAttributes<HTMLInputElement>['required'];
-    /**
-     * Provides substitute for native autofocus functionality.
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus
-     * @see https://github.com/facebook/react/issues/11851#issuecomment-351672131
-     */
-    autoFocus?: InputHTMLAttributes<HTMLInputElement>['autoFocus'];
     /**
      * Set text for placeholder.
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder
@@ -753,23 +758,11 @@ declare type NativePropsTextual = {
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/minlength
      */
     minLength?: InputHTMLAttributes<HTMLInputElement>['minLength'];
-    /** Set native HTML `form` attribute. */
-    form?: InputHTMLAttributes<HTMLInputElement>['form'];
-    /**
-     * Set native ARIA role attribute
-     * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/input_role
-     */
-    role?: InputHTMLAttributes<HTMLInputElement>['role'];
     /**
      * Pattern attribute specifies a regular expression the form control's value should match.
      * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern
      */
     pattern?: InputHTMLAttributes<HTMLInputElement>['pattern'];
-    /**
-     * Makes the element not mutable, meaning the user can not edit the control
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly
-     */
-    readOnly?: InputHTMLAttributes<HTMLInputElement>['readOnly'];
     /**
      * Define the width of the input in characters
      */
@@ -1012,7 +1005,6 @@ declare type Props_3 = DataAttributes & LibraryProps & {
 };
 
 declare type Props_4 = DataAttributes & LibraryProps & {
-    validation?: keyof typeof ValidationState;
     label?: string;
     children: ReactElement<ChildProps & unknown>[];
     name: string;
@@ -1093,7 +1085,7 @@ export declare const Select: ForwardRefExoticComponent<DataAttributes & AriaAttr
 id?: string | undefined;
 role?: AriaRole | undefined;
 className?: string | undefined;
-} & NativePropsInteractive & Omit<CallbackPropsTextual<HTMLSelectElement>, "defaultValue"> & ValidationProps & {
+} & NativeProps_2 & Omit<CallbackPropsTextual<HTMLSelectElement>, "defaultValue"> & ValidationProps & {
 children?: ReactNode;
 prefix?: FC | undefined;
 multiple?: SelectHTMLAttributes<HTMLSelectElement>['multiple'];
@@ -1629,15 +1621,15 @@ export declare const useToastState: (id: string) => {
 };
 
 declare type ValidationProps = {
+    /** Enable to re-run validation when any field in the form changes */
+    revalidateOnFormChange?: boolean;
+    /**
+     * Provide callback function to validate input.
+     * @see https://koval.support/inputs/input-validation
+     */
     validatorFn?: (value: unknown, validityState: ValidityState, formState: FormState_2) => string | Promise<string>;
 };
 
-declare enum ValidationState {
-    error = "error",
-    valid = "valid",
-    inProgress = "inProgress"
-}
-
 declare enum Variants {
     bordered = "bordered",
     plain = "plain"