UNPKG

vxe-table-ro-test

Version:

一个基于 vue 的 PC 端表格组件,支持增删改查、虚拟树、列拖拽,懒加载、快捷菜单、数据校验、树形结构、打印、导入导出、自定义模板、渲染器、JSON 配置式...

724 lines (723 loc) 28.6 kB
import { h, resolveComponent } from 'vue'; import XEUtils from 'xe-utils'; import { VxeUI } from '../../ui'; import { getCellValue, setCellValue } from '../../table/src/util'; import { getFuncText, formatText, isEmptyValue } from '../../ui/src/utils'; import { getOnName, getModelEvent, getChangeEvent } from '../../ui/src/vn'; import { errLog } from '../../ui/src/log'; const { getConfig, renderer, getI18n } = VxeUI; const componentDefaultModelProp = 'modelValue'; const defaultCompProps = { transfer: true }; function parseDate(value, props) { return value && props.valueFormat ? XEUtils.toStringDate(value, props.valueFormat) : value; } function getFormatDate(value, props, defaultFormat) { const { dateConfig = {} } = props; return XEUtils.toDateString(parseDate(value, props), dateConfig.labelFormat || defaultFormat); } function getLabelFormatDate(value, props) { return getFormatDate(value, props, getI18n(`vxe.input.date.labelFormat.${props.type || 'date'}`)); } /** * 已废弃 * @deprecated */ function getOldComponentName(name) { return `vxe-${name.replace('$', '')}`; } function getDefaultComponent({ name }) { return resolveComponent(name); } /** * 已废弃 * @deprecated */ function getOldComponent({ name }) { return resolveComponent(getOldComponentName(name)); } function handleConfirmFilter(params, checked, option) { const { $panel } = params; $panel.changeOption({}, checked, option); } function getNativeAttrs(renderOpts) { let { name, attrs } = renderOpts; if (name === 'input') { attrs = Object.assign({ type: 'text' }, attrs); } return attrs; } function getInputImmediateModel(renderOpts) { const { name, immediate, props } = renderOpts; if (!immediate) { if (name === 'VxeInput' || name === '$input') { const { type } = props || {}; return !(!type || type === 'text' || type === 'number' || type === 'integer' || type === 'float'); } if (name === 'input' || name === 'textarea' || name === '$textarea') { return false; } return true; } return immediate; } function getCellEditProps(renderOpts, params, value, defaultProps) { return XEUtils.assign({ immediate: getInputImmediateModel(renderOpts) }, defaultCompProps, defaultProps, renderOpts.props, { [componentDefaultModelProp]: value }); } function getCellEditFilterProps(renderOpts, params, value, defaultProps) { return XEUtils.assign({}, defaultCompProps, defaultProps, renderOpts.props, { [componentDefaultModelProp]: value }); } function isImmediateCell(renderOpts, params) { return params.$type === 'cell' || getInputImmediateModel(renderOpts); } function getCellLabelVNs(renderOpts, params, cellLabel) { const { name, placeholder } = renderOpts; return [ h('span', { class: ['vxe-cell--label', ['VxeTextarea', 'textarea'].includes(name) ? 'is--textarea' : ''] }, placeholder && isEmptyValue(cellLabel) ? [ h('span', { class: 'vxe-cell--placeholder' }, formatText(getFuncText(placeholder), 1)) ] : formatText(cellLabel, 1)) ]; } /** * 原生事件处理 * @param renderOpts * @param params * @param modelFunc * @param changeFunc */ function getNativeElementOns(renderOpts, params, modelFunc, changeFunc) { const { events } = renderOpts; const modelEvent = getModelEvent(renderOpts); const changeEvent = getChangeEvent(renderOpts); const isSameEvent = changeEvent === modelEvent; const ons = {}; if (events) { XEUtils.objectEach(events, (func, key) => { ons[getOnName(key)] = function (...args) { func(params, ...args); }; }); } if (modelFunc) { ons[getOnName(modelEvent)] = function (targetEvnt) { modelFunc(targetEvnt); if (isSameEvent && changeFunc) { changeFunc(targetEvnt); } if (events && events[modelEvent]) { events[modelEvent](params, targetEvnt); } }; } if (!isSameEvent && changeFunc) { ons[getOnName(changeEvent)] = function (...args) { changeFunc(...args); if (events && events[changeEvent]) { events[changeEvent](params, ...args); } }; } return ons; } /** * 组件事件处理 * @param renderOpts * @param params * @param modelFunc * @param changeFunc */ function getComponentOns(renderOpts, params, modelFunc, changeFunc) { const { events } = renderOpts; const modelEvent = getModelEvent(renderOpts); const changeEvent = getChangeEvent(renderOpts); const ons = {}; XEUtils.objectEach(events, (func, key) => { ons[getOnName(key)] = function (...args) { if (process.env.NODE_ENV === 'development') { if (!XEUtils.isFunction(func)) { errLog('vxe.error.errFunc', [func]); } } func(params, ...args); }; }); if (modelFunc) { ons[getOnName(modelEvent)] = function (targetEvnt) { modelFunc(targetEvnt); if (events && events[modelEvent]) { events[modelEvent](params, targetEvnt); } }; } if (changeFunc) { ons[getOnName(changeEvent)] = function (...args) { changeFunc(...args); if (events && events[changeEvent]) { events[changeEvent](params, ...args); } }; } return ons; } function getEditOns(renderOpts, params) { const { $table, row, column } = params; const { name } = renderOpts; const { model } = column; const isImmediate = isImmediateCell(renderOpts, params); return getComponentOns(renderOpts, params, (cellValue) => { // 处理 model 值双向绑定 model.update = true; model.value = cellValue; if (isImmediate) { setCellValue(row, column, cellValue); } }, (eventParams) => { // 处理 change 事件相关逻辑 if (!isImmediate && (['VxeInput', 'VxeNumberInput', 'VxeTextarea', '$input', '$textarea'].includes(name))) { const cellValue = eventParams.value; model.update = true; model.value = cellValue; $table.updateStatus(params, cellValue); } else { $table.updateStatus(params); } }); } function getFilterOns(renderOpts, params, option) { return getComponentOns(renderOpts, params, (value) => { // 处理 model 值双向绑定 option.data = value; }, () => { handleConfirmFilter(params, !XEUtils.eqNull(option.data), option); }); } function getNativeEditOns(renderOpts, params) { const { $table, row, column } = params; const { model } = column; return getNativeElementOns(renderOpts, params, (evnt) => { // 处理 model 值双向绑定 const cellValue = evnt.target.value; if (isImmediateCell(renderOpts, params)) { setCellValue(row, column, cellValue); } else { model.update = true; model.value = cellValue; } }, (evnt) => { // 处理 change 事件相关逻辑 const cellValue = evnt.target.value; $table.updateStatus(params, cellValue); }); } function getNativeFilterOns(renderOpts, params, option) { return getNativeElementOns(renderOpts, params, (evnt) => { // 处理 model 值双向绑定 option.data = evnt.target.value; }, () => { handleConfirmFilter(params, !XEUtils.eqNull(option.data), option); }); } /** * 单元格可编辑渲染-原生的标签 * input、textarea、select */ function nativeEditRender(renderOpts, params) { const { row, column } = params; const { name } = renderOpts; const cellValue = isImmediateCell(renderOpts, params) ? getCellValue(row, column) : column.model.value; return [ h(name, Object.assign(Object.assign(Object.assign({ class: `vxe-default-${name}` }, getNativeAttrs(renderOpts)), { value: cellValue }), getNativeEditOns(renderOpts, params))) ]; } function buttonCellRender(renderOpts, params) { return [ h(getDefaultComponent(renderOpts), Object.assign(Object.assign({}, getCellEditProps(renderOpts, params, null)), getComponentOns(renderOpts, params))) ]; } function defaultEditRender(renderOpts, params) { const { row, column } = params; const cellValue = getCellValue(row, column); return [ h(getDefaultComponent(renderOpts), Object.assign(Object.assign({}, getCellEditProps(renderOpts, params, cellValue)), getEditOns(renderOpts, params))) ]; } function radioAndCheckboxEditRender(renderOpts, params) { const { options } = renderOpts; const { row, column } = params; const cellValue = getCellValue(row, column); return [ h(getDefaultComponent(renderOpts), Object.assign(Object.assign({ options }, getCellEditProps(renderOpts, params, cellValue)), getEditOns(renderOpts, params))) ]; } /** * 已废弃 * @deprecated */ function oldEditRender(renderOpts, params) { const { row, column } = params; const cellValue = getCellValue(row, column); return [ h(getOldComponent(renderOpts), Object.assign(Object.assign({}, getCellEditProps(renderOpts, params, cellValue)), getEditOns(renderOpts, params))) ]; } /** * 已废弃 * @deprecated */ function oldButtonEditRender(renderOpts, params) { return [ h(resolveComponent('vxe-button'), Object.assign(Object.assign({}, getCellEditProps(renderOpts, params, null)), getComponentOns(renderOpts, params))) ]; } /** * 已废弃 * @deprecated */ function oldButtonsEditRender(renderOpts, params) { return renderOpts.children.map((childRenderOpts) => oldButtonEditRender(childRenderOpts, params)[0]); } function renderNativeOptgroups(renderOpts, params, renderOptionsMethods) { const { optionGroups, optionGroupProps = {} } = renderOpts; const groupOptions = optionGroupProps.options || 'options'; const groupLabel = optionGroupProps.label || 'label'; return optionGroups.map((group, gIndex) => { return h('optgroup', { key: gIndex, label: group[groupLabel] }, renderOptionsMethods(group[groupOptions], renderOpts, params)); }); } /** * 渲染原生的 option 标签 */ function renderNativeOptions(options, renderOpts, params) { const { optionProps = {} } = renderOpts; const { row, column } = params; const labelProp = optionProps.label || 'label'; const valueProp = optionProps.value || 'value'; const disabledProp = optionProps.disabled || 'disabled'; const cellValue = isImmediateCell(renderOpts, params) ? getCellValue(row, column) : column.model.value; return options.map((option, oIndex) => { return h('option', { key: oIndex, value: option[valueProp], disabled: option[disabledProp], /* eslint-disable eqeqeq */ selected: option[valueProp] == cellValue }, option[labelProp]); }); } function nativeFilterRender(renderOpts, params) { const { column } = params; const { name } = renderOpts; const attrs = getNativeAttrs(renderOpts); return column.filters.map((option, oIndex) => { return h(name, Object.assign(Object.assign(Object.assign({ key: oIndex, class: `vxe-default-${name}` }, attrs), { value: option.data }), getNativeFilterOns(renderOpts, params, option))); }); } function defaultFilterRender(renderOpts, params) { const { column } = params; return column.filters.map((option, oIndex) => { const optionValue = option.data; return h(getDefaultComponent(renderOpts), Object.assign(Object.assign({ key: oIndex }, getCellEditFilterProps(renderOpts, renderOpts, optionValue)), getFilterOns(renderOpts, params, option))); }); } /** * 已废弃 * @deprecated */ function oldFilterRender(renderOpts, params) { const { column } = params; return column.filters.map((option, oIndex) => { const optionValue = option.data; return h(getOldComponent(renderOpts), Object.assign(Object.assign({ key: oIndex }, getCellEditFilterProps(renderOpts, renderOpts, optionValue)), getFilterOns(renderOpts, params, option))); }); } function handleFilterMethod({ option, row, column }) { const { data } = option; const cellValue = XEUtils.get(row, column.field); /* eslint-disable eqeqeq */ return cellValue == data; } function handleInputFilterMethod({ option, row, column }) { const { data } = option; const cellValue = XEUtils.get(row, column.field); /* eslint-disable eqeqeq */ return XEUtils.toValueString(cellValue).indexOf(data) > -1; } function nativeSelectEditRender(renderOpts, params) { return [ h('select', Object.assign(Object.assign({ class: 'vxe-default-select' }, getNativeAttrs(renderOpts)), getNativeEditOns(renderOpts, params)), renderOpts.optionGroups ? renderNativeOptgroups(renderOpts, params, renderNativeOptions) : renderNativeOptions(renderOpts.options, renderOpts, params)) ]; } function defaultSelectEditRender(renderOpts, params) { const { row, column } = params; const { options, optionProps, optionGroups, optionGroupProps } = renderOpts; const cellValue = getCellValue(row, column); return [ h(getDefaultComponent(renderOpts), Object.assign(Object.assign({}, getCellEditProps(renderOpts, params, cellValue, { options, optionProps, optionGroups, optionGroupProps })), getEditOns(renderOpts, params))) ]; } function defaultTreeSelectEditRender(renderOpts, params) { const { row, column } = params; const { options, optionProps } = renderOpts; const cellValue = getCellValue(row, column); return [ h(getDefaultComponent(renderOpts), Object.assign(Object.assign({}, getCellEditProps(renderOpts, params, cellValue, { options, optionProps })), getEditOns(renderOpts, params))) ]; } /** * 已废弃 * @deprecated */ function oldSelectEditRender(renderOpts, params) { const { row, column } = params; const { options, optionProps, optionGroups, optionGroupProps } = renderOpts; const cellValue = getCellValue(row, column); return [ h(getOldComponent(renderOpts), Object.assign(Object.assign({}, getCellEditProps(renderOpts, params, cellValue, { options, optionProps, optionGroups, optionGroupProps })), getEditOns(renderOpts, params))) ]; } function getSelectCellValue(renderOpts, { row, column }) { const { options, optionGroups, optionProps = {}, optionGroupProps = {} } = renderOpts; const cellValue = XEUtils.get(row, column.field); let selectItem; const labelProp = optionProps.label || 'label'; const valueProp = optionProps.value || 'value'; if (!(cellValue === null || cellValue === undefined)) { return XEUtils.map(XEUtils.isArray(cellValue) ? cellValue : [cellValue], optionGroups ? (value) => { const groupOptions = optionGroupProps.options || 'options'; for (let index = 0; index < optionGroups.length; index++) { /* eslint-disable eqeqeq */ selectItem = XEUtils.find(optionGroups[index][groupOptions], item => item[valueProp] == value); if (selectItem) { break; } } return selectItem ? selectItem[labelProp] : value; } : (value) => { /* eslint-disable eqeqeq */ selectItem = XEUtils.find(options, item => item[valueProp] == value); return selectItem ? selectItem[labelProp] : value; }).join(', '); } return ''; } function handleExportSelectMethod(params) { const { row, column, options } = params; return options.original ? getCellValue(row, column) : getSelectCellValue(column.editRender || column.cellRender, params); } function getTreeSelectCellValue(renderOpts, { row, column }) { const { options, optionProps = {} } = renderOpts; const cellValue = XEUtils.get(row, column.field); const labelProp = optionProps.label || 'label'; const valueProp = optionProps.value || 'value'; const childrenProp = optionProps.children || 'children'; if (!(cellValue === null || cellValue === undefined)) { const keyMaps = {}; XEUtils.eachTree(options, item => { keyMaps[XEUtils.get(item, valueProp)] = item; }, { children: childrenProp }); return XEUtils.map(XEUtils.isArray(cellValue) ? cellValue : [cellValue], (value) => { const item = keyMaps[value]; return item ? XEUtils.get(item, labelProp) : item; }).join(', '); } return ''; } function handleExportTreeSelectMethod(params) { const { row, column, options } = params; return options.original ? getCellValue(row, column) : getTreeSelectCellValue(column.editRender || column.cellRender, params); } /** * 表格 - 渲染器 */ renderer.mixin({ input: { tableAutoFocus: 'input', renderTableEdit: nativeEditRender, renderTableDefault: nativeEditRender, renderTableFilter: nativeFilterRender, tableFilterDefaultMethod: handleInputFilterMethod }, textarea: { tableAutoFocus: 'textarea', renderTableEdit: nativeEditRender }, select: { renderTableEdit: nativeSelectEditRender, renderTableDefault: nativeSelectEditRender, renderTableCell(renderOpts, params) { return getCellLabelVNs(renderOpts, params, getSelectCellValue(renderOpts, params)); }, renderTableFilter(renderOpts, params) { const { column } = params; return column.filters.map((option, oIndex) => { return h('select', Object.assign(Object.assign({ key: oIndex, class: 'vxe-default-select' }, getNativeAttrs(renderOpts)), getNativeFilterOns(renderOpts, params, option)), renderOpts.optionGroups ? renderNativeOptgroups(renderOpts, params, renderNativeOptions) : renderNativeOptions(renderOpts.options, renderOpts, params)); }); }, tableFilterDefaultMethod: handleFilterMethod, tableExportMethod: handleExportSelectMethod }, VxeInput: { tableAutoFocus: 'input', renderTableEdit: defaultEditRender, renderTableCell(renderOpts, params) { var _a; const { props = {} } = renderOpts; const { row, column } = params; const digits = props.digits || ((_a = getConfig().input) === null || _a === void 0 ? void 0 : _a.digits) || 2; let cellValue = XEUtils.get(row, column.field); if (cellValue) { switch (props.type) { case 'date': case 'week': case 'month': case 'quarter': case 'year': cellValue = getLabelFormatDate(cellValue, props); break; case 'float': cellValue = XEUtils.toFixed(XEUtils.floor(cellValue, digits), digits); break; } } return getCellLabelVNs(renderOpts, params, cellValue); }, renderTableDefault: defaultEditRender, renderTableFilter: defaultFilterRender, tableFilterDefaultMethod: handleInputFilterMethod }, VxeNumberInput: { tableAutoFocus: 'input', renderTableEdit: defaultEditRender, renderTableCell(renderOpts, params) { var _a; const { props = {} } = renderOpts; const { row, column } = params; const digits = props.digits || ((_a = getConfig().numberInput) === null || _a === void 0 ? void 0 : _a.digits) || 2; let cellValue = XEUtils.get(row, column.field); if (cellValue) { switch (props.type) { case 'float': cellValue = XEUtils.toFixed(XEUtils.floor(cellValue, digits), digits); break; } } return getCellLabelVNs(renderOpts, params, cellValue); }, renderTableDefault: defaultEditRender, renderTableFilter: defaultFilterRender, tableFilterDefaultMethod: handleInputFilterMethod }, VxeDatePicker: { tableAutoFocus: 'input', renderTableEdit: defaultEditRender, renderTableCell(renderOpts, params) { const { props = {} } = renderOpts; const { row, column } = params; let cellValue = XEUtils.get(row, column.field); if (cellValue) { cellValue = getLabelFormatDate(cellValue, props); } return getCellLabelVNs(renderOpts, params, cellValue); }, renderTableDefault: defaultEditRender, renderTableFilter: defaultFilterRender, tableFilterDefaultMethod: handleFilterMethod }, VxeTextarea: { tableAutoFocus: 'textarea', renderTableEdit: defaultEditRender, renderTableCell(renderOpts, params) { const { row, column } = params; const cellValue = XEUtils.get(row, column.field); return getCellLabelVNs(renderOpts, params, cellValue); } }, VxeButton: { renderTableDefault: buttonCellRender }, VxeButtonGroup: { renderTableDefault(renderOpts, params) { const { options } = renderOpts; return [ h(getDefaultComponent(renderOpts), Object.assign(Object.assign({ options }, getCellEditProps(renderOpts, params, null)), getComponentOns(renderOpts, params))) ]; } }, VxeSelect: { tableAutoFocus: 'input', renderTableEdit: defaultSelectEditRender, renderTableDefault: defaultSelectEditRender, renderTableCell(renderOpts, params) { return getCellLabelVNs(renderOpts, params, getSelectCellValue(renderOpts, params)); }, renderTableFilter(renderOpts, params) { const { column } = params; const { options, optionProps, optionGroups, optionGroupProps } = renderOpts; return column.filters.map((option, oIndex) => { const optionValue = option.data; return h(getDefaultComponent(renderOpts), Object.assign(Object.assign({ key: oIndex }, getCellEditFilterProps(renderOpts, params, optionValue, { options, optionProps, optionGroups, optionGroupProps })), getFilterOns(renderOpts, params, option))); }); }, tableFilterDefaultMethod: handleFilterMethod, tableExportMethod: handleExportSelectMethod }, VxeTreeSelect: { tableAutoFocus: 'input', renderTableEdit: defaultTreeSelectEditRender, renderTableCell(renderOpts, params) { return getCellLabelVNs(renderOpts, params, getTreeSelectCellValue(renderOpts, params)); }, tableExportMethod: handleExportTreeSelectMethod }, VxeTableSelect: { tableAutoFocus: 'input', renderTableEdit: defaultTreeSelectEditRender, renderTableCell(renderOpts, params) { return getCellLabelVNs(renderOpts, params, getTreeSelectCellValue(renderOpts, params)); }, tableExportMethod: handleExportTreeSelectMethod }, VxeIconPicker: { tableAutoFocus: 'input', renderTableEdit: defaultEditRender, renderTableCell(renderOpts, params) { const { row, column } = params; const cellValue = XEUtils.get(row, column.field); return h('i', { class: cellValue }); } }, VxeRadioGroup: { renderTableDefault: radioAndCheckboxEditRender }, VxeCheckboxGroup: { renderTableDefault: radioAndCheckboxEditRender }, VxeSwitch: { tableAutoFocus: 'button', renderTableEdit: defaultEditRender, renderTableDefault: defaultEditRender }, VxeUpload: { renderTableEdit: defaultEditRender, renderTableCell: defaultEditRender, renderTableDefault: defaultEditRender }, VxeImage: { renderTableDefault(renderOpts, params) { const { row, column } = params; const { props } = renderOpts; const cellValue = getCellValue(row, column); return [ h(getDefaultComponent(renderOpts), Object.assign(Object.assign(Object.assign({}, props), { src: cellValue }), getEditOns(renderOpts, params))) ]; } }, VxeImageGroup: { renderTableDefault(renderOpts, params) { const { row, column } = params; const { props } = renderOpts; const cellValue = getCellValue(row, column); return [ h(getDefaultComponent(renderOpts), Object.assign(Object.assign(Object.assign({}, props), { urlList: cellValue }), getEditOns(renderOpts, params))) ]; } }, VxeTextEllipsis: { renderTableDefault(renderOpts, params) { const { row, column } = params; const { props } = renderOpts; const cellValue = getCellValue(row, column); return [ h(getDefaultComponent(renderOpts), Object.assign(Object.assign(Object.assign({}, props), { content: cellValue }), getEditOns(renderOpts, params))) ]; } }, VxeRate: { renderTableDefault: defaultEditRender }, VxeSlider: { renderTableDefault: defaultEditRender }, // 以下已废弃 $input: { tableAutoFocus: '.vxe-input--inner', renderTableEdit: oldEditRender, renderTableCell(renderOpts, params) { var _a; const { props = {} } = renderOpts; const { row, column } = params; const digits = props.digits || ((_a = getConfig().input) === null || _a === void 0 ? void 0 : _a.digits) || 2; let cellValue = XEUtils.get(row, column.field); if (cellValue) { switch (props.type) { case 'date': case 'week': case 'month': case 'year': cellValue = getLabelFormatDate(cellValue, props); break; case 'float': cellValue = XEUtils.toFixed(XEUtils.floor(cellValue, digits), digits); break; } } return getCellLabelVNs(renderOpts, params, cellValue); }, renderTableDefault: oldEditRender, renderTableFilter: oldFilterRender, tableFilterDefaultMethod: handleInputFilterMethod }, $textarea: { tableAutoFocus: '.vxe-textarea--inner' }, $button: { renderTableDefault: oldButtonEditRender }, $buttons: { renderTableDefault: oldButtonsEditRender }, $select: { tableAutoFocus: '.vxe-input--inner', renderTableEdit: oldSelectEditRender, renderTableDefault: oldSelectEditRender, renderTableCell(renderOpts, params) { return getCellLabelVNs(renderOpts, params, getSelectCellValue(renderOpts, params)); }, renderTableFilter(renderOpts, params) { const { column } = params; const { options, optionProps, optionGroups, optionGroupProps } = renderOpts; return column.filters.map((option, oIndex) => { const optionValue = option.data; return h(getOldComponent(renderOpts), Object.assign(Object.assign({ key: oIndex }, getCellEditFilterProps(renderOpts, params, optionValue, { options, optionProps, optionGroups, optionGroupProps })), getFilterOns(renderOpts, params, option))); }); }, tableFilterDefaultMethod: handleFilterMethod, tableExportMethod: handleExportSelectMethod }, $radio: { tableAutoFocus: '.vxe-radio--input' }, $checkbox: { tableAutoFocus: '.vxe-checkbox--input' }, $switch: { tableAutoFocus: '.vxe-switch--button', renderTableEdit: oldEditRender, renderTableDefault: oldEditRender } // 以上已废弃 });