UNPKG

xdesign-vue-next

Version:

XDesign Component for vue-next

1 lines 17.2 kB
{"version":3,"file":"base-table-props.mjs","sources":["../../src/table/base-table-props.ts"],"sourcesContent":["/* eslint-disable */\n\n/**\n * 该文件为脚本自动生成文件,请勿随意修改。如需修改请联系 PMC\n * */\n\nimport { TdBaseTableProps } from '../table/type';\nimport { PropType } from 'vue';\n\nexport default {\n /** 已废弃。是否允许调整列宽。请更为使用 `resizable` */\n allowResizeColumnWidth: {\n type: Boolean,\n default: undefined,\n },\n /** 超出省略等所有浮层元素统一绑定到 `attach`,可根据实际情况调整挂载元素 */\n attach: {\n type: [String, Function] as PropType<TdBaseTableProps['attach']>,\n },\n /** 是否显示表格边框 */\n bordered: Boolean,\n /** 表格底部内容,可以用于自定义列设置等 */\n bottomContent: {\n type: [String, Function] as PropType<TdBaseTableProps['bottomContent']>,\n },\n /** 单元格数据为空时呈现的内容 */\n cellEmptyContent: {\n type: [String, Function] as PropType<TdBaseTableProps['cellEmptyContent']>,\n },\n /** 列配置,泛型 T 指表格数据类型 */\n columns: {\n type: Array as PropType<TdBaseTableProps['columns']>,\n default: (): TdBaseTableProps['columns'] => [],\n },\n /** 数据源,泛型 T 指表格数据类型 */\n data: {\n type: Array as PropType<TdBaseTableProps['data']>,\n default: (): TdBaseTableProps['data'] => [],\n },\n /** 是否禁用本地数据分页。当 `data` 数据长度超过分页大小时,会自动进行本地数据分页。如果 `disableDataPage` 设置为 true,则无论何时,都不会进行本地数据分页 */\n disableDataPage: Boolean,\n /** 空表格呈现样式,支持全局配置 `GlobalConfigProvider` */\n empty: {\n type: [String, Function] as PropType<TdBaseTableProps['empty']>,\n default: '' as TdBaseTableProps['empty'],\n },\n /** 首行内容,横跨所有列 */\n firstFullRow: {\n type: [String, Function] as PropType<TdBaseTableProps['firstFullRow']>,\n },\n /** 固定行(冻结行),示例:[M, N],表示冻结表头 M 行和表尾 N 行。M 和 N 值为 0 时,表示不冻结行 */\n fixedRows: {\n type: Array as PropType<TdBaseTableProps['fixedRows']>,\n },\n /** 表尾数据源,泛型 T 指表格数据类型 */\n footData: {\n type: Array as PropType<TdBaseTableProps['footData']>,\n default: (): TdBaseTableProps['footData'] => [],\n },\n /** 已废弃。请更为使用 `footerAffixedBottom`。表尾吸底基于 Affix 组件开发,透传全部 Affix 组件属性。 */\n footerAffixProps: {\n type: Object as PropType<TdBaseTableProps['footerAffixProps']>,\n },\n /** 表尾吸底。使用此向功能,需要非常注意表格是相对于哪一个父元素进行滚动。值为 `true`,则表示相对于整个窗口吸底。如果表格滚动的父元素不是整个窗口,请通过 `footerAffixedBottom.container` 调整固钉的吸顶范围。基于 Affix 组件开发,透传全部 Affix 组件属性 */\n footerAffixedBottom: {\n type: [Boolean, Object] as PropType<TdBaseTableProps['footerAffixedBottom']>,\n default: false as TdBaseTableProps['footerAffixedBottom'],\n },\n /** 表尾总结行 */\n footerSummary: {\n type: [String, Function] as PropType<TdBaseTableProps['footerSummary']>,\n },\n /** 已废弃。请更为使用 `headerAffixedTop`。表头吸顶基于 Affix 组件开发,透传全部 Affix 组件属性 */\n headerAffixProps: {\n type: Object as PropType<TdBaseTableProps['headerAffixProps']>,\n },\n /** 表头吸顶。使用该功能,需要非常注意表格是相对于哪一个父元素进行滚动。值为 `true`,表示相对于整个窗口吸顶。如果表格滚动的父元素不是整个窗口,请通过 `headerAffixedTop.container` 调整吸顶的位置。基于 Affix 组件开发,透传全部 Affix 组件属性。 */\n headerAffixedTop: {\n type: [Boolean, Object] as PropType<TdBaseTableProps['headerAffixedTop']>,\n default: false as TdBaseTableProps['headerAffixedTop'],\n },\n /** 表格高度,超出后会出现滚动条。示例:100, '30%', '300'。值为数字类型,会自动加上单位 px。如果不是绝对固定表格高度,建议使用 `maxHeight` */\n height: {\n type: [String, Number] as PropType<TdBaseTableProps['height']>,\n },\n /** 滚动条吸底。基于 Affix 组件开发,透传全部 Affix 组件属性 */\n horizontalScrollAffixedBottom: {\n type: [Boolean, Object] as PropType<TdBaseTableProps['horizontalScrollAffixedBottom']>,\n },\n /** 是否显示鼠标悬浮状态 */\n hover: Boolean,\n /** 尾行内容,横跨所有列 */\n lastFullRow: {\n type: [String, Function] as PropType<TdBaseTableProps['lastFullRow']>,\n },\n /** 是否启用整个表格元素的懒加载,当页面滚动到可视区域后再渲染表格。注意和表格内部行滚动懒加载的区别,内部行滚动无论表格是否在可视区域都会默认渲染第一屏的行元素 */\n lazyLoad: Boolean,\n /** 加载中状态。值为 `true` 会显示默认加载中样式,可以通过 Function 和 插槽 自定义加载状态呈现内容和样式。值为 `false` 则会取消加载状态 */\n loading: {\n type: [Boolean, Function] as PropType<TdBaseTableProps['loading']>,\n default: undefined as TdBaseTableProps['loading'],\n },\n /** 透传加载组件全部属性 */\n loadingProps: {\n type: Object as PropType<TdBaseTableProps['loadingProps']>,\n },\n /** 表格最大高度,超出后会出现滚动条。示例:100, '30%', '300'。值为数字类型,会自动加上单位 px */\n maxHeight: {\n type: [String, Number] as PropType<TdBaseTableProps['maxHeight']>,\n },\n /** 分页配置,值为空则不显示。具体 API 参考分页组件。当 `data` 数据长度超过分页大小时,会自动对本地数据 `data` 进行排序,如果不希望对于 `data` 进行排序,可以设置 `disableDataPage = true` */\n pagination: {\n type: Object as PropType<TdBaseTableProps['pagination']>,\n },\n /** 分页吸底。基于 Affix 组件开发,透传全部 Affix 组件属性 */\n paginationAffixedBottom: {\n type: [Boolean, Object] as PropType<TdBaseTableProps['paginationAffixedBottom']>,\n },\n /** 是否允许调整列宽,设置 `tableLayout=fixed` 效果更友好,此时不允许通过 CSS 设置 `table`元素宽度,也不允许设置 `tableContentWidth`。一般不建议在列宽调整场景使用 `tableLayout: auto`。如果想要配置宽度可调整的最小值和最大值,请使用 `column.resize`,示例:`columns: [{ resize: { minWidth: 120, maxWidth: 300 } }]`。<br/> 默认规则:因列宽超出存在横向滚动条时,列宽调整仅影响当前列宽和总列宽;表格列较少没有横向滚动条时,列宽调整表现为自身宽度和相邻宽度变化 */\n resizable: Boolean,\n /** HTML 标签 `tr` 的属性。类型为 Function 时,参数说明:`params.row` 表示行数据;`params.rowIndex` 表示行下标;`params.type=body` 表示属性作用于 `tbody` 中的元素;`params.type=foot` 表示属性作用于 `tfoot` 中的元素。<br />示例一:{ draggable: true },<br />示例二:[{ draggable: true }, { title: '超出省略显示' }]。<br /> 示例三:() => [{ draggable: true }] */\n rowAttributes: {\n type: [Object, Array, Function] as PropType<TdBaseTableProps['rowAttributes']>,\n },\n /** 行类名,泛型 T 指表格数据类型。`params.row` 表示行数据;`params.rowIndex` 表示行下标;`params.type=body` 表示类名作用于 `tbody` 中的元素;`params.type= tfoot` 表示类名作用于 `tfoot` 中的元素 */\n rowClassName: {\n type: [String, Object, Array, Function] as PropType<TdBaseTableProps['rowClassName']>,\n },\n /** 唯一标识一行数据的字段名,来源于 `data` 中的字段。如果是字段嵌套多层,可以设置形如 `item.a.id` 的方法 */\n rowKey: {\n type: String,\n default: 'id',\n required: true,\n },\n /** 用于自定义合并单元格,泛型 T 指表格数据类型。示例:`({ row, col, rowIndex, colIndex }) => { rowspan: 2, colspan: 3 }` */\n rowspanAndColspan: {\n type: Function as PropType<TdBaseTableProps['rowspanAndColspan']>,\n },\n /** 用于自定义表尾的合并单元格,泛型 T 指表格数据类型。示例:`({ row, col, rowIndex, colIndex }) => { rowspan: 2, colspan: 3 }` */\n rowspanAndColspanInFooter: {\n type: Function as PropType<TdBaseTableProps['rowspanAndColspanInFooter']>,\n },\n /** 懒加载和虚拟滚动。为保证组件收益最大化,当数据量小于阈值 `scroll.threshold` 时,无论虚拟滚动的配置是否存在,组件内部都不会开启虚拟滚动,`scroll.threshold` 默认为 `100` */\n scroll: {\n type: Object as PropType<TdBaseTableProps['scroll']>,\n },\n /** 是否显示表头 */\n showHeader: {\n type: Boolean,\n default: true,\n },\n /** 表格尺寸 */\n size: {\n type: String as PropType<TdBaseTableProps['size']>,\n default: 'medium' as TdBaseTableProps['size'],\n validator(val: TdBaseTableProps['size']): boolean {\n if (!val) return true;\n return ['small', 'medium', 'large'].includes(val);\n },\n },\n /** 是否显示斑马纹 */\n stripe: Boolean,\n /** 表格内容的总宽度,注意不是表格可见宽度。主要应用于 `table-layout: auto` 模式下的固定列显示。`tableContentWidth` 内容宽度的值必须大于表格可见宽度 */\n tableContentWidth: {\n type: String,\n default: '',\n },\n /** 表格布局方式,`<table>` 元素原生属性。[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。注意,在列宽调整下场景只能使用 `fixed` 模式 */\n tableLayout: {\n type: String as PropType<TdBaseTableProps['tableLayout']>,\n default: 'fixed' as TdBaseTableProps['tableLayout'],\n validator(val: TdBaseTableProps['tableLayout']): boolean {\n if (!val) return true;\n return ['auto', 'fixed'].includes(val);\n },\n },\n /** 表格顶部内容,可以用于自定义列设置、顶部查询条件等 */\n topContent: {\n type: [String, Function] as PropType<TdBaseTableProps['topContent']>,\n },\n /** 行内容上下方向对齐 */\n verticalAlign: {\n type: String as PropType<TdBaseTableProps['verticalAlign']>,\n default: 'middle' as TdBaseTableProps['verticalAlign'],\n validator(val: TdBaseTableProps['verticalAlign']): boolean {\n if (!val) return true;\n return ['top', 'middle', 'bottom'].includes(val);\n },\n },\n /** 单元格点击时触发 */\n onCellClick: Function as PropType<TdBaseTableProps['onCellClick']>,\n /** 列调整大小之后触发。`context.columnsWidth` 表示操作后各个列的宽度; */\n onColumnResizeChange: Function as PropType<TdBaseTableProps['onColumnResizeChange']>,\n /** 分页发生变化时触发。参数 newDataSource 表示分页后的数据。本地数据进行分页时,newDataSource 和源数据 data 会不一样。泛型 T 指表格数据类型 */\n onPageChange: Function as PropType<TdBaseTableProps['onPageChange']>,\n /** 行点击时触发,泛型 T 指表格数据类型 */\n onRowClick: Function as PropType<TdBaseTableProps['onRowClick']>,\n /** 行双击时触发,泛型 T 指表格数据类型 */\n onRowDblclick: Function as PropType<TdBaseTableProps['onRowDblclick']>,\n /** 鼠标在表格行按下时触发,泛型 T 指表格数据类型 */\n onRowMousedown: Function as PropType<TdBaseTableProps['onRowMousedown']>,\n /** 鼠标在表格行进入时触发,泛型 T 指表格数据类型 */\n onRowMouseenter: Function as PropType<TdBaseTableProps['onRowMouseenter']>,\n /** 鼠标在表格行离开时触发,泛型 T 指表格数据类型 */\n onRowMouseleave: Function as PropType<TdBaseTableProps['onRowMouseleave']>,\n /** 鼠标悬浮到行时触发,泛型 T 指表格数据类型 */\n onRowMouseover: Function as PropType<TdBaseTableProps['onRowMouseover']>,\n /** 鼠标在表格行按下又弹起时触发,泛型 T 指表格数据类型 */\n onRowMouseup: Function as PropType<TdBaseTableProps['onRowMouseup']>,\n /** 表格内容滚动时触发 */\n onScroll: Function as PropType<TdBaseTableProps['onScroll']>,\n /** 已废弃。表格内容横向滚动时触发。请更为使用 `onScroll` 事件 */\n onScrollX: Function as PropType<TdBaseTableProps['onScrollX']>,\n /** 已废弃。表格内容纵向滚动时触发。当内容超出高度(height)或最大高度(max-height)时,会出现纵向滚动条。请更为使用 `onScroll` 事件 */\n onScrollY: Function as PropType<TdBaseTableProps['onScrollY']>,\n};\n"],"names":["allowResizeColumnWidth","type","attach","bordered","bottomContent","cellEmptyContent","columns","data","disableDataPage","empty","firstFullRow","fixedRows","footData","footerAffixProps","footerAffixedBottom","footerSummary","headerAffixProps","headerAffixedTop","height","horizontalScrollAffixedBottom","hover","lastFullRow","lazyLoad","loading","loadingProps","maxHeight","pagination","paginationAffixedBottom","resizable","rowAttributes","rowClassName","rowKey","required","rowspanAndColspan","rowspanAndColspanInFooter","scroll","showHeader","size","stripe","tableContentWidth","tableLayout","topContent","verticalAlign","onCellClick","onColumnResizeChange","onPageChange","onRowClick","onRowDblclick","onRowMousedown","onRowMouseenter","onRowMouseleave","onRowMouseover","onRowMouseup","onScroll","onScrollX","onScrollY"],"mappings":";;;;;;AASA,sCAAA,qBAAA;AAEEA,EAAAA,sBAAAA,EAAAA;AACEC,IAAAA,IAAAA,EAAAA,OAAAA;AACA,IAAA,SAAA,EAAA,KAAA,CAAA;;AAGFC,EAAAA,MAAAA,EAAAA;AACED,IAAAA,IAAAA,EAAAA,CAAAA,MAAAA,EAAAA,QAAAA,CAAAA;;AAGFE,EAAAA,QAAAA,EAAAA,OAAAA;AAEAC,EAAAA,aAAAA,EAAAA;AACEH,IAAAA,IAAAA,EAAAA,CAAAA,MAAAA,EAAAA,QAAAA,CAAAA;;AAGFI,EAAAA,gBAAAA,EAAAA;AACEJ,IAAAA,IAAAA,EAAAA,CAAAA,MAAAA,EAAAA,QAAAA,CAAAA;;AAGFK,EAAAA,OAAAA,EAAAA;AACEL,IAAAA,IAAAA,EAAAA,KAAAA;AACA,IAAA,SAAA,EAAA,SAAA,QAAA,GAAA;AAAS,MAAA,OAAA,EAAA,CAAA;AAAoC,KAAA;;AAG/CM,EAAAA,IAAAA,EAAAA;AACEN,IAAAA,IAAAA,EAAAA,KAAAA;AACA,IAAA,SAAA,EAAA,SAAA,QAAA,GAAA;AAAS,MAAA,OAAA,EAAA,CAAA;AAAiC,KAAA;;AAG5CO,EAAAA,eAAAA,EAAAA,OAAAA;AAEAC,EAAAA,KAAAA,EAAAA;AACER,IAAAA,IAAAA,EAAAA,CAAAA,MAAAA,EAAAA,QAAAA,CAAAA;;;AAIFS,EAAAA,YAAAA,EAAAA;AACET,IAAAA,IAAAA,EAAAA,CAAAA,MAAAA,EAAAA,QAAAA,CAAAA;;AAGFU,EAAAA,SAAAA,EAAAA;AACEV,IAAAA,IAAAA,EAAAA,KAAAA;;AAGFW,EAAAA,QAAAA,EAAAA;AACEX,IAAAA,IAAAA,EAAAA,KAAAA;AACA,IAAA,SAAA,EAAA,SAAA,QAAA,GAAA;AAAS,MAAA,OAAA,EAAA,CAAA;AAAqC,KAAA;;AAGhDY,EAAAA,gBAAAA,EAAAA;AACEZ,IAAAA,IAAAA,EAAAA,MAAAA;;AAGFa,EAAAA,mBAAAA,EAAAA;AACEb,IAAAA,IAAAA,EAAAA,CAAAA,OAAAA,EAAAA,MAAAA,CAAAA;;;AAIFc,EAAAA,aAAAA,EAAAA;AACEd,IAAAA,IAAAA,EAAAA,CAAAA,MAAAA,EAAAA,QAAAA,CAAAA;;AAGFe,EAAAA,gBAAAA,EAAAA;AACEf,IAAAA,IAAAA,EAAAA,MAAAA;;AAGFgB,EAAAA,gBAAAA,EAAAA;AACEhB,IAAAA,IAAAA,EAAAA,CAAAA,OAAAA,EAAAA,MAAAA,CAAAA;;;AAIFiB,EAAAA,MAAAA,EAAAA;AACEjB,IAAAA,IAAAA,EAAAA,CAAAA,MAAAA,EAAAA,MAAAA,CAAAA;;AAGFkB,EAAAA,6BAAAA,EAAAA;AACElB,IAAAA,IAAAA,EAAAA,CAAAA,OAAAA,EAAAA,MAAAA,CAAAA;;AAGFmB,EAAAA,KAAAA,EAAAA,OAAAA;AAEAC,EAAAA,WAAAA,EAAAA;AACEpB,IAAAA,IAAAA,EAAAA,CAAAA,MAAAA,EAAAA,QAAAA,CAAAA;;AAGFqB,EAAAA,QAAAA,EAAAA,OAAAA;AAEAC,EAAAA,OAAAA,EAAAA;AACEtB,IAAAA,IAAAA,EAAAA,CAAAA,OAAAA,EAAAA,QAAAA,CAAAA;AACA,IAAA,SAAA,EAAA,KAAA,CAAA;;AAGFuB,EAAAA,YAAAA,EAAAA;AACEvB,IAAAA,IAAAA,EAAAA,MAAAA;;AAGFwB,EAAAA,SAAAA,EAAAA;AACExB,IAAAA,IAAAA,EAAAA,CAAAA,MAAAA,EAAAA,MAAAA,CAAAA;;AAGFyB,EAAAA,UAAAA,EAAAA;AACEzB,IAAAA,IAAAA,EAAAA,MAAAA;;AAGF0B,EAAAA,uBAAAA,EAAAA;AACE1B,IAAAA,IAAAA,EAAAA,CAAAA,OAAAA,EAAAA,MAAAA,CAAAA;;AAGF2B,EAAAA,SAAAA,EAAAA,OAAAA;AAEAC,EAAAA,aAAAA,EAAAA;AACE5B,IAAAA,IAAAA,EAAAA,CAAAA,MAAAA,EAAAA,KAAAA,EAAAA,QAAAA,CAAAA;;AAGF6B,EAAAA,YAAAA,EAAAA;;;AAIAC,EAAAA,MAAAA,EAAAA;AACE9B,IAAAA,IAAAA,EAAAA,MAAAA;AACA,IAAA,SAAA,EAAA,IAAA;AACA+B,IAAAA,QAAAA,EAAAA,IAAAA;;AAGFC,EAAAA,iBAAAA,EAAAA;AACEhC,IAAAA,IAAAA,EAAAA,QAAAA;;AAGFiC,EAAAA,yBAAAA,EAAAA;AACEjC,IAAAA,IAAAA,EAAAA,QAAAA;;AAGFkC,EAAAA,MAAAA,EAAAA;AACElC,IAAAA,IAAAA,EAAAA,MAAAA;;AAGFmC,EAAAA,UAAAA,EAAAA;AACEnC,IAAAA,IAAAA,EAAAA,OAAAA;;;AAIFoC,EAAAA,IAAAA,EAAAA;AACEpC,IAAAA,IAAAA,EAAAA,MAAAA;AACA,IAAA,SAAA,EAAA,QAAA;;AAEE,MAAA,IAAA,CAAA,GAAA,EAAA,OAAA,IAAA,CAAA;;AAEF,KAAA;;AAGFqC,EAAAA,MAAAA,EAAAA,OAAAA;AAEAC,EAAAA,iBAAAA,EAAAA;AACEtC,IAAAA,IAAAA,EAAAA,MAAAA;;;AAIFuC,EAAAA,WAAAA,EAAAA;AACEvC,IAAAA,IAAAA,EAAAA,MAAAA;AACA,IAAA,SAAA,EAAA,OAAA;;AAEE,MAAA,IAAA,CAAA,GAAA,EAAA,OAAA,IAAA,CAAA;;AAEF,KAAA;;AAGFwC,EAAAA,UAAAA,EAAAA;AACExC,IAAAA,IAAAA,EAAAA,CAAAA,MAAAA,EAAAA,QAAAA,CAAAA;;AAGFyC,EAAAA,aAAAA,EAAAA;AACEzC,IAAAA,IAAAA,EAAAA,MAAAA;AACA,IAAA,SAAA,EAAA,QAAA;;AAEE,MAAA,IAAA,CAAA,GAAA,EAAA,OAAA,IAAA,CAAA;;AAEF,KAAA;;AAGF0C,EAAAA,WAAAA,EAAAA,QAAAA;AAEAC,EAAAA,oBAAAA,EAAAA,QAAAA;AAEAC,EAAAA,YAAAA,EAAAA,QAAAA;AAEAC,EAAAA,UAAAA,EAAAA,QAAAA;AAEAC,EAAAA,aAAAA,EAAAA,QAAAA;AAEAC,EAAAA,cAAAA,EAAAA,QAAAA;AAEAC,EAAAA,eAAAA,EAAAA,QAAAA;AAEAC,EAAAA,eAAAA,EAAAA,QAAAA;AAEAC,EAAAA,cAAAA,EAAAA,QAAAA;AAEAC,EAAAA,YAAAA,EAAAA,QAAAA;AAEAC,EAAAA,QAAAA,EAAAA,QAAAA;AAEAC,EAAAA,SAAAA,EAAAA,QAAAA;AAEAC,EAAAA,SAAAA,EAAAA,QAAAA;AACF,CAAA;;;;"}