CustomRender 自定义渲染

CustomRender 组件是一个特殊的封装组件, 允许您完全自定义组件的渲染逻辑.

基本用法

tsx

import { defineOption } from '@xiaohaih/json-form-plus';

defineOption({
    custom: {
        t: 'custom-render',
        label: '自定义组件',
        render: (props) => () => h('div', '自定义内容'),
    },
});

Props

除了共享 Props外, CustomRender 组件还支持以下特定属性:

renderFormItem

类型: boolean
默认: true

是否渲染 ElFormItem

render

类型: (option: CustomRenderSlotOption<T, Query, Option, OptionQuery>) => () => any
默认: -
必填: true

自定义渲染逻辑

CustomRenderSlotOption 声明如下

export interface CustomRenderSlotOption {
    /**
     * 获取传递给 FormItem props
     * 可参考 https://element-plus.org/zh-CN/component/form.html#formitem-api
     */
    getFormItemProps: () => Record<string, any>;
    /** 获取传递给当前组件 props */
    getProps: () => Record<string, any>;
    /** 封装给组件的通用选项 */
    plain: PlainReturnValue;
}

/** usePlain 的返回值 */
export interface PlainReturnValue {
    /** 覆盖 props 的最新的值(defaultValue, initialValue) */
    coverProps: Record<'defaultValue' | 'initialValue', any>;
    /** HForm 暴露给组件的选项 */
    wrapper: WrapperProvideValue;
    /** 在特定时机中 HForm 会调用该选项下的方法 */
    option: CommonMethod;
    /** 数据加载状态 */
    loading: Ref<boolean>;
    /** 可主动获取远程数据 */
    getOptions: (trigger: 'initial' | 'depend' | 'other', option?: {
        /** 筛选值 */
        filterValue?: string;
    }) => Promise<void>;
    /** 当前组件的值 */
    checked: Ref<any>;
    /** 获取当前组件提交给后端的值 */
    getQuery: () => Record<string, any>;
    /** 远程数据(getOptions 返回的数据) */
    remoteOption: Ref<Record<string, any>[]>;
    /** 优先返回 remoteOption, 其次返回外部传递的 options */
    finalOption: ComputedRef<Record<string, any>[]>;
    /** 是否隐藏组件 */
    insetHide: ComputedRef<boolean>;
    /** 更新值但不触发外部的搜索事件 */
    updateCheckedValue: (value: any) => void;
    /**
     * 更新值并根据 HForm realtime 状态判断
     * - realtime: true 则触发搜索事件
     * - realtime: false 则仅更新值(等同于 updateCheckedValue 函数)
     */
    change: (value: any) => void;
    /** 等同于 updateCheckedValue, 只是可以选择不传值(用来兼容低版本) */
    trigger: (value?: any) => void;
    /** 触发搜索事件 */
    search: () => void;
    /** 重置 */
    reset: () => void;
    /** 传递给 HForm 的 readonly 属性 */
    globalReadonly: Ref<boolean>;
    /** 传递给 HForm 的 disabled 属性 */
    globalDisabled: Ref<boolean>;
}

/** 组件提供给 HForm 的选项 */
export interface CommonMethod {
    /** 重置 */
    reset: () => void;
    /** 更新 HForm 中 query 的值 */
    updateWrapperQuery: () => void;
    /** 校验方法 */
    validator?: (query: Record<string, string>) => Promise<any> | any;
    /** 获取该组件拼接的参数 */
    getQuery: () => Record<string, any>;
    /** 在 watch 中 backfill 改变后, 需要执行回调 */
    onChangeByBackfill?: () => void;
}

/** HForm 暴露给组件的选项 */
export interface WrapperProvideValue {
    /** 表单是否只读 */
    readonly?: Ref<boolean | undefined>;
    /** 表单是否禁用 */
    disabled?: Ref<boolean | undefined>;
    /**
     * 是否实时触发
     */
    realtime: Ref<boolean | undefined>;
    /**
     * 子组件需主动注册组件, 否则不会生效
     * @param {CommonMethod} config 提供父组件校验, 重置等方法
     *
     * @returns {() => void} 取消注册 - 默认会自动取消, 如果是异步任务内注册, 需自己手动取消
     */
    register: (config: CommonMethod) => () => void;
    /**
     * 子组件通知父级更新 query 中的值 - 静默修改, 不触发搜索事件
     * @param {string} field 更新的字段
     * @param {*} value 更新的值
     * @param {string} nativeField 原始提供的字段(不受 as, fields 等属性的影响)
     */
    updateQueryValue: (field: string, value: any, nativeField: string) => void;
    /**
     * 子组件内部值发生了变动, 由父级决定是否触发搜索事件(实时搜索时需要区分这两种方式)
     * @param {string | string[]} [tryFields] 比较 query[tryFields] 与 backfill[tryFields]是否一致, 不一致时才触发搜索
     */
    insetSearch: (tryFields?: string | string[]) => void;
    /**
     * 提供给组件内部的直接触发到外部的搜索事件
     */
    search: () => Promise<string | void>;
    /** 删除内部无引用的字段 */
    removeUnreferencedField: (field: string) => void;
    /** 所有条件的 options 数据 */
    options: Record<string, any[]>;
}

示例

基础渲染输入框

tsx

import { ElButton, ElInput } from 'element-plus';

defineOption({
    custom: {
        t: 'custom-render',
        label: '自定义输入框',
        render: ({ plain }) => {
            return () => h('div', h(ElInput, { 'modelValue': plain.checked.value, 'onUpdate:modelValue': plain.change, 'placeholder': '请输入...' }));
        },
    },
    // 纯分隔符
    inline: {
        t: 'custom-render',
        renderFormItem: false,
        render: (props) => () => h('hr'),
    },
    icon: {
        t: 'custom-render',
        label: '菜单图标',
        render(option) {
            const { checked, change } = option.plain;
            // const popupIcons = useComponent(DialogIcons, ins);
            function clickHandle() {
                checked.value = 'plus';
                // popupIcons({
                //     defaultSelected: checked.value as string,
                //     onSuccess: change,
                // }).show();
            }
            function clear() {
                change('');
            }

            return () => (
                <div class="relative">
                    <div class="size-50px center border b-current b-dashed text-24px op-60 hover:c-primary" tabindex="0" onClick={clickHandle}>
                        {checked.value ? <i class={`${checked.value as string} c-primary`}></i> : <i class="i-pure:plus" />}
                    </div>

                    {!!checked.value && (
                        <div class="absolute right-0 top-0 size-14px center translate-x-50% translate-y--50% rd-50% bg-text-primary text-10px c-page-color op-80" tabindex="0" onClick={clear}><i class="i-pure:times"></i></div>
                    )}
                </div>
            );
        },
    },
});

点我查看在线示例

注意事项

CustomRender 组件允许您完全控制渲染逻辑
通过 props.plain.checked.value 访问当前值
通过 props.plain.change() 更新数据
可以通过 renderFormItem 控制是否渲染表单项
可以渲染任何 Vue 组件或 HTML 元素
可以处理任何用户交互事件

CustomRender 自定义渲染 ​

基本用法 ​

Props ​

renderFormItem ​

render ​

示例 ​

基础渲染输入框 ​

注意事项 ​

CustomRender 自定义渲染

基本用法

Props

renderFormItem

render

示例

基础渲染输入框

注意事项