@unizhen/ui 0.0.1

package/lib/components/form/interface.d.ts

@@ -0,0 +1,262 @@
+import { Fn, ObjectKey } from '../interface';
+import { VNodeChild } from 'vue';
+import { SelectGroupOption } from 'naive-ui';
+type SelectOption = any;
+export interface IQxDataTableColumnType {
+    type?: 'selection' | 'expand';
+    multiple?: boolean;
+    options: string[];
+}
+export type SelectMixedOption = SelectOption | SelectGroupOption;
+type InternalRowData = Record<string, unknown>;
+type RuleType = 'string' | 'number' | 'boolean' | 'method' | 'regexp' | 'integer' | 'float' | 'array' | 'object' | 'enum' | 'date' | 'url' | 'hex' | 'email' | 'pattern' | 'any';
+type RuleTrigger = 'input' | 'change' | 'blur' | 'focus';
+export interface IForm {
+    input?: string;
+    label?: string | (() => string);
+    key?: string;
+    defaultValue?: string;
+    span: number;
+    show: boolean;
+    disabled: boolean;
+    readonly: boolean;
+    updateValue: string | Fn;
+    createButton: boolean;
+    backfill: boolean;
+    rule: {
+        required: boolean;
+        type: RuleType;
+        message: string;
+        trigger: RuleTrigger | Array<RuleTrigger>;
+        validator: string | Fn;
+    };
+    create: {
+        show: boolean;
+        disabled: boolean;
+        readonly: boolean;
+    };
+    edit: {
+        show: boolean;
+        disabled: boolean;
+        readonly: boolean;
+    };
+}
+export interface ISearch {
+    show: boolean;
+    fuzzy: boolean;
+    defaultValue?: string;
+    source?: string;
+    type?: string;
+    labelKeys?: string;
+    valueKey?: string;
+    multiple: boolean;
+    tab: boolean;
+}
+export interface ITable<T = InternalRowData> {
+    align: 'left' | 'right' | 'center' | null;
+    titleAlign: 'left' | 'right' | 'center' | null;
+    fixed: 'left' | 'right' | false | null;
+    width: number | string | null;
+    resizable: boolean;
+    hide: boolean;
+    sorter: boolean;
+    show: boolean;
+    mobile: boolean;
+    lineBreak: boolean;
+    lineCol: number;
+    clamp: number;
+    ellipsis: boolean | {
+        tooltip: boolean;
+        'line-clamp': number | string;
+    };
+    render: string | ((rowData: T, rowIndex: number) => VNodeChild);
+}
+export interface IQxFormItemBase {
+    label: string | (() => string);
+    key: string;
+    dbType: string;
+    unique: number;
+    fieldValueRule?: string;
+    source: string;
+    sourceFn: string;
+    table: ITable;
+    form: IForm;
+    search: ISearch;
+}
+export interface IQxFormItemGroup extends IQxFormItemBase {
+    input: 'group';
+    params: {
+        placeholder: '';
+        children: IQxFormItem[];
+    };
+}
+export interface IQxFormItemInput extends IQxFormItemBase {
+    input: 'input';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        type: 'text' | 'password' | 'textarea';
+        minlength?: number | null;
+        maxlength?: number | null;
+        rows?: number | null;
+        prefix?: string;
+        suffix?: string;
+    };
+}
+export interface IQxFormItemAuto extends IQxFormItemBase {
+    input: 'auto';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        options: (() => Promise<any[]>) | any[];
+        type: 'text' | 'password' | 'textarea';
+        minlength?: number | null;
+        maxlength?: number | null;
+        rows?: number | null;
+        prefix?: string;
+        suffix?: string;
+    };
+}
+export interface IQxFormItemNumber extends IQxFormItemBase {
+    input: 'number';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        showButton?: boolean;
+        min?: number | null;
+        max?: number | null;
+        minKey?: string;
+        maxKey?: string;
+        step?: number | null;
+        precision?: number | null;
+        prefix?: string;
+        suffix?: string;
+    };
+}
+export interface IQxFormItemDatePicker extends IQxFormItemBase {
+    input: 'date';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        type: 'date' | 'datetime' | 'daterange' | 'datetimerange' | 'month' | 'monthrange' | 'year' | 'yearrange' | 'quarter' | 'quarterrange' | 'week';
+        format?: string;
+        isDateDisabled?: ((ts: number, detail: ObjectKey) => boolean) | string;
+        timePickerProps?: {
+            format?: string;
+            use12Hours?: boolean;
+            isHourDisabled?: (hour: number) => boolean;
+            isMinuteDisabled?: (minute: number, hour: number | null) => boolean;
+            isSecondDisabled?: (second: number, minute: number | null, hour: number | null) => boolean;
+        };
+    };
+}
+export interface IQxFormItemSelect extends IQxFormItemBase {
+    input: 'select';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        options: (() => Promise<any[]>) | any[];
+        filterable?: boolean;
+        multiple?: boolean;
+        tag?: boolean;
+        labelKeys?: string;
+        valueKey?: string;
+        renderLabel?: (option: ObjectKey, selected: boolean) => VNodeChild;
+        renderTag?: (props: {
+            option: ObjectKey;
+            handleClose: () => void;
+        }) => VNodeChild;
+    };
+}
+export interface IQxFormItemCascader extends IQxFormItemBase {
+    input: 'cascader';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        options: (() => Promise<any[]>) | any[];
+        filterable?: boolean;
+        multiple?: boolean;
+    };
+}
+export interface IQxFormItemColor extends IQxFormItemBase {
+    input: 'color';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+    };
+}
+export interface IQxFormItemCheckbox extends IQxFormItemBase {
+    input: 'checkbox';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        options: (() => Promise<Array<ObjectKey>>) | Array<ObjectKey>;
+    };
+}
+export interface IQxFormItemTime extends IQxFormItemBase {
+    input: 'time';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        format?: string;
+    };
+}
+export interface IQxFormItemUpload extends IQxFormItemBase {
+    input: 'upload';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        small?: boolean;
+        accept?: string;
+        max?: number | null;
+    };
+}
+export interface IQxFormItemSwitch extends IQxFormItemBase {
+    input: 'switch';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        checked?: string;
+        unchecked?: string;
+    };
+}
+export interface IQxFormItemDivider extends IQxFormItemBase {
+    input: 'divider';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        placement: 'left' | 'right' | 'center';
+    };
+}
+export interface IQxFormItemFilling extends IQxFormItemBase {
+    input: 'filling';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        parentKey: string;
+    };
+}
+export interface IQxFormItemSubTable extends IQxFormItemBase {
+    input: 'subTable';
+    params: {
+        placeholder: string;
+        clearable: boolean;
+        init: boolean;
+        quest: boolean;
+        draggable: boolean;
+        childActions: boolean;
+        showDelete: boolean;
+        searchKey: string;
+        link: string;
+        columns: any[];
+        actions: any[];
+        addButton: boolean;
+        optionsType?: string;
+        options?: string;
+        summary?: string | ((pageData: any) => any);
+        deleteFn?: string;
+    };
+}
+export type IQxFormItem = IQxFormItemGroup | IQxFormItemInput | IQxFormItemAuto | IQxFormItemNumber | IQxFormItemDatePicker | IQxFormItemSelect | IQxFormItemCascader | IQxFormItemTime | IQxFormItemColor | IQxFormItemSwitch | IQxFormItemUpload | IQxFormItemDivider | IQxFormItemCheckbox | IQxFormItemSubTable | IQxFormItemFilling;
+export type IQxFormItems = IQxFormItem[];
+export {};