@evance/evance-ui 1.0.35 → 1.0.37

package/dist/types/EvSwitch.d.ts

@@ -5,6 +5,7 @@ import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
 import { PropType } from 'vue';
 import { Ref } from 'vue';
+import { ShallowRef } from 'vue';
 import { StyleValue } from 'vue';
 import { VNodeProps } from 'vue';
 
@@ -44,9 +45,7 @@ type: PropType<isDeepEqual>;
 default: isDeepEqual;
 };
 }, {
-reset: () => void;
-resetValidation: () => void;
-validate: (silent?: boolean) => Promise<string[]>;
+field: FormField;
 input: Ref<HTMLInputElement>;
 focus: () => void;
 }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
@@ -102,6 +101,184 @@ valueComparator: isDeepEqual;
     label(): never;
 }>>;
 
+/**
+ * # Form
+ *
+ * @todo: decide whether to implement validators/shapers/resolvers and their terminology.
+ * @todo: decide whether and how to support declarative schemas like Zod (https://zod.dev/?id=introduction)
+ *
+ */
+declare class Form {
+    private props;
+    private fields;
+    private valid;
+    private validating;
+    readonly errors: Ref<ValidationError[]>;
+    readonly data: Ref<object>;
+    readonly validateOn: Ref<FormProps["validateOn"]>;
+    constructor(props: FormProps);
+    get isDisabled(): boolean;
+    get isReadonly(): boolean;
+    get isValid(): boolean | null;
+    get isValidating(): boolean;
+    addErrors(errors: ValidationError[]): void;
+    /**
+     * ## Add Field
+     * @param field
+     */
+    addField(field: FormField): void;
+    /**
+     * ## Get Field
+     * @param name
+     */
+    getField(name: string): FormField | undefined;
+    /**
+     * ## Has Field
+     *
+     * Returns `true` if the field `name` already exists in the form.
+     *
+     * @param id
+     */
+    hasField(id: string): boolean;
+    /**
+     * ## Remove Field
+     * @param id
+     */
+    removeField(id: string): void;
+    /**
+     * ## Reset
+     */
+    reset(): void;
+    /**
+     * ## Reset Validation
+     */
+    resetValidation(): void;
+    /**
+     * ## Validate
+     */
+    validate(): Promise<{
+        valid: boolean;
+        errors: ValidationError[];
+        addErrors: (errors: ValidationError[]) => void;
+    }>;
+}
+
+/**
+ * # Form Field
+ *
+ * @todo: decide on terminology for shapers/validators/resolvers/rules (it would be good to have shapers)
+ *
+ */
+declare class FormField {
+    readonly form: Form | null;
+    private props;
+    private group;
+    readonly focused: Ref<boolean>;
+    readonly focusedVisible: Ref<boolean>;
+    private readonly messages;
+    readonly model: Ref<any>;
+    readonly pristine: ShallowRef<boolean>;
+    readonly uid: number;
+    readonly validating: ShallowRef<boolean>;
+    private readonly validationModel;
+    constructor(form: Form | null, props: FormFieldProps, group?: FormField | undefined);
+    get classes(): {
+        "is-error": boolean;
+        "is-dirty": boolean;
+        "is-disabled": boolean;
+        "is-readonly": boolean;
+        "is-focused": boolean;
+        "is-focused-visible": boolean;
+    };
+    get errorMessages(): string[];
+    get id(): string;
+    get isDirty(): boolean;
+    get isDisabled(): boolean;
+    get isFocused(): boolean;
+    get isFocusedVisible(): boolean;
+    get isReadonly(): boolean;
+    get isPristine(): boolean;
+    get isShowErrorMessages(): boolean;
+    get isValid(): boolean | null;
+    get isValidating(): boolean;
+    get name(): string;
+    get validateOn(): {
+        blur: boolean;
+        input: boolean;
+        submit: boolean;
+        lazy: boolean;
+    };
+    get value(): any;
+    set value(value: any);
+    /**
+     * ## Add Error Message
+     *
+     * Add one or more validation messages to the field.
+     *
+     * @param message
+     */
+    addError(...message: string[]): void;
+    /**
+     * ## Add Validator
+     *
+     * Add one or more validation functions to the field.
+     *
+     * @param validator
+     */
+    addValidator(...validator: Validator[]): void;
+    /**
+     * ## Blur
+     * @param e
+     */
+    blur(): void;
+    /**
+     * ## Focus
+     *
+     * @param e
+     */
+    focus(e?: Event): void;
+    /**
+     * ## Reset
+     */
+    reset(): void;
+    /**
+     * ## Reset Validation
+     */
+    resetValidation(): void;
+    /**
+     * ## Validate
+     */
+    validate(silent?: boolean): Promise<string[]>;
+}
+
+/**
+ * # Form Field Props
+ */
+declare interface FormFieldProps {
+    id?: string;
+    disabled?: boolean;
+    error?: boolean;
+    focused?: boolean;
+    name?: string;
+    readonly?: boolean;
+    validators: Validator[];
+    modelValue?: any;
+    validateOn?: ValidateOnEvent | `${ValidateOnEvent} lazy` | `lazy ${ValidateOnEvent}` | "lazy";
+    validationValue?: any;
+}
+
+/**
+ * # Form Props
+ */
+declare interface FormProps {
+    data?: object;
+    disabled?: boolean;
+    readonly?: boolean;
+    modelValue?: boolean | null;
+    "onUpdate:modelValue"?: ((val: boolean | null) => void) | undefined;
+    validateOn?: FormFieldProps["validateOn"];
+}
+
 /**
  * # Is Deep Equal?
  *
@@ -252,6 +429,16 @@ export declare const makeEvSwitchProps: <Defaults extends {
  */
 declare type ValidateOnEvent = "blur" | "input" | "submit";
 
