@evance/evance-ui 1.0.33 → 1.0.36

package/dist/types/EvForm.d.ts

@@ -4,6 +4,8 @@ import { ComponentOptionsMixin } from 'vue';
 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';
 
@@ -14,6 +16,7 @@ declare type __VLS_WithTemplateSlots<T, S> = T & {
 };
 
 export declare const EvForm: __VLS_WithTemplateSlots<DefineComponent<    {
+data: ObjectConstructor;
 disabled: BooleanConstructor;
 readonly: BooleanConstructor;
 modelValue: {
@@ -30,16 +33,12 @@ type: PropType<StyleValue>;
 default: any;
 };
 }, {
-reset: () => void;
-resetValidation: () => void;
-validate: () => Promise<{
-valid: boolean;
-errors: ValidationError[];
-}>;
+form: Form;
 }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-submit: (...args: any[]) => void;
-"update:modelValue": (...args: any[]) => void;
+"update:modelValue": (value: boolean) => void;
+submit: (event: SubmitEventPromise) => void;
 }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<    {
+data: ObjectConstructor;
 disabled: BooleanConstructor;
 readonly: BooleanConstructor;
 modelValue: {
@@ -56,19 +55,209 @@ type: PropType<StyleValue>;
 default: any;
 };
 }>> & {
-"onUpdate:modelValue"?: (...args: any[]) => any;
-onSubmit?: (...args: any[]) => any;
+"onUpdate:modelValue"?: (value: boolean) => any;
+onSubmit?: (event: SubmitEventPromise) => any;
 }, {
 modelValue: boolean;
 disabled: boolean;
 style: StyleValue;
 readonly: boolean;
 validateOn: ValidateOnEvent | "input lazy" | "blur lazy" | "submit lazy" | "lazy input" | "lazy blur" | "lazy submit" | "lazy";
-}, {}>, {
-    default?(_: {}): any;
-}>;
+}, {}>, Readonly<{
+    default(props: {
+        form: Form;
+    }): 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"];
+}
+
+/**
+ * # Form Validation Result
+ */
+declare interface FormValidationResult {
+    valid: boolean;
+    errors: ValidationError[];
+    addErrors: (errors: ValidationError[]) => void;
+}
 
 export declare const makeEvFormProps: <Defaults extends {
+    data?: unknown;
     disabled?: unknown;
     readonly?: unknown;
     modelValue?: unknown;
@@ -76,6 +265,10 @@ export declare const makeEvFormProps: <Defaults extends {
     class?: unknown;
     style?: unknown;
 } = {}>(defaults?: Defaults) => {
+    data: unknown extends Defaults["data"] ? ObjectConstructor : {
+        type: PropType<unknown extends Defaults["data"] ? Record<string, any> : Record<string, any> | Defaults["data"]>;
+        default: unknown extends Defaults["data"] ? Record<string, any> : Record<string, any> | Defaults["data"];
+    };
     disabled: unknown extends Defaults["disabled"] ? BooleanConstructor : {
         type: PropType<unknown extends Defaults["disabled"] ? boolean : boolean | Defaults["disabled"]>;
         default: unknown extends Defaults["disabled"] ? boolean : boolean | Defaults["disabled"];
@@ -120,6 +313,12 @@ export declare const makeEvFormProps: <Defaults extends {
     };
 };
 
+/**
+ * # Submit Event Promise
+ */
+declare interface SubmitEventPromise extends SubmitEvent, Promise<FormValidationResult> {
+}
+
 /**
  * # Validate On Event
  */
@@ -135,19 +334,19 @@ declare interface ValidationError {
     message: string;
 }
 
+/**
+ * # Validation Result
+ */
+declare type ValidationResult = string | boolean;
+
+/**
+ * # Validator
+ */
+declare type Validator = ValidationResult | PromiseLike<ValidationResult> | ((value: any) => ValidationResult) | ((value: any) => PromiseLike<ValidationResult>);
+
 export { }
 
 
-export declare namespace toDisplayStateKey {
-    var cache: Map<string, string>;
-}
-
-
-export declare namespace toDisplayRuleKebab {
-    var cache: Map<string, string>;
-}
-
-
 export declare namespace getNextId {
     var reset: () => void;
 }
@@ -167,3 +366,13 @@ export declare namespace toCamelCase {
     var cache: Map<string, string>;
 }
 
+
+export declare namespace toDisplayStateKey {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toDisplayRuleKebab {
+    var cache: Map<string, string>;
+}
+

package/dist/types/EvFormHelp.d.ts

@@ -74,16 +74,6 @@ export declare const makeEvFormHelpProps: <Defaults extends {
 export { }
 
 
-export declare namespace toDisplayStateKey {
-    var cache: Map<string, string>;
-}
-
-
-export declare namespace toDisplayRuleKebab {
-    var cache: Map<string, string>;
-}
-
-
 export declare namespace getNextId {
     var reset: () => void;
 }
@@ -103,3 +93,13 @@ export declare namespace toCamelCase {
     var cache: Map<string, string>;
 }
 
+
+export declare namespace toDisplayStateKey {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toDisplayRuleKebab {
+    var cache: Map<string, string>;
+}
+

package/dist/types/EvHeading.d.ts

@@ -156,16 +156,6 @@ declare interface TagProps {
 export { }
 
 
-export declare namespace toDisplayStateKey {
-    var cache: Map<string, string>;
-}
-
-
-export declare namespace toDisplayRuleKebab {
-    var cache: Map<string, string>;
-}
-
-
 export declare namespace getNextId {
     var reset: () => void;
 }
@@ -185,3 +175,13 @@ export declare namespace toCamelCase {
     var cache: Map<string, string>;
 }
 
+
+export declare namespace toDisplayStateKey {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toDisplayRuleKebab {
+    var cache: Map<string, string>;
+}
+

package/dist/types/EvIcon.d.ts

@@ -1,9 +1,11 @@
 import { AllowedComponentProps } from 'vue';
 import { ComponentCustomProps } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
+import { ComponentPublicInstance } from 'vue';
 import { ComputedRef } from 'vue';
 import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
+import { FunctionalComponent } from 'vue';
 import { PropType } from 'vue';
 import { VNodeProps } from 'vue';
 
@@ -52,7 +54,11 @@ export declare type IconAppearanceProp = (typeof IconAppearance)[keyof typeof Ic
  */
 export declare type IconSize = "small" | "medium" | "large" | "x-large";
 
-declare type IconValue = string | (string | [path: string, opacity: number])[];
+declare type IconValue = string | (string | [path: string, opacity: number])[] | JsxComponent;
+
+declare type JsxComponent<Props = any> = {
+    new (): ComponentPublicInstance<Props>;
+} | FunctionalComponent<Props>;
 
 export declare const makeEvIconProps: <Defaults extends {
     glyph?: unknown;
@@ -89,16 +95,6 @@ export declare function useIcon(props: any, name: string): ComputedRef<any>;
 export { }
 
 
-export declare namespace toDisplayStateKey {
-    var cache: Map<string, string>;
-}
-
-
-export declare namespace toDisplayRuleKebab {
-    var cache: Map<string, string>;
-}
-
-
 export declare namespace getNextId {
     var reset: () => void;
 }
@@ -118,3 +114,13 @@ export declare namespace toCamelCase {
     var cache: Map<string, string>;
 }
 
+
+export declare namespace toDisplayStateKey {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toDisplayRuleKebab {
+    var cache: Map<string, string>;
+}
+

package/dist/types/EvImg.d.ts

@@ -383,16 +383,6 @@ declare type ReferrerPolicy_2 = "no-referrer" | "no-referrer-when-downgrade" | "
 export { }
 
 
-export declare namespace toDisplayStateKey {
-    var cache: Map<string, string>;
-}
-
-
-export declare namespace toDisplayRuleKebab {
-    var cache: Map<string, string>;
-}
-
-
 export declare namespace getNextId {
     var reset: () => void;
 }
@@ -412,3 +402,13 @@ export declare namespace toCamelCase {
     var cache: Map<string, string>;
 }
 
+
+export declare namespace toDisplayStateKey {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toDisplayRuleKebab {
+    var cache: Map<string, string>;
+}
+

package/dist/types/EvInfiniteScroll.d.ts

@@ -298,16 +298,6 @@ declare function reset(status?: InfiniteScrollStatus): void;
 export { }
 
 
-export declare namespace toDisplayStateKey {
-    var cache: Map<string, string>;
-}
-
-
-export declare namespace toDisplayRuleKebab {
-    var cache: Map<string, string>;
-}
-
-
 export declare namespace getNextId {
     var reset: () => void;
 }
@@ -327,3 +317,13 @@ export declare namespace toCamelCase {
     var cache: Map<string, string>;
 }
 
+
+export declare namespace toDisplayStateKey {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toDisplayRuleKebab {
+    var cache: Map<string, string>;
+}
+

package/dist/types/EvKbd.d.ts

@@ -82,16 +82,6 @@ export declare const makeEvKbdProps: <Defaults extends {
 export { }
 
 
-export declare namespace toDisplayStateKey {
-    var cache: Map<string, string>;
-}
-
-
-export declare namespace toDisplayRuleKebab {
-    var cache: Map<string, string>;
-}
-
-
 export declare namespace getNextId {
     var reset: () => void;
 }
@@ -111,3 +101,13 @@ export declare namespace toCamelCase {
     var cache: Map<string, string>;
 }
 
+
+export declare namespace toDisplayStateKey {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toDisplayRuleKebab {
+    var cache: Map<string, string>;
+}
+

package/dist/types/EvLabel.d.ts

@@ -90,16 +90,6 @@ export declare const makeLabelProps: <Defaults extends {
 export { }
 
 
-export declare namespace toDisplayStateKey {
-    var cache: Map<string, string>;
-}
-
-
-export declare namespace toDisplayRuleKebab {
-    var cache: Map<string, string>;
-}
-
-
 export declare namespace getNextId {
     var reset: () => void;
 }
@@ -119,3 +109,13 @@ export declare namespace toCamelCase {
     var cache: Map<string, string>;
 }
 
+
+export declare namespace toDisplayStateKey {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toDisplayRuleKebab {
+    var cache: Map<string, string>;
+}
+

package/dist/types/EvLayout.d.ts

@@ -225,16 +225,6 @@ declare type VisibilityRuleProp = DisplayRuleListProp | boolean;
 export { }
 
 
-export declare namespace toDisplayStateKey {
-    var cache: Map<string, string>;
-}
-
-
-export declare namespace toDisplayRuleKebab {
-    var cache: Map<string, string>;
-}
-
-
 export declare namespace getNextId {
     var reset: () => void;
 }
@@ -254,3 +244,13 @@ export declare namespace toCamelCase {
     var cache: Map<string, string>;
 }
 
+
+export declare namespace toDisplayStateKey {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toDisplayRuleKebab {
+    var cache: Map<string, string>;
+}
+

package/dist/types/EvLink.d.ts

@@ -1,8 +1,10 @@
 import { AllowedComponentProps } from 'vue';
 import { ComponentCustomProps } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
+import { ComponentPublicInstance } from 'vue';
 import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
+import { FunctionalComponent } from 'vue';
 import { PropType } from 'vue';
 import { RouteLocationRaw } from 'vue-router';
 import { StyleValue } from 'vue';
@@ -60,7 +62,11 @@ exact: boolean;
     default(): never;
 }>>;
 
-declare type IconValue = string | (string | [path: string, opacity: number])[];
+declare type IconValue = string | (string | [path: string, opacity: number])[] | JsxComponent;
+
+declare type JsxComponent<Props = any> = {
+    new (): ComponentPublicInstance<Props>;
+} | FunctionalComponent<Props>;
 
 export declare type LinkAppearance = "default" | "subtle";
 
@@ -138,16 +144,6 @@ export declare const makeEvLinkProps: <Defaults extends {
 export { }
 
 
-export declare namespace toDisplayStateKey {
-    var cache: Map<string, string>;
-}
-
-
-export declare namespace toDisplayRuleKebab {
-    var cache: Map<string, string>;
-}
-
-
 export declare namespace getNextId {
     var reset: () => void;
 }
@@ -167,3 +163,13 @@ export declare namespace toCamelCase {
     var cache: Map<string, string>;
 }
 
+
+export declare namespace toDisplayStateKey {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toDisplayRuleKebab {
+    var cache: Map<string, string>;
+}
+

package/dist/types/EvList.d.ts

@@ -517,16 +517,6 @@ declare type SelectStrategyFn = (data: SelectStrategyData) => Map<unknown, Selec
 export { }
 
 
-export declare namespace toDisplayStateKey {
-    var cache: Map<string, string>;
-}
-
-
-export declare namespace toDisplayRuleKebab {
-    var cache: Map<string, string>;
-}
-
-
 export declare namespace getNextId {
     var reset: () => void;
 }
@@ -546,3 +536,13 @@ export declare namespace toCamelCase {
     var cache: Map<string, string>;
 }
 
+
+export declare namespace toDisplayStateKey {
+    var cache: Map<string, string>;
+}
+
+
+export declare namespace toDisplayRuleKebab {
+    var cache: Map<string, string>;
+}
+