@flyto/farco 1.2.1 → 1.4.0

package/dist/types/components/fform/fform.d.ts

@@ -2,86 +2,86 @@ import { CSSProperties, ExtractPublicPropTypes, PropType } from 'vue';
 import { AnyObject } from '../../../../../../../../../src/types';
 import { GridItemProps, Form, GridProps } from '@arco-design/web-vue';
 import { FFormItemProps } from '../fform-item';
-
-export type FFormItemType<T = AnyObject> = FFormItemProps & {
-    /**
-     * 搭配 FForm 组件一起使用时，prop为必填项
-     */
-    prop: keyof T;
-    /**
-     * 扩展 slotName 字段，用于提供组件插槽
-     */
-    slotName?: string;
-    /**
-     * 行占比配置
-     */
-    gridItemProps?: GridItemProps;
-};
-export declare const fFormProps: {
-    /**
-     * 内容区域的class
-     */
-    contentClass: {
-        type: PropType<string | unknown[] | CSSProperties>;
-    };
-    /**
-     *  表单数据，传入此参数时，为受控模式
-     */
-    data: {
-        type: ObjectConstructor;
-        default: null;
-    };
-    /**
-     * 表单默认数据（非受控模式）
-     */
-    defaultData: {
-        type: ObjectConstructor;
-        default: null;
-    };
-    /**
-     * Arco Row组件属性
-     */
-    gridProps: {
-        type: PropType<GridProps & {
-            style?: CSSProperties | undefined;
-            class?: string | object | string[] | undefined;
-        }>;
-        default: () => {};
-    };
-    /**
-     * 统一设置每个FFormItem组件的GridItem属性，如果FFormItem有单独设置，则采用独立设置的值
-     * @value
-     *    number: 为Arco GridItem组件props中span值
-     *    Object: Arco GridItem组件的props
-     */
-    itemSpan: {
-        type: PropType<number | GridItemProps>;
-        default: () => {
-            span: {
-                xxl: number;
-                xl: number;
-                lg: number;
-                md: number;
-                sm: number;
-                xs: number;
-            };
-        };
-    };
-    /**
-     * 统一设置每个FFormItem组件标签的宽度
-     */
-    labelWidth: {
-        type: PropType<string | number>;
-        default: string;
-    };
-    /**
-     * formItem的渲染列表
-     * @value FFormItem 组件配置项列表
-     */
-    items: {
-        type: PropType<FFormItemType<AnyObject<any>>[]>;
-        default: () => never[];
-        required: boolean;
-    };
-};
-export type FFormProps = ExtractPublicPropTypes<typeof fFormProps> & Omit<InstanceType<typeof Form>['$props'], 'model'>;
+
+export type FFormItemType<T = AnyObject> = FFormItemProps & {
+    /**
+     * 搭配 FForm 组件一起使用时，prop为必填项
+     */
+    prop: keyof T;
+    /**
+     * 扩展 slotName 字段，用于提供组件插槽
+     */
+    slotName?: string;
+    /**
+     * 行占比配置
+     */
+    gridItemProps?: GridItemProps;
+};
+export declare const fFormProps: {
+    /**
+     * 内容区域的class
+     */
+    contentClass: {
+        type: PropType<string | unknown[] | CSSProperties>;
+    };
+    /**
+     *  表单数据，传入此参数时，为受控模式
+     */
+    data: {
+        type: ObjectConstructor;
+        default: null;
+    };
+    /**
+     * 表单默认数据（非受控模式）
+     */
+    defaultData: {
+        type: ObjectConstructor;
+        default: null;
+    };
+    /**
+     * Arco Row组件属性
+     */
+    gridProps: {
+        type: PropType<GridProps & {
+            style?: CSSProperties;
+            class?: string | string[] | object;
+        }>;
+        default: () => {};
+    };
+    /**
+     * 统一设置每个FFormItem组件的GridItem属性，如果FFormItem有单独设置，则采用独立设置的值
+     * @value
+     *    number: 为Arco GridItem组件props中span值
+     *    Object: Arco GridItem组件的props
+     */
+    itemSpan: {
+        type: PropType<GridItemProps | number>;
+        default: () => {
+            span: {
+                xxl: number;
+                xl: number;
+                lg: number;
+                md: number;
+                sm: number;
+                xs: number;
+            };
+        };
+    };
+    /**
+     * 统一设置每个FFormItem组件标签的宽度
+     */
+    labelWidth: {
+        type: PropType<number | string>;
+        default: string;
+    };
+    /**
+     * formItem的渲染列表
+     * @value FFormItem 组件配置项列表
+     */
+    items: {
+        type: PropType<FFormItemType[]>;
+        default: () => never[];
+        required: boolean;
+    };
+};
+export type FFormProps = ExtractPublicPropTypes<typeof fFormProps> & Omit<InstanceType<typeof Form>['$props'], 'model'>;

