VueSuperCrud

基本配置

# 基本配置

# 基本使用

v-model="data" 绑定的表单值data可以不用声明属性name,gender来绑定响应式，组件内部会自动进行响应式处理。

# 基础配置

  • action 配置表单按钮
  • labelWidth 标签宽度，默认 100px
  • labelPosition 标签位置，默认 right
  • layout 布局类型，默认 grid
  • shrinkLabel 是否收缩标签，默认 true
  • scrollError 是否滚动至错误信息，默认 true
  • hiddenLabel 是否隐藏标签
  • labelOverTip 标签超出一行是否隐藏并显示隐藏内容

# 布局

# Grid布局（默认）基于Grid组件

layout="grid" 时使用网格布局，支持以下配置：

  • columns 表单列数
  • columnGap 列间距
  • rowGap 行间距
  • renderColumns项中：
    • widthSize 占据列数
    • heightSize 占据行数

# 固定列宽布局

通过设置 columnWidth 来固定每列宽度，不固定数量：

# Element UI 布局

当 layout="el-row" 时，可以使用 Element UI 的栅格布局系统。

# 详情模式

通过设置 detail 属性开启详情模式，在详情模式下：

  • 表单将变为只读状态
  • 可以通过 border 属性开启边框样式
  • 每个字段可以单独配置 detail 属性来自定义详情展示
{
  detail: true, // 开启详情模式
  border: true, // 开启边框样式
  renderColumns: [
    {
      prop: 'name',
      label: '姓名',
      detail: {
        // 自定义详情展示配置
      }
    }
  ]
}

# 草稿箱功能

表单组件内置了草稿箱功能，支持：

  • 保存草稿：右键菜单或通过 contextMenu.saveDraft 配置
  • 加载草稿：支持加载当前字段或完整加载
  • 草稿管理：支持预览、删除、清空等操作
  • 草稿搜索：支持按名称搜索草稿

配置示例：

{
  contextMenu: {
    saveDraft: true, // 启用保存草稿
    loadDraft: true, // 启用加载草稿
    draft: true // 启用草稿箱
  }
}

# 右键菜单

表单组件提供了丰富的右键菜单功能，包括：

  • 生成测试数据（mock）
  • 重置表单
  • 复制数据
  • 粘贴数据（支持当前/全部）
  • 草稿箱相关操作

配置示例：

{
  contextMenu: {
    mock: true, // 生成测试数据
    copy: true, // 复制数据
    reset: true, // 重置表单
    paste: true, // 粘贴数据
    saveDraft: true, // 保存草稿
    loadDraft: true, // 加载草稿
    draft: true, // 草稿箱
    handles: [] // 自定义菜单项
  }
}

# 分组功能

通过 group 属性开启分组模式，支持：

  • 设置分组标题
  • 配置分组内表单项
  • 自定义分组样式

# 校验功能

renderColumns 项中支持以下校验配置：

  • required 必填
  • rules 校验规则
  • 支持异步校验
  • 支持自定义校验规则

# 显示/隐藏控制

renderColumns 项中支持：

  • hidden 隐藏字段
  • show 显示字段
  • 支持动态控制显示隐藏

# 提示功能

renderColumns 项中支持：

  • tooltip 提示文本
  • tooltipRender 提示渲染函数
  • #[prop]-tooltip 提示插槽

# 标签配置

renderColumns 项中支持：

  • label 标签文本
  • labelRender 标签渲染函数
  • #[prop]-label 标签插槽
  • hiddenLabel 隐藏标签
  • labelOverTip 标签超出隐藏

# API

# Form 属性

参数 说明 类型 默认值
value / v-model 表单数据对象 object -
loading 加载状态 boolean -
options 组件配置 object -

# Options 配置项

参数 说明 类型 默认值
title 表单标题 string -
detail 是否开启详情模式 boolean false
border 是否开启边框模式 boolean false
group 是否开启分组模式 boolean false
labelWidth 标签宽度 string '100px'
labelPosition 标签位置 'right' 'left'
layout 布局类型 'grid' 'el-row'
shrinkLabel 是否收缩标签 boolean true
scrollError 是否滚动至错误信息 boolean true
hiddenLabel 是否隐藏标签 boolean false
labelOverTip 标签超出一行是否隐藏并显示隐藏内容 boolean false
contextMenu 右键菜单配置 object
action 操作列配置 object

# contextMenu 配置

参数 说明 类型 默认值
show 是否显示右键菜单 boolean -
hidden 是否隐藏右键菜单 boolean -
mock 生成测试数据按钮配置 object true
copy 复制数据按钮配置 object true
reset 重置表单按钮配置 object true
paste 粘贴数据按钮配置 object true
saveDraft 保存草稿按钮配置 object true
loadDraft 加载草稿按钮配置 object true
draft 草稿箱按钮配置 object true
handles 自定义菜单项 array []

# action 配置

参数 说明 类型 默认值
show 是否显示操作按钮 boolean -
hidden 是否隐藏操作按钮 boolean -
submit 提交按钮配置 object -
reset 重置按钮配置 object -
handles 自定义按钮 array []
align 按钮对齐方式 string 'center'

# Column 配置

参数 说明 类型 默认值
prop 表单字段名 string -
label 标签文本 string -
widthSize 占据列数 number \ string -
heightSize 占据行数 number \ string -
tooltip 提示文本 string -
tooltipRender 提示渲染函数 function -
labelWidth 单独配置标签宽度 string '100px'
labelRender 标签渲染函数 function -
labelOverTip 标签超出一行是否隐藏并显示隐藏内容 boolean -
hiddenLabel 是否隐藏标签 boolean -
children 子表单项配置(分组时使用) array -
detail 详情模式配置 boolean \ object -
initValue 初始值 any -

# Events

事件名 说明 回调参数
submit 表单提交时触发 (value: object)
reset 表单重置时触发 -
mock-data 生成测试数据时触发 (value: object)
copy 复制数据时触发 (value: string)
paste 粘贴数据时触发 (value: object)
draft-loaded 加载草稿时触发 (draft: object)
draft-deleted 删除草稿时触发 (draft: object)

# 插槽

插槽名 说明 作用域参数
[prop]-label 自定义标签内容 { item, scope }
[prop]-tooltip 自定义提示内容 { item, scope }
title 自定义表单标题 -

详情模式