@evance/evance-ui 1.0.35 → 1.0.36

package/dist/types/EvRadio.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';
 
@@ -38,9 +39,7 @@ hint: StringConstructor;
 clearable: BooleanConstructor;
 value: any;
 }, {
-reset: () => void;
-resetValidation: () => void;
-validate: (silent?: boolean) => Promise<string[]>;
+field: FormField;
 input: Ref<HTMLInputElement>;
 focus: () => void;
 }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
@@ -87,6 +86,184 @@ clearable: 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"];
+}
+
 export declare const makeEvRadioProps: <Defaults extends {
     class?: unknown;
     style?: unknown;
@@ -197,6 +374,16 @@ export declare const makeEvRadioProps: <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
  */
@@ -210,16 +397,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;
 }
@@ -239,3 +416,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/EvRadioGroup.d.ts

@@ -86,6 +86,10 @@ export declare const EvRadioGroupSymbol: InjectionKey<EvRadioGroupContext>;
 
 /**
  * # 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;
@@ -106,20 +110,6 @@ declare class Form {
      * @param field
      */
     addField(field: FormField): void;
-    /**
-     * ## Expose
-     */
-    expose(): {
-        addErrors: (errors: ValidationError[]) => void;
-        getField: (name: string) => FormField;
-        reset: () => void;
-        resetValidation: () => void;
-        validate: () => Promise<{
-            valid: boolean;
-            errors: ValidationError[];
-            addErrors: (errors: ValidationError[]) => void;
-        }>;
-    };
     /**
      * ## Get Field
      * @param name
@@ -158,6 +148,9 @@ declare class Form {
 
 /**
  * # 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;
@@ -221,14 +214,6 @@ declare class FormField {
      * @param e
      */
     blur(): void;
-    /**
-     * ## Expose
-     */
-    expose(): {
-        reset: () => void;
-        resetValidation: () => void;
-        validate: (silent?: boolean) => Promise<string[]>;
-    };
     /**
      * ## Focus
      *
@@ -402,16 +387,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;
 }
@@ -431,3 +406,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/EvResponsive.d.ts

@@ -168,16 +168,6 @@ export declare function useAspectStyles(props: AspectRatioProps): {
 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;
 }
@@ -197,3 +187,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/EvSection.d.ts

@@ -82,16 +82,6 @@ export declare const makeEvSectionProps: <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/EvSelect.d.ts

@@ -807,16 +807,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;
 }
@@ -836,3 +826,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/EvSlideGroup.d.ts

@@ -379,16 +379,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;
 }
@@ -408,3 +398,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/EvSlideGroupItem.d.ts

@@ -379,16 +379,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;
 }
@@ -408,3 +398,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/EvSpacer.d.ts

@@ -57,16 +57,6 @@ export declare const makeEvSpacerProps: <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;
 }
@@ -86,3 +76,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/EvSurface.d.ts

@@ -194,16 +194,6 @@ export declare type SurfaceElevation = "default" | "panel" | "overlay" | "sunken
 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;
 }
@@ -223,3 +213,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/EvSwatch.d.ts

@@ -46,16 +46,6 @@ export declare const makeEvSwatchProps: <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;
 }
@@ -75,3 +65,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>;
+}
+