@stonecrop/aform 0.3.4 → 0.3.6

package/dist/aform.d.ts

@@ -7,7 +7,7 @@ import AFieldset from './components/form/AFieldset.vue';
 import AFileAttach from './components/form/AFileAttach.vue';
 import AForm from './components/AForm.vue';
 import ANumericInput from './components/form/ANumericInput.vue';
-import { App } from 'vue';
+import type { App } from 'vue';
 import ATextInput from './components/form/ATextInput.vue';
 import Login from './components/utilities/Login.vue';
 
@@ -32,13 +32,30 @@ export { ANumericInput }
 export { ATextInput }
 
 /**
- * Base schemda for AForm components
- * @beta
+ * Basic field structure for AForm schemas
+ * @public
  */
-export declare type BasicSchema = {
-    component: string;
+export declare type BaseSchema = {
+    /**
+     * The fieldname for the schema field
+     * @public
+     */
     fieldname: string;
-    value: any;
+    /**
+     * The component to render
+     *
+     * @remarks
+     * This must be a string that represents the component to render. The registration of the component
+     * should be done in the main application.
+     *
+     * @public
+     */
+    component?: string;
+    /**
+     * A placeholder value for the field
+     * @beta
+     */
+    value?: any;
 };
 
 /**
@@ -54,26 +71,77 @@ export declare type CellContext = {
 };
 
 /**
- * Fieldset schema
- * @beta
+ * Schema structure for defining fieldsets inside AForm
+ * @public
  */
-export declare type FieldsetSchema = BasicSchema & {
-    label: string;
-    schema: (FormSchema | TableSchema)[];
+export declare type FieldsetSchema = BaseSchema & {
+    /**
+     * The label to display in the fieldset
+     * @public
+     */
+    label?: string;
+    /**
+     * The schemas to be rendered inside the fieldset
+     * @public
+     */
+    schema?: (FormSchema | TableSchema)[];
+    /**
+     * Indicate whether the fieldset is collapsible
+     * @public
+     */
     collapsible?: boolean;
 };
 
 /**
- * Form schema
- * @beta
+ * Schema structure for defining forms inside AForm
+ * @public
  */
-export declare type FormSchema = BasicSchema & {
-    align: string;
-    edit: boolean;
-    fieldtype: string;
-    label: string;
-    name: string;
-    width: string;
+export declare type FormSchema = BaseSchema & {
+    /**
+     * Align the field in the form
+     * @beta
+     */
+    align?: string;
+    /**
+     * Indicate whether the field is editable
+     * @beta
+     */
+    edit?: boolean;
+    /**
+     * The field type for the schema field
+     *
+     * @remarks
+     * This must be a string that represents the field type. A mask string will be automatically
+     * applied for the following field types:
+     * - Date ('##/##/####')
+     * - Datetime ('####/##/## ##:##')
+     * - Time ('##:##')
+     * - Fulltime ('##:##:##')
+     * - Phone ('(###) ### - ####')
+     * - Card ('#### #### #### ####')
+     *
+     * @public
+     */
+    fieldtype?: string;
+    /**
+     * The label to display in the form
+     * @public
+     */
+    label?: string;
+    /**
+     * The unique identifier for the field
+     * @beta
+     */
+    name?: string;
+    /**
+     * The width of the field element.
+     * @beta
+     */
+    width?: string;
+    /**
+     * The mask string for the field
+     * @beta
+     */
     mask?: string;
 };
 
@@ -87,8 +155,8 @@ export declare function install(app: App): void;
 export { Login }
 
 /**
- * Superset of schema types
- * @beta
+ * Superset of all schema types for AForm
+ * @public
  */
 export declare type SchemaTypes = FormSchema | TableSchema | FieldsetSchema;
 
@@ -153,13 +221,25 @@ export declare type TableRow = {
 };
 
 /**
- * Table schema
- * @beta
+ * Schema structure for defining tables inside AForm
+ * @public
  */
-export declare type TableSchema = BasicSchema & {
-    columns: TableColumn[];
-    config: TableConfig;
-    rows: TableRow[];
+export declare type TableSchema = BaseSchema & {
+    /**
+     * The columns to display in the table
+     * @public
+     */
+    columns?: TableColumn[];
+    /**
+     * The configuration for the table
+     * @public
+     */
+    config?: TableConfig;
+    /**
+     * The rows to display in the table
+     * @public
+     */
+    rows?: TableRow[];
 };
 
 export { }