+/**
+ * # Validation Error
+ *
+ * Represents a single error message with a name identifier.
+ */
+declare interface ValidationError {
+    name: number | string;
+    message: string;
+}
+
 /**
  * # Validation Result
  */

package/dist/types/EvTextarea.d.ts

@@ -5,6 +5,7 @@ import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
 import { PropType } from 'vue';
 import { Ref } from 'vue';
+import { ShallowRef } from 'vue';
 import { StyleValue } from 'vue';
 import { VNodeProps } from 'vue';
 
@@ -50,9 +51,7 @@ clearable: BooleanConstructor;
 loading: BooleanConstructor;
 placeholder: StringConstructor;
 }, {
-reset: () => void;
-resetValidation: () => void;
-validate: (silent?: boolean) => Promise<string[]>;
+field: FormField;
 input: Ref<HTMLInputElement>;
 focus: () => void;
 }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
@@ -121,6 +120,184 @@ autogrow: boolean;
     label(): never;
 }>>;
 
+/**
+ * # Form
+ *
+ * @todo: decide whether to implement validators/shapers/resolvers and their terminology.
+ * @todo: decide whether and how to support declarative schemas like Zod (https://zod.dev/?id=introduction)
+ *
+ */
+declare class Form {
+    private props;
+    private fields;
+    private valid;
+    private validating;
+    readonly errors: Ref<ValidationError[]>;
+    readonly data: Ref<object>;
+    readonly validateOn: Ref<FormProps["validateOn"]>;
+    constructor(props: FormProps);
+    get isDisabled(): boolean;
+    get isReadonly(): boolean;
+    get isValid(): boolean | null;
+    get isValidating(): boolean;
+    addErrors(errors: ValidationError[]): void;
+    /**
+     * ## Add Field
+     * @param field
+     */
+    addField(field: FormField): void;
+    /**
+     * ## Get Field
+     * @param name
+     */
+    getField(name: string): FormField | undefined;
+    /**
+     * ## Has Field
+     *
+     * Returns `true` if the field `name` already exists in the form.
+     *
+     * @param id
+     */
+    hasField(id: string): boolean;
+    /**
+     * ## Remove Field
+     * @param id
+     */
+    removeField(id: string): void;
+    /**
+     * ## Reset
+     */
+    reset(): void;
+    /**
+     * ## Reset Validation
+     */
+    resetValidation(): void;
+    /**
+     * ## Validate
+     */
+    validate(): Promise<{
+        valid: boolean;
+        errors: ValidationError[];
+        addErrors: (errors: ValidationError[]) => void;
+    }>;
+}
+
+/**
+ * # Form Field
+ *
+ * @todo: decide on terminology for shapers/validators/resolvers/rules (it would be good to have shapers)
+ *
+ */
+declare class FormField {
+    readonly form: Form | null;
+    private props;
+    private group;
+    readonly focused: Ref<boolean>;
+    readonly focusedVisible: Ref<boolean>;
+    private readonly messages;
+    readonly model: Ref<any>;
+    readonly pristine: ShallowRef<boolean>;
+    readonly uid: number;
+    readonly validating: ShallowRef<boolean>;
+    private readonly validationModel;
+    constructor(form: Form | null, props: FormFieldProps, group?: FormField | undefined);
+    get classes(): {
+        "is-error": boolean;
+        "is-dirty": boolean;
+        "is-disabled": boolean;
+        "is-readonly": boolean;
+        "is-focused": boolean;
+        "is-focused-visible": boolean;
+    };
+    get errorMessages(): string[];
+    get id(): string;
+    get isDirty(): boolean;
+    get isDisabled(): boolean;
+    get isFocused(): boolean;
+    get isFocusedVisible(): boolean;
+    get isReadonly(): boolean;
+    get isPristine(): boolean;
+    get isShowErrorMessages(): boolean;
+    get isValid(): boolean | null;
+    get isValidating(): boolean;
+    get name(): string;
+    get validateOn(): {
+        blur: boolean;
+        input: boolean;
+        submit: boolean;
+        lazy: boolean;
+    };
+    get value(): any;
+    set value(value: any);
+    /**
+     * ## Add Error Message
+     *
+     * Add one or more validation messages to the field.
+     *
+     * @param message
+     */
+    addError(...message: string[]): void;
+    /**
+     * ## Add Validator
+     *
+     * Add one or more validation functions to the field.
+     *
+     * @param validator
+     */
+    addValidator(...validator: Validator[]): void;
+    /**
+     * ## Blur
+     * @param e
+     */
+    blur(): void;
+    /**
+     * ## Focus
+     *
+     * @param e
+     */
+    focus(e?: Event): void;
+    /**
+     * ## Reset
+     */
+    reset(): void;
+    /**
+     * ## Reset Validation
+     */
+    resetValidation(): void;
+    /**
+     * ## Validate
+     */
+    validate(silent?: boolean): Promise<string[]>;
+}
+
+/**
+ * # Form Field Props
+ */
+declare interface FormFieldProps {
+    id?: string;
+    disabled?: boolean;
+    error?: boolean;
+    focused?: boolean;
+    name?: string;
+    readonly?: boolean;
+    validators: Validator[];
+    modelValue?: any;
+    validateOn?: ValidateOnEvent | `${ValidateOnEvent} lazy` | `lazy ${ValidateOnEvent}` | "lazy";
+    validationValue?: any;
+}
+
+/**
+ * # Form Props
+ */
+declare interface FormProps {
+    data?: object;
+    disabled?: boolean;
+    readonly?: boolean;
+    modelValue?: boolean | null;
+    "onUpdate:modelValue"?: ((val: boolean | null) => void) | undefined;
+    validateOn?: FormFieldProps["validateOn"];
+}
+
 /**
  * # Input Appearance
  */
