@evance/evance-ui 1.0.33 → 1.0.36

package/dist/types/EvCheckbox.d.ts

@@ -6,6 +6,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';
 import { WritableComputedRef } from 'vue';
@@ -46,9 +47,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, {
@@ -106,6 +105,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?
  *
@@ -271,6 +448,16 @@ export declare function useToggleControl(modelProxy: Ref<any>, props: ExtractPro
  */
 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
  */
@@ -284,16 +471,6 @@ declare type Validator = ValidationResult | PromiseLike<ValidationResult> | ((va
 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;
 }
@@ -313,3 +490,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/EvCode.d.ts

@@ -61,16 +61,6 @@ export declare const makeEvCodeProps: <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;
 }
@@ -90,3 +80,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/EvContainer.d.ts

@@ -156,16 +156,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;
 }
@@ -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/EvDataTable.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 { Ref } from 'vue';
 import { RouteLocationRaw } from 'vue-router';
@@ -762,7 +764,7 @@ declare type GetterPropertyKey<T = Record<string, any>> = boolean | null | undef
 
 declare type HeaderCellProps = Record<string, any> | ((data: Pick<ItemKeySlot<any>, "index" | "item" | "internalItem" | "value">) => Record<string, any>);
 
-declare type IconValue = string | (string | [path: string, opacity: number])[];
+declare type IconValue = string | (string | [path: string, opacity: number])[] | JsxComponent;
 
 declare type InfiniteScrollStatus = "ok" | "finished" | "loading" | "error";
 
@@ -829,6 +831,10 @@ declare type ItemSlotBase<T = any> = {
     toggleSelect: ReturnType<typeof provideSelection>["toggleSelect"];
 };
 
+declare type JsxComponent<Props = any> = {
+    new (): ComponentPublicInstance<Props>;
+} | FunctionalComponent<Props>;
+
 declare function loadFirstPage(): void;
 
 export declare const makeEvDataTableCellProps: <Defaults extends {
@@ -1908,16 +1914,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;
 }
@@ -1937,3 +1933,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/EvDataTableCell.d.ts

@@ -138,16 +138,6 @@ export declare const makeEvDataTableCellProps: <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 +157,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/EvDataTableRow.d.ts

@@ -280,16 +280,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;
 }
@@ -309,3 +299,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/EvDataTableSearch.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 { VNodeProps } from 'vue';
@@ -113,7 +115,7 @@ searchDelay: number;
     "select-actions"(): never;
 }>>;
 
-declare type IconValue = string | (string | [path: string, opacity: number])[];
+declare type IconValue = string | (string | [path: string, opacity: number])[] | JsxComponent;
 
 /**
  * # Input Sizes
@@ -129,6 +131,10 @@ declare const InputSize: {
 
 declare type InputSizeProp = (typeof InputSize)[keyof typeof InputSize];
 
+declare type JsxComponent<Props = any> = {
+    new (): ComponentPublicInstance<Props>;
+} | FunctionalComponent<Props>;
+
 export declare const makeEvDataTableSearchProps: <Defaults extends {
     sort?: unknown;
     sortOptions?: unknown;
@@ -232,16 +238,6 @@ declare type VariantProp = (typeof Variant)[keyof typeof Variant];
 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;
 }
@@ -261,3 +257,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/EvDateField.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 { StyleValue } from 'vue';
 import { VNodeProps } from 'vue';
@@ -78,6 +80,8 @@ hint: StringConstructor;
 autofocus: BooleanConstructor;
 autoselect: BooleanConstructor;
 clearable: BooleanConstructor;
+dataFormType: StringConstructor;
+autocomplete: PropType<string>;
 }, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<    {
 allowedDates: (ArrayConstructor | FunctionConstructor)[];
 max: PropType<unknown>;
@@ -143,6 +147,8 @@ hint: StringConstructor;
 autofocus: BooleanConstructor;
 autoselect: BooleanConstructor;
 clearable: BooleanConstructor;
+dataFormType: StringConstructor;
+autocomplete: PropType<string>;
 }>>, {
 disabled: boolean;
 appearance: InputAppearanceProp;
@@ -168,7 +174,7 @@ viewMode: "months" | "month" | "years";
     label(): never;
 }>>;
 
-declare type IconValue = string | (string | [path: string, opacity: number])[];
+declare type IconValue = string | (string | [path: string, opacity: number])[] | JsxComponent;
 
 /**
  * # Input Appearance
@@ -196,6 +202,10 @@ declare const InputSize: {
 
 declare type InputSizeProp = (typeof InputSize)[keyof typeof InputSize];
 
+declare type JsxComponent<Props = any> = {
+    new (): ComponentPublicInstance<Props>;
+} | FunctionalComponent<Props>;
+
 export declare const makeEvDateFieldProps: <Defaults extends {
     allowedDates?: unknown;
     max?: unknown;
@@ -234,6 +244,8 @@ export declare const makeEvDateFieldProps: <Defaults extends {
     autofocus?: unknown;
     autoselect?: unknown;
     clearable?: unknown;
+    dataFormType?: unknown;
+    autocomplete?: unknown;
 } = {}>(defaults?: Defaults) => {
     allowedDates: unknown extends Defaults["allowedDates"] ? (ArrayConstructor | FunctionConstructor)[] : {
         type: PropType<unknown extends Defaults["allowedDates"] ? Function | unknown[] : NonNullable<Function | unknown[]> | Defaults["allowedDates"]>;
@@ -440,6 +452,14 @@ export declare const makeEvDateFieldProps: <Defaults extends {
         type: PropType<unknown extends Defaults["clearable"] ? boolean : boolean | Defaults["clearable"]>;
         default: unknown extends Defaults["clearable"] ? boolean : boolean | Defaults["clearable"];
     };
+    dataFormType: unknown extends Defaults["dataFormType"] ? StringConstructor : {
+        type: PropType<unknown extends Defaults["dataFormType"] ? string : string | Defaults["dataFormType"]>;
+        default: unknown extends Defaults["dataFormType"] ? string : string | Defaults["dataFormType"];
+    };
+    autocomplete: unknown extends Defaults["autocomplete"] ? PropType<string> : {
+        type: PropType<unknown extends Defaults["autocomplete"] ? string : string | Defaults["autocomplete"]>;
+        default: unknown extends Defaults["autocomplete"] ? string : string | Defaults["autocomplete"];
+    };
 };
 
 declare type SelectionModeProp = "single" | "multiple" | "range";
@@ -474,16 +494,6 @@ declare type Validator = ValidationResult | PromiseLike<ValidationResult> | ((va
 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;
 }
@@ -503,3 +513,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/EvDatePicker.d.ts

@@ -132,16 +132,6 @@ declare type SelectionModeProp = "single" | "multiple" | "range";
 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;
 }
@@ -161,3 +151,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/EvDatePickerMonth.d.ts

@@ -134,16 +134,6 @@ export declare type SelectionModeProp = "single" | "multiple" | "range";
 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;
 }
@@ -163,3 +153,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/EvDatePickerMonths.d.ts

@@ -28,16 +28,6 @@ export declare const makeEvDatePickerMonthsProps: <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;
 }
@@ -57,3 +47,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>;
+}
+