mirror of
https://gitee.com/xuliangzhan_admin/vxe-table.git
synced 2026-01-21 05:27:57 +08:00
814 lines
21 KiB
JavaScript
814 lines
21 KiB
JavaScript
const apis = [
|
||
{
|
||
name: 'Props',
|
||
descKey: 'app.api.title.props',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'type',
|
||
descKey: 'app.api.tableColumn.desc.type',
|
||
version: '',
|
||
type: 'String',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'seq',
|
||
descKey: 'app.api.tableColumn.desc.seq',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'checkbox',
|
||
descKey: 'app.api.tableColumn.desc.checkbox',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'radio',
|
||
descKey: 'app.api.tableColumn.desc.radio',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'expand',
|
||
descKey: 'app.api.tableColumn.desc.expand',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'html',
|
||
descKey: 'app.api.tableColumn.desc.html',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'field',
|
||
descKey: 'app.api.tableColumn.desc.field',
|
||
version: '',
|
||
type: 'String',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'title',
|
||
descKey: 'app.api.tableColumn.desc.title',
|
||
version: '',
|
||
type: 'String',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'width',
|
||
descKey: 'app.api.tableColumn.desc.width',
|
||
version: '',
|
||
type: 'Number, String',
|
||
enum: 'px, %',
|
||
defVal: '继承 table.column-width',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'min-width',
|
||
descKey: 'app.api.tableColumn.desc.minWidth',
|
||
version: '',
|
||
type: 'Number, String',
|
||
enum: 'px, %',
|
||
defVal: '继承 table.column-min-width',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'resizable',
|
||
descKey: 'app.api.tableColumn.desc.resizable',
|
||
version: '',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: '继承 table.resizable',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'visible',
|
||
descKey: 'app.api.tableColumn.desc.visible',
|
||
version: '',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'fixed',
|
||
descKey: 'app.api.tableColumn.desc.fixed',
|
||
version: '',
|
||
type: 'String',
|
||
enum: 'left（固定左侧）, right（固定右侧）',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'align',
|
||
descKey: 'app.api.tableColumn.desc.align',
|
||
version: '',
|
||
type: 'String',
|
||
enum: 'left（左对齐）, center（居中对齐）, right（右对齐）',
|
||
defVal: '继承 table.align',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'header-align',
|
||
descKey: 'app.api.tableColumn.desc.headerAlign',
|
||
version: '',
|
||
type: 'String',
|
||
enum: 'left（左对齐）, center（居中对齐）, right（右对齐）',
|
||
defVal: '继承 align > 继承 table.header-align',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'footer-align',
|
||
descKey: 'app.api.tableColumn.desc.footerAlign',
|
||
version: '',
|
||
type: 'String',
|
||
enum: 'left（左对齐）, center（居中对齐）, right（右对齐）',
|
||
defVal: '继承 align > 继承 table.footer-align',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'show-overflow',
|
||
descKey: 'app.api.tableColumn.desc.showOverflow',
|
||
version: '',
|
||
type: 'String,Boolean',
|
||
enum: 'ellipsis（只显示省略号）, title（并且显示为原生 title）, tooltip（并且显示为 tooltip 提示）',
|
||
defVal: '继承 table.show-overflow',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'show-header-overflow',
|
||
descKey: 'app.api.tableColumn.desc.showHeaderOverflow',
|
||
version: '',
|
||
type: 'String,Boolean',
|
||
enum: 'ellipsis（只显示省略号）, title（并且显示为原生 title）, tooltip（并且显示为 tooltip 提示）',
|
||
defVal: '继承 table.show-header-overflow',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'show-footer-overflow',
|
||
descKey: 'app.api.tableColumn.desc.showFooterOverflow',
|
||
version: '',
|
||
type: 'Boolean, String',
|
||
enum: 'ellipsis（只显示省略号）,title（并且显示为原生 title）,tooltip（并且显示为 tooltip 提示）',
|
||
defVal: '继承 table.show-footer-overflow',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'class-name',
|
||
descKey: 'app.api.tableColumn.desc.className',
|
||
version: '',
|
||
type: 'String, Function',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'header-class-name',
|
||
descKey: 'app.api.tableColumn.desc.headerClassName',
|
||
version: '',
|
||
type: 'String, Function',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'footer-class-name',
|
||
descKey: 'app.api.tableColumn.desc.footerClassName',
|
||
version: '',
|
||
type: 'String, Function',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'formatter',
|
||
descKey: 'app.api.tableColumn.desc.formatter',
|
||
version: '',
|
||
type: 'Function, Array, String',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'seq-method',
|
||
descKey: 'app.api.tableColumn.desc.seqMethod',
|
||
version: '',
|
||
type: 'Function',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'sortable',
|
||
descKey: 'app.api.tableColumn.desc.sortable',
|
||
version: '',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'false',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'sort-by',
|
||
descKey: 'app.api.tableColumn.desc.sortBy',
|
||
version: '',
|
||
type: 'String, Array',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'sort-method',
|
||
descKey: 'app.api.tableColumn.desc.sortMethod',
|
||
version: '',
|
||
type: 'Function',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'remote-sort',
|
||
descKey: 'app.api.tableColumn.desc.remoteSort',
|
||
version: '',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: '继承 table.remote-sort',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'filters',
|
||
descKey: 'app.api.tableColumn.desc.filters',
|
||
version: '',
|
||
type: 'Array',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'label',
|
||
desc: '显示的值',
|
||
version: '',
|
||
type: 'String',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'value',
|
||
desc: '实际的值',
|
||
version: '',
|
||
type: 'Any',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'checked',
|
||
desc: '默认是否选中',
|
||
version: '',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'false',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'resetValue',
|
||
desc: '重置时的默认值',
|
||
version: '',
|
||
type: 'Any',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'data',
|
||
desc: '自定义渲染的数据值（当使用自定义模板时可能会用到）',
|
||
version: '',
|
||
type: 'Any',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'filter-multiple',
|
||
descKey: 'app.api.tableColumn.desc.filterMultiple',
|
||
version: '',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'true',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'filter-method',
|
||
descKey: 'app.api.tableColumn.desc.filterMethod',
|
||
version: '',
|
||
type: 'Function',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'filter-render',
|
||
descKey: 'app.api.tableColumn.desc.filterRender',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'name',
|
||
desc: '渲染器名称',
|
||
version: '',
|
||
type: 'String',
|
||
enum: 'input, textarea, select, $input, $textarea, $select',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'props',
|
||
desc: '渲染的参数（请查看目标渲染的 Props）',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'attrs',
|
||
desc: '渲染的属性（请查看目标渲染的 Attribute）',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'events',
|
||
desc: '渲染组件的事件（请查看目标渲染的 Events）',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '{row,rowIndex,$rowIndex,column,columnIndex,$columnIndex}, ...[目标渲染的 arguments]',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'content',
|
||
desc: '渲染组件的内容（仅用于特殊组件）',
|
||
version: '',
|
||
type: 'String',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'cell-render',
|
||
descKey: 'app.api.tableColumn.desc.cellRender',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'name',
|
||
desc: '渲染器名称',
|
||
version: '',
|
||
type: 'String',
|
||
enum: 'input, textarea, select, $input, $textarea, $select',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'props',
|
||
desc: '渲染的参数（请查看目标渲染的 Props）',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'attrs',
|
||
desc: '渲染的属性（请查看目标渲染的 Attribute）',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'options',
|
||
desc: '只对 name=select 有效，下拉选项列表',
|
||
version: '',
|
||
type: 'Array',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'optionProps',
|
||
desc: '只对 name=select 有效，下拉选项属性参数配置',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '{ value, label, disabled }',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'optionGroups',
|
||
desc: '只对 name=select 有效，下拉分组选项列表',
|
||
version: '',
|
||
type: 'Array',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'optionGroupProps',
|
||
desc: '只对 name=select 有效，下拉分组选项属性参数配置',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '{ options, label }',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'events',
|
||
desc: '渲染组件的事件（请查看目标渲染的 Events）',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '{row,rowIndex,$rowIndex,column,columnIndex,$columnIndex}, ...[目标渲染的 arguments]',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'content',
|
||
desc: '渲染组件的内容（仅用于特殊组件）',
|
||
version: '',
|
||
type: 'String',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'edit-render',
|
||
descKey: 'app.api.tableColumn.desc.editRender',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'type',
|
||
desc: '渲染类型',
|
||
version: '',
|
||
type: 'String',
|
||
enum: 'default（组件触发后可视）,visible（组件一直可视）',
|
||
defVal: 'default',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'name',
|
||
desc: '渲染器名称',
|
||
version: '',
|
||
type: 'String',
|
||
enum: 'input, textarea, select, $input, $textarea, $select',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'props',
|
||
desc: '渲染的参数（请查看目标渲染的 Props）',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'attrs',
|
||
desc: '渲染的属性（请查看目标渲染的 Attribute）',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'options',
|
||
desc: '只对 name=select 有效，下拉选项列表',
|
||
version: '',
|
||
type: 'Array',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'optionProps',
|
||
desc: '只对 name=select 有效，下拉选项属性参数配置',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '{ value, label, disabled }',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'optionGroups',
|
||
desc: '只对 name=select 有效，下拉分组选项列表',
|
||
version: '',
|
||
type: 'Array',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'optionGroupProps',
|
||
desc: '只对 name=select 有效，下拉分组选项属性参数配置',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '{ options, label }',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'events',
|
||
desc: '渲染组件的事件（请查看目标渲染的 Events）',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '{row,rowIndex,$rowIndex,column,columnIndex,$columnIndex}, ...[目标渲染的 arguments]',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'content',
|
||
desc: '渲染组件的内容（仅用于特殊组件）',
|
||
version: '',
|
||
type: 'String',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'autofocus',
|
||
desc: '如果是自定义渲染可以指定聚焦的选择器，例如 .my-input',
|
||
version: '',
|
||
type: 'String',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'autoselect',
|
||
desc: '是否在激活编辑之后自动选中输入框内容',
|
||
version: '',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'false',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'defaultValue',
|
||
desc: '默认值（插入数据时列的默认值）',
|
||
version: '',
|
||
type: 'Any',
|
||
enum: '',
|
||
defVal: 'null',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'immediate',
|
||
desc: '输入值实时同步更新（如果设置为 true，但可编辑时性能将会直线下降）',
|
||
version: '',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'false',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'content-render',
|
||
descKey: 'app.api.tableColumn.desc.contentRender',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'name',
|
||
desc: '渲染器名称',
|
||
version: '',
|
||
type: 'String',
|
||
enum: 'input, textarea, select, $input, $textarea, $select',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'props',
|
||
desc: '渲染的参数（请查看目标渲染的 Props）',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'attrs',
|
||
desc: '渲染的属性（请查看目标渲染的 Attribute）',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'options',
|
||
desc: '只对 name=select 有效，下拉选项列表',
|
||
version: '',
|
||
type: 'Array',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'optionProps',
|
||
desc: '只对 name=select 有效，下拉选项属性参数配置',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '{ value, label, disabled }',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'optionGroups',
|
||
desc: '只对 name=select 有效，下拉分组选项列表',
|
||
version: '',
|
||
type: 'Array',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'optionGroupProps',
|
||
desc: '只对 name=select 有效，下拉分组选项属性参数配置',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '{ options, label }',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'events',
|
||
desc: '渲染组件的事件（请查看目标渲染的 Events）',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '{data, property}, ...[目标渲染的 arguments]',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'tree-node',
|
||
descKey: 'app.api.tableColumn.desc.treeNode',
|
||
version: '',
|
||
type: 'Boolean',
|
||
enum: '',
|
||
defVal: 'false',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'params',
|
||
descKey: 'app.api.tableColumn.desc.params',
|
||
version: '',
|
||
type: 'Object',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'Slots',
|
||
descKey: 'app.api.title.slots',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: [
|
||
{
|
||
name: 'default',
|
||
desc: '自定义显示内容模板',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '{row,rowIndex,$rowIndex,column,columnIndex,$columnIndex}, h',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'header',
|
||
desc: '自定义表头内容的模板',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '{column,columnIndex,$columnIndex,$rowIndex}, h',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'footer',
|
||
desc: '自定义表尾内容的模板',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '{column,columnIndex,$columnIndex,$rowIndex,itemIndex,items}, h',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'content',
|
||
desc: '只对 type=expand 有效，自定义展开后的内容模板',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '{row,rowIndex,$rowIndex,column,columnIndex,$columnIndex}, h',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'filter',
|
||
desc: '只对 filter-render 启用时有效，自定义筛选模板',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '{column,columnIndex,$columnIndex}, h',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'edit',
|
||
desc: '只对 edit-render 启用时有效，自定义可编辑组件模板',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '{row,rowIndex,$rowIndex,column,columnIndex,$columnIndex}, h',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'icon',
|
||
desc: '只对 type=expand 或 tree-node 有效，自定义图标模板',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '{row,rowIndex,$rowIndex,column,columnIndex,$columnIndex}, h',
|
||
list: []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
name: 'Events',
|
||
descKey: 'app.api.title.events',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
},
|
||
{
|
||
name: 'Methods',
|
||
descKey: 'app.api.title.methods',
|
||
version: '',
|
||
type: '',
|
||
enum: '',
|
||
defVal: '',
|
||
list: []
|
||
}
|
||
]
|
||
|
||
export default apis
|