@@ -282,6 +459,16 @@ export declare const makeEvTextareaProps: <Defaults extends {
  */
 declare type ValidateOnEvent = "blur" | "input" | "submit";
 
+/**
+ * # Validation Error
+ *
+ * Represents a single error message with a name identifier.
+ */
+declare interface ValidationError {
+    name: number | string;
+    message: string;
+}
+
 /**
  * # Validation Result
  */

package/dist/types/EvTextfield.d.ts

@@ -7,6 +7,7 @@ import { ExtractPropTypes } from 'vue';
 import { FunctionalComponent } from 'vue';
 import { PropType } from 'vue';
 import { Ref } from 'vue';
+import { ShallowRef } from 'vue';
 import { StyleValue } from 'vue';
 import { VNodeProps } from 'vue';
 
@@ -70,9 +71,7 @@ default: string;
 };
 monospace: BooleanConstructor;
 }, {
-reset: () => void;
-resetValidation: () => void;
-validate: (silent?: boolean) => Promise<string[]>;
+field: FormField;
 input: Ref<HTMLInputElement>;
 focus: () => void;
 }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
@@ -166,6 +165,184 @@ clearable: boolean;
     suffix(): never;
 }>>;
 
+/**
+ * # Form
+ *
+ * @todo: decide whether to implement validators/shapers/resolvers and their terminology.
+ * @todo: decide whether and how to support declarative schemas like Zod (https://zod.dev/?id=introduction)
+ *
+ */
+declare class Form {
+    private props;
+    private fields;
+    private valid;
+    private validating;
+    readonly errors: Ref<ValidationError[]>;
+    readonly data: Ref<object>;
+    readonly validateOn: Ref<FormProps["validateOn"]>;
+    constructor(props: FormProps);
+    get isDisabled(): boolean;
+    get isReadonly(): boolean;
+    get isValid(): boolean | null;
+    get isValidating(): boolean;
+    addErrors(errors: ValidationError[]): void;
+    /**
+     * ## Add Field
+     * @param field
+     */
+    addField(field: FormField): void;
+    /**
+     * ## Get Field
+     * @param name
+     */
+    getField(name: string): FormField | undefined;
+    /**
+     * ## Has Field
+     *
+     * Returns `true` if the field `name` already exists in the form.
+     *
+     * @param id
+     */
+    hasField(id: string): boolean;
+    /**
+     * ## Remove Field
+     * @param id
+     */
+    removeField(id: string): void;
+    /**
+     * ## Reset
+     */
+    reset(): void;
+    /**
+     * ## Reset Validation
+     */
+    resetValidation(): void;
+    /**
+     * ## Validate
+     */
+    validate(): Promise<{
+        valid: boolean;
+        errors: ValidationError[];
+        addErrors: (errors: ValidationError[]) => void;
+    }>;
+}
+
+/**
+ * # Form Field
+ *
+ * @todo: decide on terminology for shapers/validators/resolvers/rules (it would be good to have shapers)
+ *
+ */
+declare class FormField {
+    readonly form: Form | null;
+    private props;
+    private group;
+    readonly focused: Ref<boolean>;
+    readonly focusedVisible: Ref<boolean>;
+    private readonly messages;
+    readonly model: Ref<any>;
+    readonly pristine: ShallowRef<boolean>;
+    readonly uid: number;
+    readonly validating: ShallowRef<boolean>;
+    private readonly validationModel;
+    constructor(form: Form | null, props: FormFieldProps, group?: FormField | undefined);
+    get classes(): {
+        "is-error": boolean;
+        "is-dirty": boolean;
+        "is-disabled": boolean;
+        "is-readonly": boolean;
+        "is-focused": boolean;
+        "is-focused-visible": boolean;
+    };
+    get errorMessages(): string[];
+    get id(): string;
+    get isDirty(): boolean;
+    get isDisabled(): boolean;
+    get isFocused(): boolean;
+    get isFocusedVisible(): boolean;
+    get isReadonly(): boolean;
+    get isPristine(): boolean;
+    get isShowErrorMessages(): boolean;
+    get isValid(): boolean | null;
+    get isValidating(): boolean;
+    get name(): string;
+    get validateOn(): {
+        blur: boolean;
+        input: boolean;
+        submit: boolean;
+        lazy: boolean;
+    };
+    get value(): any;
+    set value(value: any);
+    /**
+     * ## Add Error Message
+     *
+     * Add one or more validation messages to the field.
+     *
+     * @param message
+     */
+    addError(...message: string[]): void;
+    /**
+     * ## Add Validator
+     *
+     * Add one or more validation functions to the field.
+     *
+     * @param validator
+     */
+    addValidator(...validator: Validator[]): void;
+    /**
+     * ## Blur
+     * @param e
+     */
+    blur(): void;
+    /**
+     * ## Focus
+     *
+     * @param e
+     */
+    focus(e?: Event): void;
+    /**
+     * ## Reset
+     */
+    reset(): void;
+    /**
+     * ## Reset Validation
+     */
+    resetValidation(): void;
+    /**
+     * ## Validate
+     */
+    validate(silent?: boolean): Promise<string[]>;
+}
+
+/**
+ * # Form Field Props
+ */
+declare interface FormFieldProps {
+    id?: string;
+    disabled?: boolean;
+    error?: boolean;
+    focused?: boolean;
+    name?: string;
+    readonly?: boolean;
+    validators: Validator[];
+    modelValue?: any;
+    validateOn?: ValidateOnEvent | `${ValidateOnEvent} lazy` | `lazy ${ValidateOnEvent}` | "lazy";
+    validationValue?: any;
+}
+
+/**
+ * # Form Props
+ */
+declare interface FormProps {
+    data?: object;
+    disabled?: boolean;
+    readonly?: boolean;
+    modelValue?: boolean | null;
+    "onUpdate:modelValue"?: ((val: boolean | null) => void) | undefined;
+    validateOn?: FormFieldProps["validateOn"];
+}
+
 declare type IconValue = string | (string | [path: string, opacity: number])[] | JsxComponent;
 
 /**
@@ -424,6 +601,16 @@ declare type TextAlignProp = (typeof TextAlign)[keyof typeof TextAlign];
  */
 declare type ValidateOnEvent = "blur" | "input" | "submit";
 
+/**
+ * # Validation Error
+ *
+ * Represents a single error message with a name identifier.
+ */
+declare interface ValidationError {
+    name: number | string;
+    message: string;
+}
+
 /**
  * # Validation Result
  */