@uniquedj95/vform 1.3.0 → 1.4.0

package/dist/types/index.d.ts

@@ -12,33 +12,186 @@ export interface GridSize {
     lg?: string;
     xl?: string;
 }
+/**
+ * Represents a form field with various properties to define its behavior and appearance.
+ *
+ * @interface FormField
+ */
 export interface FormField {
+    /**
+     * The current value of the form input field.
+     *
+     * @type FormValue
+     */
     value?: FormValue;
+    /**
+     * The type of input for the form input field.
+     *
+     * @type InputType
+     */
     type: InputType;
+    /**
+     * The label for the form input field.
+     *
+     * @type string
+     */
     label?: string;
+    /**
+     * Indicates if the form input field is required.
+     *
+     * @type boolean
+     */
     required?: boolean;
+    /**
+     * Options for select-type form input fields.
+     *
+     * @type FormOptions
+     */
     options?: FormOptions;
+    /**
+     * Indicates if multiple selections are allowed.
+     *
+     * @type boolean
+     */
     multiple?: boolean;
+    /**
+     * The minimum value or length for the form input field.
+     *
+     * @type number | string
+     */
     min?: number | string;
+    /**
+     * The maximum value or length for the form input field.
+     *
+     * @type number | string
+     */
     max?: number | string;
+    /**
+     * The number of columns for textarea-type form input fields.
+     *
+     * @type number
+     */
+    cols?: number;
+    /**
+     * The number of rows for textarea-type form input fields.
+     *
+     * @type number
+     */
+    rows?: number;
+    /**
+     * Indicates if a character counter should be displayed.
+     *
+     * @type boolean
+     */
     counter?: boolean;
+    /**
+     * The minimum length for the form input field.
+     *
+     * @type number
+     */
     minLength?: number;
+    /**
+     * The maximum length for the form input field.
+     *
+     * @type number
+     */
     maxLength?: number;
+    /**
+     * Indicates if the form input field is disabled.
+     *
+     * @type boolean
+     */
     disabled?: boolean;
+    /**
+     * Indicates if the form input field is read-only.
+     *
+     * @type boolean
+     */
     hidden?: boolean;
+    /**
+     * The size of the form input field.
+     *
+     * @type GridSize
+     */
     grid?: GridSize;
+    /**
+     * The placeholder text for the form input field.
+     *
+     * @type string
+     */
     placeholder?: string;
+    /**
+     * The icon for the form input field.
+     *
+     * @type string
+     */
     icon?: string;
+    /**
+     * The prefix for the form input field.
+     *
+     * @type string
+     */
     prefix?: string;
+    /**
+     * The suffix for the form input field.
+     *
+     * @type string
+     */
     suffix?: string;
+    /**
+     * The error message for the form input field.
+     *
+     * @type string
+     */
     error?: string;
+    /**
+     * The pattern for the form input field.
+     * If the pattern is not matched, an error message will be displayed.
+     *
+     * @type string
+     */
     pattern?: string;
+    /**
+     * Auto-focuses the form input field when the page loads.
+     *
+     * @type boolean
+     */
     autoFocus?: boolean;
+    /**
+     * Indicates if the form input field should be filled with a solid or outlined color.
+     *
+     * @type "solid" | "outline"
+     */
     fill?: "solid" | "outline";
+    /**
+     * The position of the label for the form input field.
+     *
+     * @type "stacked" | "start" | "end" | "fixed" | "floating"
+     */
     labelPlacement?: "stacked" | "start" | "end" | "fixed" | "floating";
+    /**
+     * The custom validation function for the form input field.
+     *
+     * @type FormValidator
+     */
     validation?: FormValidator;
+    /**
+     * The custom function for listening to changes in the form input field.
+     *
+     * @type ComputedValueHandler
+     */
     onChange?: (value: FormValue) => FormValue;
+    /**
+    * The custom function used for computing alternative values based on the current value of the form input field.
+    *
+    * @type ComputedValueHandler
+    */
     computedValue?: ComputedValueHandler;
+    /**
+     * The custom function for checking if the form input field should be displayed.
+     *
+     * @type (data: FormData, computedData: ComputedData) => boolean
+     */
     condition?: (data: FormData, computedData: ComputedData) => boolean;
 }
 export interface OptionDescription {
@@ -54,6 +207,13 @@ export interface Option {
     disabled?: boolean;
     description?: OptionDescription;
 }
-export type InputType = "TextInput" | "DateInput" | "NumberInput" | "EmailInput" | "PasswordInput" | "SelectInput";
+export type InputType = "TextInput" | "DateInput" | "NumberInput" | "EmailInput" | "PasswordInput" | "SelectInput" | "TextAreaInput";
 export type BaseFieldTypes = "text" | "password" | "email" | "number" | "tel" | "url" | "search" | "time" | "month" | "week";
+export interface CustomButton {
+    label: string;
+    icon: string;
+    fill?: "solid" | "outline";
+    color?: "primary" | "warning" | "danger" | "secondary" | "light";
+    action: () => void;
+}
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAC3E,MAAM,MAAM,aAAa,GAAG,CAC1B,KAAK,EAAE,SAAS,EAChB,MAAM,CAAC,EAAE,UAAU,KAChB,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;AAC1D,MAAM,MAAM,oBAAoB,GAAG,CACjC,KAAK,EAAE,SAAS,EAChB,MAAM,EAAE,UAAU,KACf,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;AACxB,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzE,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC,CAAC;AAC7D,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC/C,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAEnD,MAAM,WAAW,QAAQ;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,cAAc,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,UAAU,CAAC;IACpE,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,SAAS,CAAC;IAC3C,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,KAAK,OAAO,CAAC;CACrE;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,OAAO,CAAC;IAChE,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,iBAAiB,CAAC;CACjC;AAED,MAAM,MAAM,SAAS,GACjB,WAAW,GACX,WAAW,GACX,aAAa,GACb,YAAY,GACZ,eAAe,GACf,aAAa,CAAA;AAEjB,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,UAAU,GACV,OAAO,GACP,QAAQ,GACR,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,OAAO,GACP,MAAM,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAC3E,MAAM,MAAM,aAAa,GAAG,CAC1B,KAAK,EAAE,SAAS,EAChB,MAAM,CAAC,EAAE,UAAU,KAChB,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;AAC1D,MAAM,MAAM,oBAAoB,GAAG,CACjC,KAAK,EAAE,SAAS,EAChB,MAAM,EAAE,UAAU,KACf,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;AACxB,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzE,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC,CAAC;AAC7D,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC/C,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAEnD,MAAM,WAAW,QAAQ;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB;;;;OAIG;IACH,IAAI,EAAE,SAAS,CAAC;IAEhB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEtB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEtB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAEhB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,UAAU,CAAC;IAEpE;;;;OAIG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,SAAS,CAAC;IAE1C;;;;MAIE;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;IAErC;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,KAAK,OAAO,CAAC;CACrE;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,OAAO,CAAC;IAChE,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,iBAAiB,CAAC;CACjC;AAED,MAAM,MAAM,SAAS,GACjB,WAAW,GACX,WAAW,GACX,aAAa,GACb,YAAY,GACZ,eAAe,GACf,aAAa,GACb,eAAe,CAAA;AAEnB,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,UAAU,GACV,OAAO,GACP,QAAQ,GACR,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,OAAO,GACP,MAAM,CAAA;AAGV,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,OAAO,CAAC;IACjE,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@uniquedj95/vform",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "A simplified ionic vue desktop form builder",
   "type": "module",
   "main": "./dist/index.umd.js",
   "module": "./dist/index.es.js",
   "types": "./dist/index.d.ts",
-  "style": "./dist/index.css",
+  "style": "./dist/style.css",
   "files": [
     "dist"
   ],
@@ -16,7 +16,7 @@
       "require": "./dist/index.umd.js",
       "types": "./dist/index.d.ts"
     },
-    "./styles.css": "./dist/index.css"
+    "./styles.css": "./dist/style.css"
   },
   "scripts": {
     "build": "vite build",
@@ -37,10 +37,10 @@
     "typescript": "^5.5.3",
     "vite": "^5.3.3",
     "vite-plugin-dts": "^3.9.1",
-    "vue": "^3.4.31"
+    "vue": "^3.5.10"
   },
   "peerDependencies": {
-    "vue": "^3.4.31"
+    "vue": "^3.5.10"
   },
   "dependencies": {
     "@vuepic/vue-datepicker": "^9.0.1"