@vtj/ui 0.0.6 → 0.4.1

package/types/components/form/form.d.ts

@@ -0,0 +1,384 @@
+import { FormItemRule } from 'element-plus';
+import { EpPropFinalized, EpPropMergeType, Arrayable } from 'element-plus/es/utils';
+import { VNode, RendererNode, RendererElement, DefineComponent, ComputedOptions, MethodOptions, ComponentOptionsMixin, VNodeProps, AllowedComponentProps, ComponentCustomProps, PropType, ExtractPropTypes, InjectionKey } from 'vue';
+import { BlockDirection, BlockWrap, BlockOverflow, FieldSetter, HelpType, IconSize, IconParam, UseDraggableOptions, UseResizableOptions, ToolbarItem, Emits, FieldProps } from '../..';
+import type Form from './Form.vue';
+export declare const formContextKey: InjectionKey<FormInstance>;
+export type FormField = Partial<{
+    [index: string]: any;
+} & FieldProps>;
+/**
+ * 定义组件属性参数
+ */
+export declare const formProps: {
+    wrapper: {
+        type: PropType<Partial<ExtractPropTypes<{
+            position: {
+                type: PropType<"bottom" | "top" | "none">;
+                default: string;
+            };
+            fixed: {
+                type: PropType<Partial<ExtractPropTypes<{
+                    flex: {
+                        type: BooleanConstructor;
+                        default: boolean;
+                    };
+                    width: {
+                        type: (StringConstructor | NumberConstructor)[];
+                    };
+                    height: {
+                        type: (StringConstructor | NumberConstructor)[];
+                    };
+                    direction: {
+                        type: PropType<BlockDirection>;
+                        default: string;
+                    };
+                    grow: {
+                        type: BooleanConstructor;
+                        default: boolean;
+                    };
+                    shrink: {
+                        type: BooleanConstructor;
+                        default: boolean;
+                    };
+                    wrap: {
+                        type: PropType<BlockWrap>;
+                        default: string;
+                    };
+                    justify: {
+                        type: StringConstructor;
+                        default: string;
+                    };
+                    align: {
+                        type: StringConstructor;
+                        default: string;
+                    };
+                    border: {
+                        type: BooleanConstructor;
+                    };
+                    radius: {
+                        type: BooleanConstructor;
+                    };
+                    background: {
+                        type: BooleanConstructor;
+                    };
+                    split: {
+                        type: BooleanConstructor;
+                    };
+                    fit: {
+                        type: BooleanConstructor;
+                    };
+                    overflow: {
+                        type: PropType<BlockOverflow>;
+                        default: string;
+                    };
+                    padding: {
+                        type: BooleanConstructor;
+                        default: boolean;
+                    };
+                }>>>;
+            };
+            body: {
+                type: PropType<Partial<ExtractPropTypes<{
+                    flex: {
+                        type: BooleanConstructor;
+                        default: boolean;
+                    };
+                    width: {
+                        type: (StringConstructor | NumberConstructor)[];
+                    };
+                    height: {
+                        type: (StringConstructor | NumberConstructor)[];
+                    };
+                    direction: {
+                        type: PropType<BlockDirection>;
+                        default: string;
+                    };
+                    grow: {
+                        type: BooleanConstructor;
+                        default: boolean;
+                    };
+                    shrink: {
+                        type: BooleanConstructor;
+                        default: boolean;
+                    };
+                    wrap: {
+                        type: PropType<BlockWrap>;
+                        default: string;
+                    };
+                    justify: {
+                        type: StringConstructor;
+                        default: string;
+                    };
+                    align: {
+                        type: StringConstructor;
+                        default: string;
+                    };
+                    border: {
+                        type: BooleanConstructor;
+                    };
+                    radius: {
+                        type: BooleanConstructor;
+                    };
+                    background: {
+                        type: BooleanConstructor;
+                    };
+                    split: {
+                        type: BooleanConstructor;
+                    };
+                    fit: {
+                        type: BooleanConstructor;
+                    };
+                    overflow: {
+                        type: PropType<BlockOverflow>;
+                        default: string;
+                    };
+                    padding: {
+                        type: BooleanConstructor;
+                        default: boolean;
+                    };
+                }>>>;
+            }; /**
+             * 定义组件属性参数
+             */
+        }>>>;
+    };
+    fixed: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    submitText: {
+        type: StringConstructor;
+        default: string;
+    };
+    resetText: {
+        type: StringConstructor;
+        default: string;
+    };
+    fields: {
+        type: PropType<Partial<{
+            [index: string]: any;
+        } & Partial<ExtractPropTypes<{
+            prop: {
+                type: StringConstructor;
+            };
+            iconStyle: {
+                type: PropType<Record<string, any>>;
+            };
+            setter: {
+                type: PropType<string | VNode<RendererNode, RendererElement, {
+                    [key: string]: any;
+                }> | FieldSetter>;
+            };
+            modelValue: {
+                type: PropType<any>;
+                default: string;
+            };
+            width: {
+                type: StringConstructor;
+            };
+            help: {
+                type: PropType<Partial<ExtractPropTypes<{
+                    type: {
+                        type: PropType<HelpType>;
+                        default: string;
+                    };
+                    icon: {
+                        type: PropType<Partial<ExtractPropTypes<{
+                            icon: {
+                                type: PropType<string | object | VNode<RendererNode, RendererElement, {
+                                    [key: string]: any;
+                                }>>;
+                            };
+                            color: {
+                                type: StringConstructor;
+                            };
+                            size: {
+                                type: PropType<IconSize>;
+                                default: string;
+                            };
+                            src: {
+                                type: StringConstructor;
+                            };
+                            disabled: {
+                                type: BooleanConstructor;
+                            };
+                        }>>>;
+                        default: () => {
+                            icon: DefineComponent<{}, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{}>>, {}>;
+                        };
+                    };
+                    tooltip: {
+                        type: StringConstructor;
+                    };
+                    url: {
+                        type: StringConstructor;
+                    };
+                    openType: {
+                        type: StringConstructor;
+                        default: string;
+                    };
+                    dialog: {
+                        type: PropType<Partial<ExtractPropTypes<{
+                            modelValue: {
+                                type: BooleanConstructor;
+                                default: boolean;
+                            };
+                            width: {
+                                type: (StringConstructor | NumberConstructor)[];
+                                default: string;
+                            };
+                            height: {
+                                type: (StringConstructor | NumberConstructor)[];
+                                default: string;
+                            };
+                            autoFit: {
+                                type: BooleanConstructor;
+                                default: boolean;
+                            };
+                            modal: {
+                                type: BooleanConstructor;
+                                default: boolean;
+                            };
+                            title: {
+                                type: StringConstructor;
+                                default: string;
+                            };
+                            icon: {
+                                type: PropType<IconParam>;
+                            };
+                            small: {
+                                type: BooleanConstructor;
+                            };
+                            draggable: {
+                                type: PropType<boolean | UseDraggableOptions>;
+                                default: boolean;
+                            };
+                            resizable: {
+                                type: PropType<boolean | UseResizableOptions>;
+                                default: boolean;
+                            };
+                            footer: {
+                                type: BooleanConstructor;
+                                default: boolean;
+                            };
+                            closable: {
+                                type: BooleanConstructor;
+                                default: boolean;
+                            };
+                            maximizable: {
+                                type: BooleanConstructor;
+                                default: boolean;
+                            };
+                            minimizable: {
+                                type: BooleanConstructor;
+                                default: boolean;
+                            };
+                            tools: {
+                                type: PropType<ToolbarItem[]>;
+                                default: () => never[];
+                            };
+                            closeOnClickModal: {
+                                type: BooleanConstructor;
+                            };
+                            confirmText: {
+                                type: PropType<string | false>;
+                                default: string;
+                            };
+                            confirm: {
+                                type: PropType<() => Promise<boolean>>;
+                            };
+                            cancelText: {
+                                type: PropType<string | false>;
+                                default: string;
+                            };
+                            cancel: {
+                                type: PropType<() => Promise<boolean>>;
+                            };
+                            beforeClose: {
+                                type: PropType<() => Promise<boolean>>;
+                            };
+                            src: {
+                                type: StringConstructor;
+                            };
+                            content: {
+                                type: PropType<VNode<RendererNode, RendererElement, {
+                                    [key: string]: any;
+                                }> | DefineComponent>;
+                            };
+                            zIndex: {
+                                type: NumberConstructor;
+                                default(): number;
+                            };
+                            bodyPadding: {
+                                type: BooleanConstructor;
+                                default: boolean;
+                            };
+                            theme: {
+                                type: PropType<"default" | "newpearl">;
+                                default: string;
+                            };
+                        }>>>;
+                    };
+                }>>>;
+            };
+            label: StringConstructor;
+            labelWidth: EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
+            required: EpPropFinalized<BooleanConstructor, unknown, unknown, undefined, boolean>;
+            rules: {
+                readonly type: PropType<EpPropMergeType<(new (...args: any[]) => FormItemRule | FormItemRule[]) | (() => Arrayable<FormItemRule>) | ((new (...args: any[]) => FormItemRule | FormItemRule[]) | (() => Arrayable<FormItemRule>))[], unknown, unknown>>;
+                readonly required: false;
+                readonly validator: ((val: unknown) => boolean) | undefined;
+                __epPropKey: true;
+            };
+            error: StringConstructor;
+            validateStatus: {
+                readonly type: PropType<EpPropMergeType<StringConstructor, "" | "success" | "error" | "validating", unknown>>;
+                readonly required: false;
+                readonly validator: ((val: unknown) => boolean) | undefined;
+                __epPropKey: true;
+            };
+            for: StringConstructor;
+            inlineMessage: EpPropFinalized<readonly [StringConstructor, BooleanConstructor], unknown, unknown, "", boolean>;
+            showMessage: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+            size: {
+                readonly type: PropType<EpPropMergeType<StringConstructor, "" | "default" | "small" | "large", unknown>>;
+                readonly required: false;
+                readonly validator: ((val: unknown) => boolean) | undefined;
+                __epPropKey: true;
+            };
+        }>>>[]>;
+    };
+    model: {
+        type: PropType<Record<string, any>>;
+    };
+    submiting: {
+        type: BooleanConstructor;
+    };
+    submit: {
+        type: PropType<(model: any) => Promise<any>>;
+    };
+    fieldWidth: {
+        type: StringConstructor;
+    };
+    labelWidth: {
+        type: StringConstructor;
+    };
+};
+/**
+ * 定义组件事件
+ */
+export declare const formEmits: {
+    submit: (model: any) => boolean;
+    error: (err: any) => boolean;
+    reset: () => boolean;
+};
+/**
+ * 组件属性类型
+ */
+export type FormProps = Partial<ExtractPropTypes<typeof formProps>>;
+/**
+ * 组件事件类型
+ */
+export type FormEmits = Emits<typeof formEmits>;
+export type FormInstance = InstanceType<typeof Form>;