package/dist/types/components/fform/fform.vue.d.ts

@@ -1,124 +1,126 @@
 import { PropType } from 'vue';
 import { FFormItemType } from './fform';
-
-declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<import('vue').ExtractPropTypes<{
-    contentClass: {
-        type: PropType<string | unknown[] | import('vue').CSSProperties>;
-    };
-    data: {
-        type: ObjectConstructor;
-        default: null;
-    };
-    defaultData: {
-        type: ObjectConstructor;
-        default: null;
-    };
-    gridProps: {
-        type: PropType<import('@arco-design/web-vue').GridProps & {
-            style?: import('vue').CSSProperties | undefined;
-            class?: string | object | string[] | undefined;
-        }>;
-        default: () => {};
-    };
-    itemSpan: {
-        type: PropType<number | import('@arco-design/web-vue').GridItemProps>;
-        default: () => {
-            span: {
-                xxl: number;
-                xl: number;
-                lg: number;
-                md: number;
-                sm: number;
-                xs: number;
-            };
-        };
-    };
-    labelWidth: {
-        type: PropType<string | number>;
-        default: string;
-    };
-    items: {
-        type: PropType<FFormItemType<import('../../types').AnyObject<any>>[]>;
-        default: () => never[];
-        required: boolean;
-    };
-}>, {
-    /**
-     * 表单数据，在非受控模式下，读取组件的值
-     */
-    data: import('vue').Ref<Record<string, any>, Record<string, any>>;
-    /**
-     * 在非受控模式下，直接设置某个表单项的数据
-     * @param field  字段名
-     * @param value  字段值
-     */
-    setFieldValue: (field: string, value: any) => void;
-    /**
-     * Arco Form 实例（可调用组件内部方法）
-     * */
-    ins: import('vue').Ref<any, any>;
-}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
-    contentClass: {
-        type: PropType<string | unknown[] | import('vue').CSSProperties>;
-    };
-    data: {
-        type: ObjectConstructor;
-        default: null;
-    };
-    defaultData: {
-        type: ObjectConstructor;
-        default: null;
-    };
-    gridProps: {
-        type: PropType<import('@arco-design/web-vue').GridProps & {
-            style?: import('vue').CSSProperties | undefined;
-            class?: string | object | string[] | undefined;
-        }>;
-        default: () => {};
-    };
-    itemSpan: {
-        type: PropType<number | import('@arco-design/web-vue').GridItemProps>;
-        default: () => {
-            span: {
-                xxl: number;
-                xl: number;
-                lg: number;
-                md: number;
-                sm: number;
-                xs: number;
-            };
-        };
-    };
-    labelWidth: {
-        type: PropType<string | number>;
-        default: string;
-    };
-    items: {
-        type: PropType<FFormItemType<import('../../types').AnyObject<any>>[]>;
-        default: () => never[];
-        required: boolean;
-    };
-}>> & Readonly<{}>, {
-    data: Record<string, any>;
-    defaultData: Record<string, any>;
-    gridProps: import('@arco-design/web-vue').GridProps & {
-        style?: import('vue').CSSProperties | undefined;
-        class?: string | object | string[] | undefined;
-    };
-    itemSpan: number | import('@arco-design/web-vue').GridItemProps;
-    labelWidth: string | number;
-    items: FFormItemType<import('../../types').AnyObject<any>>[];
-}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>, Partial<Record<NonNullable<`item-undefined_${string}` | `item-${string}_${string}`>, (_: any) => any>> & {
-    prepend?(_: {
-        data: Record<string, any>;
-    }): any;
-    append?(_: {
-        data: Record<string, any>;
-    }): any;
-}>;
-export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
-};
+
+declare function __VLS_template(): Partial<Record<NonNullable<`item-undefined_${string}` | `item-${string}_${string}`>, (_: any) => any>> & {
+    prepend?(_: {
+        data: Record<string, any>;
+    }): any;
+    append?(_: {
+        data: Record<string, any>;
+    }): any;
+};
+declare const __VLS_component: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    contentClass: {
+        type: PropType<string | unknown[] | import('vue').CSSProperties>;
+    };
+    data: {
+        type: ObjectConstructor;
+        default: null;
+    };
+    defaultData: {
+        type: ObjectConstructor;
+        default: null;
+    };
+    gridProps: {
+        type: PropType<import('@arco-design/web-vue').GridProps & {
+            style?: import('vue').CSSProperties;
+            class?: string | string[] | object;
+        }>;
+        default: () => {};
+    };
+    itemSpan: {
+        type: PropType<import('@arco-design/web-vue').GridItemProps | number>;
+        default: () => {
+            span: {
+                xxl: number;
+                xl: number;
+                lg: number;
+                md: number;
+                sm: number;
+                xs: number;
+            };
+        };
+    };
+    labelWidth: {
+        type: PropType<number | string>;
+        default: string;
+    };
+    items: {
+        type: PropType<FFormItemType[]>;
+        default: () => never[];
+        required: boolean;
+    };
+}>, {
+    /**
+     * 表单数据，在非受控模式下，读取组件的值
+     */
+    data: import('vue').Ref<Record<string, any>, Record<string, any>>;
+    /**
+     * 在非受控模式下，直接设置某个表单项的数据
+     * @param field  字段名
+     * @param value  字段值
+     */
+    setFieldValue: (field: string, value: any) => void;
+    /**
+     * Arco Form 实例（可调用组件内部方法）
+     * */
+    ins: import('vue').Ref<any, any>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    contentClass: {
+        type: PropType<string | unknown[] | import('vue').CSSProperties>;
+    };
+    data: {
+        type: ObjectConstructor;
+        default: null;
+    };
+    defaultData: {
+        type: ObjectConstructor;
+        default: null;
+    };
+    gridProps: {
+        type: PropType<import('@arco-design/web-vue').GridProps & {
+            style?: import('vue').CSSProperties;
+            class?: string | string[] | object;
+        }>;
+        default: () => {};
+    };
+    itemSpan: {
+        type: PropType<import('@arco-design/web-vue').GridItemProps | number>;
+        default: () => {
+            span: {
+                xxl: number;
+                xl: number;
+                lg: number;
+                md: number;
+                sm: number;
+                xs: number;
+            };
+        };
+    };
+    labelWidth: {
+        type: PropType<number | string>;
+        default: string;
+    };
+    items: {
+        type: PropType<FFormItemType[]>;
+        default: () => never[];
+        required: boolean;
+    };
+}>> & Readonly<{}>, {
+    data: Record<string, any>;
+    defaultData: Record<string, any>;
+    gridProps: import('@arco-design/web-vue').GridProps & {
+        style?: import('vue').CSSProperties;
+        class?: string | string[] | object;
+    };
+    itemSpan: number | import('@arco-design/web-vue').GridItemProps;
+    labelWidth: string | number;
+    items: FFormItemType<import('../../types').AnyObject>[];
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/types/components/fform/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference path="./components.d.ts" />
 import { default as FForm } from './fform.vue';
-
-export default FForm;
-export type FFormInstance = InstanceType<typeof FForm>;
-export * from './fform';
+
+export default FForm;
+export type FFormInstance = InstanceType<typeof FForm>;
+export * from './fform';

package/dist/types/components/fform-item/fform-item.d.ts

@@ -1,94 +1,94 @@
 import { ExtractPublicPropTypes, Component, PropType, VNodeChild } from 'vue';
 import { AnyObject } from '../../../../../../../../../src/types';
 import { FieldRule, FormItem } from '@arco-design/web-vue';
-
-export declare const CUSTOM_COMPONENT_NAME = "custom";
-/**
- * 所有支持通过配置项来渲染的组件合集
- * 当前引入的组件基本上都会在正常业务中所使用到，所以此处就直接引入全部，暂时不考虑实际使用时传入一个组件，进行按需引入，编译需要TreeShake的事情
- */
-type FacroComponentNames = typeof CUSTOM_COMPONENT_NAME | 'text' | 'radio' | 'date' | 'range' | 'input' | 'select' | 'checkbox' | 'switch' | 'ml-input' | 'textarea' | 'search';
-export declare const fFormItemComponents: Record<FacroComponentNames, Component | null>;
-export declare const fFormItemProps: {
-    /**
-     * 表单项唯一标识
-     * 在配置FForm使用时，也是获取值的唯一标识符
-     */
-    prop: {
-        type: StringConstructor;
-        default: null;
-    };
-    /**
-     * 需要渲染的内部组件的名称，必须在上面fFormItemComponents变量中定义过才支持
-     * 非受控字段，只在初始化时确认唯一渲染组件
-     * 为了扩展性，提供custom特殊值，在使用default插槽进行自定义渲染时，请使用该特殊值
-     */
-    comp: {
-        required: boolean;
-        type: PropType<FacroComponentNames>;
-        default: null;
-        validator: (value: string) => boolean;
-    };
-    /**
-     * 通过函数自定义表单内部组件渲染
-     * 只在comp = 'custom' 生效
-     */
-    render: {
-        type: PropType<(data: {
-            data: AnyObject;
-        }) => VNodeChild>;
-        default: null;
-        validator: (_v: any, props: any) => boolean;
-    };
-    /**
-     * 传递给到渲染组件的props
-     * 如果需要传递events方法，请在方法前面加上on，方法名首字母大写
-     * 例：click => onClick
-     */
-    compProps: {
-        type: ObjectConstructor;
-        default: null;
-    };
-    /**
-     * 标签文本
-     */
-    label: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * 是否隐藏标签
-     * @value 在标签无值或者标签值为空字符串时，默认为true
-     */
-    hideLabel: {
-        type: BooleanConstructor;
-        default: (props: any) => boolean;
-    };
-    /**
-     * 提示语
-     *
-     * 如需换行显示，可使用"\n"作为换行符
-     */
-    tooltip: {
-        type: StringConstructor;
-        default: null;
-    };
-    /**
-     * 是否必填
-     */
-    required: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * 校验规则
-     */
-    rules: {
-        type: PropType<any>;
-        default(props: any): FieldRule[] | null;
-    };
-};
-export type FFormItemProps<T = object> = Omit<ExtractPublicPropTypes<typeof fFormItemProps>, 'compProps'> & Omit<InstanceType<typeof FormItem>['$props'], 'label' | 'hideLabel'> & {
-    compProps?: T;
-};
-export {};
+
+export declare const CUSTOM_COMPONENT_NAME = "custom";
+/**
+ * 所有支持通过配置项来渲染的组件合集
+ * 当前引入的组件基本上都会在正常业务中所使用到，所以此处就直接引入全部，暂时不考虑实际使用时传入一个组件，进行按需引入，编译需要TreeShake的事情
+ */
+type FacroComponentNames = typeof CUSTOM_COMPONENT_NAME | 'text' | 'radio' | 'date' | 'range' | 'input' | 'select' | 'checkbox' | 'switch' | 'ml-input' | 'textarea' | 'search';
+export declare const fFormItemComponents: Record<FacroComponentNames, Component | null>;
+export declare const fFormItemProps: {
+    /**
+     * 表单项唯一标识
+     * 在配置FForm使用时，也是获取值的唯一标识符
+     */
+    prop: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * 需要渲染的内部组件的名称，必须在上面fFormItemComponents变量中定义过才支持
+     * 非受控字段，只在初始化时确认唯一渲染组件
+     * 为了扩展性，提供custom特殊值，在使用default插槽进行自定义渲染时，请使用该特殊值
+     */
+    comp: {
+        required: boolean;
+        type: PropType<FacroComponentNames>;
+        default: null;
+        validator: (value: string) => boolean;
+    };
+    /**
+     * 通过函数自定义表单内部组件渲染
+     * 只在comp = 'custom' 生效
+     */
+    render: {
+        type: PropType<(data: {
+            data: AnyObject;
+        }) => VNodeChild>;
+        default: null;
+        validator: (_v: any, props: any) => boolean;
+    };
+    /**
+     * 传递给到渲染组件的props
+     * 如果需要传递events方法，请在方法前面加上on，方法名首字母大写
+     * 例：click => onClick
+     */
+    compProps: {
+        type: ObjectConstructor;
+        default: null;
+    };
+    /**
+     * 标签文本
+     */
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * 是否隐藏标签
+     * @value 在标签无值或者标签值为空字符串时，默认为true
+     */
+    hideLabel: {
+        type: BooleanConstructor;
+        default: (props: any) => boolean;
+    };
+    /**
+     * 提示语
+     *
+     * 如需换行显示，可使用"\n"作为换行符
+     */
+    tooltip: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * 是否必填
+     */
+    required: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * 校验规则
+     */
+    rules: {
+        type: PropType<FieldRule | FieldRule[]>;
+        default(props: any): FieldRule[] | null;
+    };
+};
+export type FFormItemProps<T = object> = Omit<ExtractPublicPropTypes<typeof fFormItemProps>, 'compProps'> & Omit<InstanceType<typeof FormItem>['$props'], 'label' | 'hideLabel'> & {
+    compProps?: T;
+};
+export {};