vxe-table 4.1.21 → 4.2.0-beta.0

package/packages/table/src/props.ts

@@ -12,7 +12,7 @@ export default {
   height: [Number, String] as PropType<VxeTablePropTypes.Height>,
   // 表格的最大高度
   maxHeight: [Number, String] as PropType<VxeTablePropTypes.MaxHeight>,
-  // 所有列是否允许拖动列宽调整大小
+  // （即将废弃）所有列是否允许拖动列宽调整大小
   resizable: { type: Boolean as PropType<VxeTablePropTypes.Resizable>, default: () => GlobalConfig.table.resizable },
   // 是否带有斑马纹
   stripe: { type: Boolean as PropType<VxeTablePropTypes.Stripe>, default: () => GlobalConfig.table.stripe },
@@ -88,9 +88,11 @@ export default {
   showFooterOverflow: { type: [Boolean, String] as PropType<VxeTablePropTypes.ShowFooterOverflow>, default: () => GlobalConfig.table.showFooterOverflow },
 
   /** 高级属性 */
-  // 主键配置
+  // （即将废弃）columnKey 已废弃，被 column-config.useKey 替换
   columnKey: Boolean as PropType<VxeTablePropTypes.ColumnKey>,
+  // （即将废弃）rowKey 已废弃，被 row-config.useKey 替换
   rowKey: Boolean as PropType<VxeTablePropTypes.RowKey>,
+  // （即将废弃）rowId 已废弃，被 row-config.keyField 替换
   rowId: { type: String as PropType<VxeTablePropTypes.RowId>, default: () => GlobalConfig.table.rowId },
   zIndex: Number as PropType<VxeTablePropTypes.ZIndex>,
   emptyText: { type: String as PropType<VxeTablePropTypes.EmptyText>, default: () => GlobalConfig.table.emptyText },
@@ -155,6 +157,7 @@ export default {
   scrollY: Object as PropType<VxeTablePropTypes.ScrollY>,
   // （即将废弃）优化相关
   animat: { type: Boolean as PropType<VxeTablePropTypes.Animat>, default: () => GlobalConfig.table.animat },
+  // （可能会被废弃的参数，不要使用）
   delayHover: { type: Number as PropType<VxeTablePropTypes.DelayHover>, default: () => GlobalConfig.table.delayHover as number },
   // 额外的参数
   params: Object as PropType<VxeTablePropTypes.Params>

package/packages/table/src/table.ts

@@ -1,7 +1,8 @@
 import { defineComponent, getCurrentInstance, h, createCommentVNode, ComponentPublicInstance, resolveComponent, ComponentOptions, reactive, ref, Ref, provide, inject, nextTick, onActivated, onDeactivated, onBeforeUnmount, onUnmounted, watch, computed, ComputedRef, onMounted } from 'vue'
 import XEUtils from 'xe-utils'
 import { browse, isPx, isScale, hasClass, addClass, removeClass, getEventTargetNode, getPaddingTopBottomSize, setScrollTop, setScrollLeft, isNodeElement } from '../../tools/dom'
-import { warnLog, errLog, getLog, getLastZIndex, nextZIndex, hasChildrenList, getFuncText, isEnableConf, formatText, eqEmptyValue } from '../../tools/utils'
+import { getLastZIndex, nextZIndex, hasChildrenList, getFuncText, isEnableConf, formatText, eqEmptyValue } from '../../tools/utils'
+import { warnLog, errLog, getLog } from '../../tools/log'
 import { createResizeEvent, XEResizeObserver } from '../../tools/resize'
 import { GlobalEvent, hasEventKey, EVENT_KEYS } from '../../tools/event'
 import { useSize } from '../../hooks/size'
@@ -5718,16 +5719,26 @@ export default defineComponent({
         const radioOpts = computeRadioOpts.value
         const checkboxOpts = computeCheckboxOpts.value
         const expandOpts = computeExpandOpts.value
+        const rowOpts = computeRowOpts.value
 
         if (process.env.VUE_APP_VXE_TABLE_ENV === 'development') {
-          if (!props.rowId && (checkboxOpts.reserve || checkboxOpts.checkRowKeys || radioOpts.reserve || radioOpts.checkRowKey || expandOpts.expandRowKeys || treeOpts.expandRowKeys)) {
-            warnLog('vxe.error.reqProp', ['row-id'])
+          // if (props.rowId) {
+          //   warnLog('vxe.error.delProp', ['rowId', 'row-config.keyField'])
+          // }
+          // if (props.rowKey) {
+          //   warnLog('vxe.error.delProp', ['rowId', 'row-config.useKey'])
+          // }
+          // if (props.columnKey) {
+          //   warnLog('vxe.error.delProp', ['rowId', 'column-config.useKey'])
+          // }
+          if (!(props.rowId || rowOpts.keyField) && (checkboxOpts.reserve || checkboxOpts.checkRowKeys || radioOpts.reserve || radioOpts.checkRowKey || expandOpts.expandRowKeys || treeOpts.expandRowKeys)) {
+            warnLog('vxe.error.reqProp', ['row-config.keyField'])
           }
           if (props.editConfig && (editOpts.showStatus || editOpts.showUpdateStatus || editOpts.showInsertStatus) && !props.keepSource) {
             warnLog('vxe.error.reqProp', ['keep-source'])
           }
-          if (treeConfig && treeOpts.line && (!props.rowKey || !showOverflow)) {
-            warnLog('vxe.error.reqProp', ['row-key | show-overflow'])
+          if (treeConfig && treeOpts.line && (!props.rowKey || !rowOpts.useKey || !showOverflow)) {
+            warnLog('vxe.error.reqProp', ['row-config.useKey | show-overflow'])
           }
           if (treeConfig && props.stripe) {
             warnLog('vxe.error.noTree', ['stripe'])

package/packages/table/src/util.ts

@@ -44,14 +44,16 @@ export function getRowUniqueId () {
 // 行主键 key
 export function getRowkey ($xetable: VxeTableConstructor) {
   const { props } = $xetable
+  const { computeRowOpts } = $xetable.getComputeMaps()
   const { rowId } = props
-  return rowId || '_X_ID'
+  const rowOpts = computeRowOpts.value
+  return rowId || rowOpts.keyField || '_X_ID'
 }
 
 // 行主键 value
 export function getRowid ($xetable: VxeTableConstructor, row: any) {
-  const rowId = XEUtils.get(row, getRowkey($xetable))
-  return XEUtils.eqNull(rowId) ? '' : encodeURIComponent(rowId)
+  const rowid = XEUtils.get(row, getRowkey($xetable))
+  return XEUtils.eqNull(rowid) ? '' : encodeURIComponent(rowid)
 }
 
 export interface XEColumnInstance {

package/packages/toolbar/src/toolbar.ts

@@ -4,7 +4,8 @@ import GlobalConfig from '../../v-x-e-table/src/conf'
 import { VXETable } from '../../v-x-e-table'
 import { useSize } from '../../hooks/size'
 import { getEventTargetNode } from '../../tools/dom'
-import { warnLog, errLog, formatText } from '../../tools/utils'
+import { formatText } from '../../tools/utils'
+import { warnLog, errLog } from '../../tools/log'
 import { GlobalEvent } from '../../tools/event'
 
 import { VxeGridConstructor, GridPrivateMethods, ToolbarMethods, VxeToolbarConstructor, VxeToolbarEmits, VxeToolbarPropTypes, VxeTableConstructor, ToolbarPrivateRef, VxeTableMethods, VxeTablePrivateMethods, ToolbarReactData, VxeTableDefines } from '../../../types/all'

package/packages/tools/log.ts

@@ -0,0 +1,16 @@
+import GlobalConfig from '../v-x-e-table/src/conf'
+
+export function getLog (message: string, params?: any) {
+  return `[vxe-table v${process.env.VUE_APP_VXE_TABLE_VERSION}] ${GlobalConfig.i18n(message, params)}`
+}
+
+function outLog (type: 'log' | 'warn' | 'error') {
+  return function (message: string, params?: any) {
+    const msg = getLog(message, params)
+    console[type](msg)
+    return msg
+  }
+}
+
+export const warnLog = outLog('warn')
+export const errLog = outLog('error')

package/packages/tools/utils.ts

@@ -4,18 +4,6 @@ import GlobalConfig from '../v-x-e-table/src/conf'
 let zindexIndex = 0
 let lastZindex = 1
 
-export function getLog (message: string, params?: any) {
-  return `[vxe-table] ${GlobalConfig.i18n(message, params)}`
-}
-
-function outLog (type: 'log' | 'warn' | 'error') {
-  return function (message: string, params?: any) {
-    const msg = getLog(message, params)
-    console[type](msg)
-    return msg
-  }
-}
-
 export function isEnableConf (conf: any): boolean {
   return conf && conf.enabled !== false
 }
@@ -41,9 +29,6 @@ export function getLastZIndex () {
   return lastZindex
 }
 
-export const warnLog = outLog('warn')
-export const errLog = outLog('error')
-
 export function hasChildrenList (item: any) {
   return item && item.children && item.children.length > 0
 }

package/packages/v-x-e-table/index.ts

@@ -77,6 +77,7 @@ export const v = 'v4'
 
 export const VXETable = {
   v,
+  version: process.env.VUE_APP_VXE_TABLE_VERSION,
   setup,
   interceptor,
   renderer,

package/packages/v-x-e-table/src/conf.ts

@@ -28,6 +28,9 @@ const GlobalConfig: VXETableGlobalConfig = {
     // emptyRender: {
     //   name: ''
     // },
+    // rowConfig: {
+    //   keyField: '_X_ID' // 行数据的唯一主键字段名
+    // },
     radioConfig: {
       // trigger: 'default'
       strict: true
@@ -51,7 +54,6 @@ const GlobalConfig: VXETableGlobalConfig = {
     //  storage: false,
     //  checkMethod () {}
     // },
-    // rowId: '_X_ID', // 行数据的唯一主键字段名
     sortConfig: {
       // remote: false,
       // trigger: 'default',

package/packages/v-x-e-table/src/interceptor.ts

@@ -1,5 +1,5 @@
 import XEUtils from 'xe-utils'
-import { warnLog } from '../../tools/utils'
+import { warnLog } from '../../tools/log'
 
 import { VxeGlobalInterceptor, VxeGlobalInterceptorHandles } from '../../../types/v-x-e-table'
 

package/packages/v-x-e-table/src/renderer.ts

@@ -2,7 +2,8 @@ import { h, resolveComponent, ComponentOptions } from 'vue'
 import XEUtils from 'xe-utils'
 import GlobalConfig from './conf'
 import { getCellValue, setCellValue } from '../../table/src/util'
-import { warnLog, getFuncText, formatText, isEmptyValue } from '../../tools/utils'
+import { getFuncText, formatText, isEmptyValue } from '../../tools/utils'
+import { warnLog } from '../../tools/log'
 import { getOnName } from '../../tools/vn'
 
 import { VxeGlobalRendererHandles, VxeGlobalRenderer, VxeColumnPropTypes } from '../../../types/all'

package/packages/v-x-e-table/src/store.ts

@@ -1,4 +1,4 @@
-import { warnLog } from '../../tools/utils'
+import { warnLog } from '../../tools/log'
 import XEUtils from 'xe-utils'
 
 /**

package/types/table.d.ts

@@ -1223,6 +1223,7 @@ export namespace VxeTablePropTypes {
    * 列配置信息
    */
   export interface ColumnConfig {
+    useKey?: boolean;
     isCurrent?: boolean;
     isHover?: boolean;
     resizable?: VxeColumnPropTypes.Resizable;
@@ -1235,6 +1236,8 @@ export namespace VxeTablePropTypes {
    * 行配置信息
    */
   export interface RowConfig {
+    useKey?: boolean;
+    keyField?: string;
     isCurrent?: boolean;
     isHover?: boolean;
     height?: number;
@@ -1939,6 +1942,10 @@ export type VxeTableProps<D = any> = {
   data?: VxeTablePropTypes.Data<D>;
   height?: VxeTablePropTypes.Height;
   maxHeight?: VxeTablePropTypes.MaxHeight;
+  /**
+   * 不建议使用，后续废弃
+   * @deprecated
+   */
   resizable?: VxeTablePropTypes.Resizable;
   stripe?: VxeTablePropTypes.Stripe;
   round?: VxeTablePropTypes.Round;
@@ -1952,6 +1959,10 @@ export type VxeTableProps<D = any> = {
   highlightHoverRow?: VxeTablePropTypes.HighlightHoverRow;
   highlightCurrentColumn?: VxeTablePropTypes.HighlightCurrentColumn;
   highlightHoverColumn?: VxeTablePropTypes.HighlightHoverColumn;
+  /**
+   * 已废弃
+   * @deprecated
+   */
   highlightCell?: VxeTablePropTypes.HighlightCell;
   showFooter?: VxeTablePropTypes.ShowFooter;
   footerMethod?: VxeTablePropTypes.FooterMethod;
@@ -1974,8 +1985,20 @@ export type VxeTableProps<D = any> = {
   showOverflow?: VxeTablePropTypes.ShowOverflow;
   showHeaderOverflow?: VxeTablePropTypes.ShowHeaderOverflow;
   showFooterOverflow?: VxeTablePropTypes.ShowFooterOverflow;
+  /**
+   * 请使用 column-config.useKey
+   * @deprecated
+   */
   columnKey?: VxeTablePropTypes.ColumnKey;
+  /**
+   * 请使用 row-config.useKey
+   * @deprecated
+   */
   rowKey?: VxeTablePropTypes.RowKey;
+  /**
+   * 请使用 row-config.keyField
+   * @deprecated
+   */
   rowId?: VxeTablePropTypes.RowId;
   keepSource?: VxeTablePropTypes.KeepSource;
   autoResize?: VxeTablePropTypes.AutoResize;
@@ -2006,8 +2029,20 @@ export type VxeTableProps<D = any> = {
   editRules?: VxeTablePropTypes.EditRules;
   emptyText?: VxeTablePropTypes.EmptyText;
   emptyRender?: VxeTablePropTypes.EmptyRender;
+  /**
+   * 不建议使用，后续废弃
+   * @deprecated
+   */
   fit?: VxeTablePropTypes.Fit;
+  /**
+   * 不建议使用，后续废弃
+   * @deprecated
+   */
   animat?: VxeTablePropTypes.Animat;
+  /**
+   * 不建议使用，后续废弃
+   * @deprecated
+   */
   delayHover?: VxeTablePropTypes.DelayHover;
   scrollX?: VxeTablePropTypes.ScrollX;
   scrollY?: VxeTablePropTypes.ScrollY;

package/types/v-x-e-table/index.d.ts

@@ -59,7 +59,15 @@ export const v: VXETableVersion
 
 export interface VXETableCore {
   tooltip?: boolean;
+  /**
+   * 已被 version 替换
+   * @deprecated
+   */
   v: VXETableVersion;
+  /**
+   * 版本号
+   */
+  version: string;
   /**
    * 设置全局参数/获取所有参数
    */