@evance/evance-ui 1.0.35 → 1.0.36

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
  */
@@ -437,16 +624,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;
 }
@@ -466,3 +643,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/EvToolbar.d.ts

@@ -240,16 +240,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;
 }
@@ -269,3 +259,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/EvTooltip.d.ts

@@ -810,16 +810,6 @@ declare type VerticalSide = "top" | "bottom";
 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;
 }
@@ -839,3 +829,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/EvTransitionExpand.d.ts

@@ -11,16 +11,6 @@ export declare type EvTransitionExpandX = FunctionalComponent<typeof EvTransitio
 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;
 }
@@ -40,3 +30,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/EvTransitionExpandX.d.ts

@@ -11,16 +11,6 @@ export declare type EvTransitionExpandX = FunctionalComponent<typeof EvTransitio
 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;
 }
@@ -40,3 +30,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/EvVirtualScroll.d.ts

@@ -188,16 +188,6 @@ export declare const makeEvVirtualScrollProps: <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;
 }
@@ -217,3 +207,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/EvWindow.d.ts

@@ -510,16 +510,6 @@ export declare type WindowProvide = {
 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;
 }
@@ -539,3 +529,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/EvWindowItem.d.ts

@@ -142,16 +142,6 @@ export declare const makeEvWindowItemProps: <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;
 }
@@ -171,3 +161,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/icons/brand.d.ts

@@ -1,16 +1,6 @@
 export * from './brand/index'
 
 
-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;
 }
@@ -30,3 +20,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/icons/editor.d.ts

@@ -1,16 +1,6 @@
 export * from './editor/index'
 
 
-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;
 }
@@ -30,3 +20,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/icons.d.ts

@@ -791,16 +791,6 @@ export { ZipArchiveIcon }
 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;
 }
@@ -820,3 +810,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/index.d.ts

@@ -2496,9 +2496,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, {
@@ -8050,9 +8048,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, {
@@ -8773,9 +8769,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, {
@@ -9443,9 +9437,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, {
@@ -9566,9 +9558,7 @@ default: string;
 };
 monospace: BooleanConstructor;
 }, {
-reset: () => void;
-resetValidation: () => void;
-validate: (silent?: boolean) => Promise<string[]>;
+field: FormField;
 input: Ref<HTMLInputElement>;
 focus: () => void;
 }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
@@ -10366,6 +10356,10 @@ export declare type FontWeight = "regular" | "medium" | "semibold" | "bold";
 
 /**
  * # 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;
@@ -10386,20 +10380,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
@@ -10438,6 +10418,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;
@@ -10501,14 +10484,6 @@ declare class FormField {
      * @param e
      */
     blur(): void;
-    /**
-     * ## Expose
-     */
-    expose(): {
-        reset: () => void;
-        resetValidation: () => void;
-        validate: (silent?: boolean) => Promise<string[]>;
-    };
     /**
      * ## Focus
      *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@evance/evance-ui",
-    "version": "1.0.35",
+    "version": "1.0.36",
     "description": "Evance UI Component Library based on Vuetify",
     "private": false,
     "author": "Geoff Willings <geoff@evance.io>",

package/dist/cjs/ArrowBackIcon-CyUpY267.cjs

@@ -1,19 +0,0 @@
-"use strict";
-/*! Evance UI v1.0.35 | MIT License */
-const vue = require("vue");
-const _hoisted_1 = {
-  width: "24",
-  height: "24",
-  viewBox: "0 0 24 24",
-  fill: "currentColor"
-};
-const _hoisted_2 = /* @__PURE__ */ vue.createElementVNode("path", { d: "M12 6L13.414 7.414L9.828 11H18V13H9.828L13.414 16.586L12 18L6 12L12 6Z" }, null, -1);
-const _hoisted_3 = [
-  _hoisted_2
-];
-function render(_ctx, _cache) {
-  return vue.openBlock(), vue.createElementBlock("svg", _hoisted_1, _hoisted_3);
-}
-const ArrowBackIcon = { render };
-exports.ArrowBackIcon = ArrowBackIcon;
-//# sourceMappingURL=ArrowBackIcon-CyUpY267.cjs.map

package/dist/cjs/ArrowBackIcon-CyUpY267.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"ArrowBackIcon-CyUpY267.cjs","sources":["../../src/icons/glyph/ArrowBackIcon.svg"],"sourcesContent":["import { createElementVNode as _createElementVNode, openBlock as _openBlock, createElementBlock as _createElementBlock } from \"vue\"\n\nconst _hoisted_1 = {\n  width: \"24\",\n  height: \"24\",\n  viewBox: \"0 0 24 24\",\n  fill: \"currentColor\"\n}\nconst _hoisted_2 = /*#__PURE__*/_createElementVNode(\"path\", { d: \"M12 6L13.414 7.414L9.828 11H18V13H9.828L13.414 16.586L12 18L6 12L12 6Z\" }, null, -1)\nconst _hoisted_3 = [\n  _hoisted_2\n]\n\nexport function render(_ctx, _cache) {\n  return (_openBlock(), _createElementBlock(\"svg\", _hoisted_1, _hoisted_3))\n}\nexport default { render: render }"],"names":["_createElementVNode","_openBlock","_createElementBlock"],"mappings":";;;AAEA,MAAM,aAAa;AAAA,EACjB,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,MAAM;AACR;AACA,MAAM,aAA0BA,oBAAmB,mBAAC,QAAQ,EAAE,GAAG,yEAAwE,GAAI,MAAM,EAAE;AACrJ,MAAM,aAAa;AAAA,EACjB;AACF;AAEO,SAAS,OAAO,MAAM,QAAQ;AACnC,SAAQC,IAAU,UAAA,GAAIC,IAAAA,mBAAoB,OAAO,YAAY,UAAU;AACzE;AACA,MAAe,gBAAA,EAAE,OAAc;;"}