@stonecrop/aform 0.2.64 → 0.2.66

package/dist/aform.d.ts

@@ -1,20 +1,15 @@
-import ACheckbox from '@/components/form/ACheckbox.vue';
-import AComboBox from '@/components/form/AComboBox.vue';
-import ADate from '@/components/form/ADate.vue';
-import ADatePicker from '@/components/form/ADatePicker.vue';
-import ADropdown from '@/components/form/ADropdown.vue';
-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 ACheckbox from './components/form/ACheckbox.vue';
+import AComboBox from './components/form/AComboBox.vue';
+import ADate from './components/form/ADate.vue';
+import ADatePicker from './components/form/ADatePicker.vue';
+import ADropdown from './components/form/ADropdown.vue';
+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 ATextInput from '@/components/form/ATextInput.vue';
-import { BasicSchema } from '@/types';
-import { FieldsetSchema } from '@/types';
-import { FormSchema } from '@/types';
-import Login from '@/components/utilities/Login.vue';
-import { SchemaTypes } from '@/types';
-import { TableSchema } from '@/types';
+import ATextInput from './components/form/ATextInput.vue';
+import Login from './components/utilities/Login.vue';
 
 export { ACheckbox }
 
@@ -36,11 +31,51 @@ export { ANumericInput }
 
 export { ATextInput }
 
-export { BasicSchema }
+/**
+ * Base schemda for AForm components
+ * @beta
+ */
+export declare type BasicSchema = {
+    component: string;
+    fieldname: string;
+    value: any;
+};
 
-export { FieldsetSchema }
+/**
+ * Table cell context definition.
+ * @public
+ */
+declare type CellContext = {
+    row: TableRow;
+    column: TableColumn;
+    table: {
+        [key: string]: any;
+    };
+};
+
+/**
+ * Fieldset schema
+ * @beta
+ */
+export declare type FieldsetSchema = BasicSchema & {
+    label: string;
+    schema: (FormSchema | TableSchema)[];
+    collapsible?: boolean;
+};
 
-export { FormSchema }
+/**
+ * Form schema
+ * @beta
+ */
+export declare type FormSchema = BasicSchema & {
+    align: string;
+    edit: boolean;
+    fieldtype: string;
+    label: string;
+    name: string;
+    width: string;
+    mask?: string;
+};
 
 /**
  * Install all AForm components
@@ -51,8 +86,66 @@ export declare function install(app: App): void;
 
 export { Login }
 
-export { SchemaTypes }
+/**
+ * Superset of schema types
+ * @public
+ */
+export declare type SchemaTypes = FormSchema | TableSchema | FieldsetSchema;
 
-export { TableSchema }
+/**
+ * Table column definition.
+ * @public
+ */
+declare type TableColumn = {
+    name: string;
+    align?: CanvasTextAlign;
+    edit?: boolean;
+    label?: string;
+    type?: string;
+    width?: string;
+    pinned?: boolean;
+    cellComponent?: string;
+    cellComponentProps?: Record<string, any>;
+    modalComponent?: string | ((context?: CellContext) => string);
+    modalComponentExtraProps?: Record<string, any>;
+    format?: string | ((value: any, context?: CellContext) => string);
+    mask?: (value: any) => any;
+};
+
+/**
+ * Table configuration definition.
+ * @public
+ */
+declare type TableConfig = {
+    /**
+     * The type of view to display the table in. Possible values:
+     * - `uncounted` - row numbers are not displayed in the table
+     * - `list` - row numbers are displayed in the table
+     * - `list-expansion` - carets are displayed in the number column that expand/collapse the row inline
+     * - `tree` - carets are displayed in the number column that expand/collapse grouped rows
+     */
+    view?: 'uncounted' | 'list' | 'list-expansion' | 'tree';
+    fullWidth?: boolean;
+};
+
+/**
+ * Table row definition.
+ * @public
+ */
+declare type TableRow = {
+    [key: string]: any;
+    indent?: number;
+    parent?: number;
+};
+
+/**
+ * Table schema
+ * @beta
+ */
+export declare type TableSchema = BasicSchema & {
+    columns: TableColumn[];
+    config: TableConfig;
+    rows: TableRow[];
+};
 
 export { }