工具函数

createNumberProp()

createNumberProp 用于创建整数或浮点数类型的属性。可以指定属性的初始值、标签、字段名等参数。

参数

• component: 组件名称，通常为 PropNumber。
• field: 字段名称，属性的唯一标识符。
• label: 标签，显示给用户的属性名称。
• defaultValue: 默认值，属性的初始值。
• tips: 提示信息，通常用于展示给用户的辅助说明。
• visible: 布尔值，控制属性是否可见。

使用示例

createNumberProp({
    component: 'PropNumber',
    field: 'field1',
    label: 'Width',
    defaultValue: 0,
    tips: '请输入宽度值',
    visible: true
});

createObjectProp()

createObjectProp 用于创建对象类型的属性。可以通过该函数定义一个包含多个键值对的对象属性。

参数

• component: 组件名称，通常为 PropObject。
• field: 字段名称，属性的唯一标识符。
• label: 标签，显示给用户的属性名称。
• defaultValue: 默认值，属性的初始值（通常为 {}）。
• tips: 提示信息，通常用于展示给用户的辅助说明。
• visible: 布尔值，控制属性是否可见。

使用示例

createObjectProp({
    component: 'PropObject',
    field: 'field2',
    label: 'Dimensions',
    defaultValue: {},
    tips: '请输入对象的属性值',
    visible: true
});

createStringProp()

createStringProp 用于创建字符串类型的属性。此函数通常用于创建文本字段、标题等。

参数

• component: 组件名称，通常为 PropString。
• field: 字段名称，属性的唯一标识符。
• label: 标签，显示给用户的属性名称。
• defaultValue: 默认值，属性的初始值（通常为空字符串 ''）。
• tips: 提示信息，通常用于展示给用户的辅助说明。
• visible: 布尔值，控制属性是否可见。

使用示例

createStringProp({
    component: 'PropString',
    field: 'field3',
    label: 'Height',
    defaultValue: '',
    tips: '请输入高度值',
    visible: true
});

createGroupProp()

createGroupProp 用于创建一个属性组，将多个基础属性包装在一起。通常用于将相关属性进行分组，便于管理和展示。

参数

• label: 属性组的标签。
• props: 一个属性数组，包含多个基础属性。

使用示例

createGroupProp({
    label: 'Group Title',
    props: [
        createNumberProp({
            field: 'field1',
            label: 'Width',
            defaultValue: 0
        }),
        createStringProp({
            field: 'field2',
            label: 'Height',
            defaultValue: ''
        })
    ]
});

createBooleanProp()

createBooleanProp 用于创建布尔类型的属性，常用于开关、复选框等。

参数

• component: 组件名称，通常为 PropBoolean。
• field: 字段名称，属性的唯一标识符。
• label: 标签，显示给用户的属性名称。
• defaultValue: 默认值，属性的初始值（布尔类型）。
• tips: 提示信息，通常用于展示给用户的辅助说明。
• visible: 布尔值，控制属性是否可见。

使用示例

createBooleanProp({
    component: 'PropBoolean',
    field: 'field4',
    label: 'Enable',
    defaultValue: true,
    tips: '是否启用此功能',
    visible: true
});

createArrayProp()

createArrayProp 用于创建数组类型的属性，通常用于选择多个选项或提供多个值的输入。

参数

• component: 组件名称，通常为 PropArray。
• field: 字段名称，属性的唯一标识符。
• label: 标签，显示给用户的属性名称。
• defaultValue: 默认值，属性的初始值（通常为空数组 []）。
• options: 可选项数组，通常用于下拉选择框或多选框等。
• tips: 提示信息，通常用于展示给用户的辅助说明。
• visible: 布尔值，控制属性是否可见。

使用示例

createArrayProp({
    component: 'PropArray',
    field: 'field5',
    label: 'Options',
    defaultValue: [],
    options: ['Option1', 'Option2', 'Option3'],
    tips: '选择可用的选项',
    visible: true
});

createSlot()

createSlot 用于创建插槽方法，可以为组件提供灵活的插槽配置，支持白名单和黑名单的过滤，控制哪些内容可以插入到该插槽。

参数

• title: 插槽的标题或标识。
• allow: 白名单，指定允许的插槽内容。
• deny: 黑名单，指定禁止的插槽内容。
• props: 插槽的扩展参数，允许自定义插槽的额外属性。

使用示例

createSlot({
    title: 'CustomSlot',
    allow: ['ComponentA', 'ComponentB'], // 白名单，允许插入的组件
    deny: ['ComponentC'], // 黑名单，禁止插入的组件
    props: [] // 插槽扩展参数
});