hs-admin-ui 15.3.1 → 15.3.3

package/dist/types/src/components/business/bcForm/type.d.ts

@@ -0,0 +1,137 @@
+import type { FormInstance } from "element-plus";
+import ICustomData from "../../../types/customData";
+import { Ref, ComputedRef } from "vue";
+import { IFormData, IAuthData } from "../../../types";
+export interface IFormInstance {
+    /** 表单数据
+     *  @deprecated 该功能已弃用,请使用getDataInstance方法
+     */
+    data: ComputedRef<IFormData.Data>;
+    /** 表单数据，【推荐使用getFullData新方法】
+     * @param fieldID 字段ID
+     * @returns IFormData.Data
+     */
+    getData: (fieldID?: string) => IFormData.Data;
+    /** 获取当前实例的配置id
+     */
+    getConfigId: () => string;
+    /** 表单所有数据即使是多层级
+     * @returns IFormData.Data
+     */
+    getFullData: () => IFormData.Data;
+    /** 设置表单数据
+     * @param fieldID 字段ID,或者是【.】拼接的字段路径，此时可省略第三个参数field，如：【form.name】
+     * @param params 数据
+     * @param field 字段
+     * @returns Promise<IFormData.Data>
+     */
+    setData: (fieldID: string, params: ICustomData.ANY, field?: string) => Promise<void>;
+    /** 合并表单数据，只合并表单存在字段值，表单不存在字段值不会追加到表单中，保证数据不被污染
+     * 【推荐使用merageAllData新方法】
+     * @param fieldID 字段ID
+     * @param params 数据
+     * @param extend 合并函数的扩展字段，在合并数据时需要额外追加的字段，默认值 ['id']
+     * @returns Promise<IFormData.Data>
+     */
+    mergeData: (fieldID: string, params: ICustomData.ANY, extend?: string[]) => Promise<void>;
+    /** 合并表单所有数据，只合并表单存在字段值，表单不存在字段值不会追加到表单中，保证数据不被污染
+     * 【注意：每次调用该函数。都是表单刚创建时的原始数据与新值进行合并处理,若要进行数据的不断迭代更新需先获取当前数据合并后在传入】
+     * @param params 数据
+     * @param extend 合并函数的扩展字段，在合并数据时需要额外追加的字段，默认值 ['id']
+     * @returns Promise<IFormData.Data>
+     */
+    merageAllData: (params: ICustomData.ANY, extend?: string[]) => Promise<void>;
+    /** 表单实例方法，包含校验，清空，重置
+     * @returns 表单实例
+     */
+    getInstance: () => FormInstance;
+    /** 获取按钮配置数据
+     * @param key 按钮字段值
+     */
+    getBtnConfig: (key: string) => ICustomData.BtnItem;
+    /** 设置查询按钮显示隐藏
+     * @param field 按钮字段名
+     * @param isShow 是否隐藏,默认为true隐藏
+     */
+    hideBtn: (field: string | string[], isShow?: boolean) => void;
+    /** 设置表单单元显示隐藏
+     * @param fieldID 字段ID
+     * @param field 字段名
+     * @param isShow 是否隐藏,默认为true隐藏
+     */
+    hideItem: (fieldID: string, field: string | string[], isShow?: boolean) => void;
+    /** 设置表单按钮禁用
+     *	@param field 字段
+     *	@param isDisabled 是否禁用,默认为true禁用
+     */
+    setBtnDisabled: (field: string | string[], isDisabled?: boolean) => void;
+    /** 设置表单单元禁用
+     * 	@param fieldID 字段ID
+     *	@param field 字段
+     *	@param isDisabled 是否禁用,默认为true禁用
+     */
+    setItemDisabled: (fieldID: string, field: string | string[], isDisabled?: boolean) => void;
+    /** 设置表单单元是否必填
+     * 	@param fieldID 字段ID
+     *	@param field 字段
+     *	@param isRequired 是否必填,默认为true必填
+     */
+    setItemRequired: (fieldID: string, field: string | string[], isRequired?: boolean) => void;
+    /** 表单子组件实例方法
+     * 	@param fieldID 字段ID
+     *	@param field 字段
+     */
+    getItemInstance: (fieldID: string, field: string) => any;
+    /** 表单子组件布局数据
+     * 	@param fieldID 字段ID
+     *	@param field 字段
+     */
+    getItemLayout: (fieldID: string, field: string) => any;
+    /** 设置元素聚焦
+     * @param fieldID 字段ID
+     * @param field 字段
+     */
+    setQueryFocus: (fieldID: string, field: string) => void;
+    /** 表单配置数据
+     *  @deprecated 该功能已弃用,请使用getData方法
+     */
+    formData: Ref<IFormData.Form>;
+    /** 表单配置数据
+     *  @deprecated 该功能已弃用,请使用getDataInstance方法
+     */
+    dataInstance: Ref<IFormData.Form>;
+    /** 表单配置数据
+     * @returns IFormData.Form
+     */
+    getDataInstance: () => IFormData.Form;
+    /** 表单单个项的配置数据
+     * @param fieldID 字段ID
+     * @param field 字段
+     * @returns ICustomData.FormItemConfigData
+     */
+    getItemConfig: (fieldID: string, field: string) => ICustomData.FormItemConfigData | undefined;
+    /** 获取表单字段分组标识
+     * @param index 默认值 0, 当输入值为-1，获取所有标签
+     */
+    getFieldID: <T extends number>(index?: T) => T extends -1 ? string[] : string;
+    /** 表单提交验证，传参会覆盖本身参数 */
+    submit: (param?: ICustomData.Data) => Promise<IFormData.Data>;
+    configData?: IAuthData.Auth;
+    showLoading: () => void;
+    hideLoading: () => void;
+    /** 获取下拉数据 【在bc-box模式下使用】
+     * @param field 字段名
+     */
+    getOptions: (field: string) => ICustomData.Data[] | undefined;
+    /** 设置下拉数据 【在bc-form模式下使用】
+     * @param field 字段名
+     * @param list 下拉数据
+     */
+    setOptionMap: (field: string, list: ICustomData.Data[]) => void;
+    /** 获取下拉数据 【在bc-form模式下使用】
+     * @param field 字段名,当传值为 '-1' 时返回所有下拉数据字段值
+     */
+    getOptionMap: <T extends string>(field: T) => T extends "-1" ? ICustomData.Data : ICustomData.Data[] | undefined;
+}
+export interface BcFormApi extends Pick<IFormInstance, "getData" | "setData" | "getConfigId" | "getInstance" | "getDataInstance" | "getItemConfig" | "getOptions" | "setOptionMap" | "getOptionMap"> {
+}