@canvas-components/list-table 0.2.5 → 0.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +1 -1
  2. package/dist/index.cjs +223 -61
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +17 -8
  5. package/dist/index.d.ts +17 -8
  6. package/dist/index.js +223 -61
  7. package/dist/index.js.map +1 -1
  8. package/package.json +2 -2
package/dist/index.d.cts CHANGED
@@ -1410,9 +1410,8 @@ interface ListTableScrollbarOptions {
1410
1410
  verticalBottom?: number;
1411
1411
  /**
1412
1412
  * 滚动条可见性。
1413
- * - `true`: 始终显示
1413
+ * - `true` / `undefined`: 始终显示（默认）
1414
1414
  * - `false`: 始终隐藏
1415
- * - `undefined`: 自动模式（滚动/悬停时显示，随后自动隐藏）
1416
1415
  */
1417
1416
  visible?: boolean;
1418
1417
  }
@@ -1620,6 +1619,8 @@ interface ListTableUiOptions {
1620
1619
  onSearchRequest?: (request: ListTableSearchRequest | null) => void;
1621
1620
  onImagePreviewRequest?: (request: ListTableImagePreviewRequest | null) => void;
1622
1621
  onDangerConfirmRequest?: (request: ListTableDangerConfirmRequest | null) => void;
1622
+ /** 持久化配置或内部操作改变表格密度时通知适配层。 */
1623
+ onDensityChange?: (density: 32 | 48 | 56) => void;
1623
1624
  }
1624
1625
  /**
1625
1626
  * 行选择器配置。
@@ -1681,14 +1682,16 @@ interface ListTableOptions<RecordType = Record<string, unknown>> {
1681
1682
  * 数据行高度。
1682
1683
  *
1683
1684
  * - 传入数字时使用固定高度
1684
- * - 默认 `auto`，会按当前列宽和单元格内容自动计算
1685
- * - 自动计算结果最小不低于 `40px`
1685
+ * - 传入 `auto` 时按当前列宽和单元格内容自动计算
1686
+ * - 未传时默认使用紧凑密度 `32px`
1687
+ * - 未单独配置时，表头、汇总行和分组栏同步采用该高度
1686
1688
  *
1687
- * @default "auto"
1689
+ * @default 32
1688
1690
  */
1689
1691
  rowHeight?: number | "auto";
1692
+ /** 表头行高，未传时采用 `rowHeight`。 */
1690
1693
  headerRowHeight?: number;
1691
- /** 汇总行高度。 */
1694
+ /** 汇总行高度，未传时采用 `rowHeight`。 */
1692
1695
  summaryRowHeight?: number;
1693
1696
  overscanRowCount?: number;
1694
1697
  query?: ListTableQueryOptions<RecordType>;
@@ -1714,7 +1717,7 @@ interface ListTableOptions<RecordType = Record<string, unknown>> {
1714
1717
  */
1715
1718
  resizable?: boolean;
1716
1719
  /**
1717
- * 列配置持久化存储键。设置后列宽、固定、排序、过滤、缩放状态会自动保存到 IndexDB。
1720
+ * 列配置持久化存储键。设置后列宽、固定、排序、过滤、缩放和表格密度会自动保存到 IndexDB。
1718
1721
  */
1719
1722
  storageKey?: string;
1720
1723
  draggable?: boolean;
@@ -1745,6 +1748,8 @@ interface ListTableScrollToOptions {
1745
1748
  colIndex?: number;
1746
1749
  behavior?: "auto" | "smooth";
1747
1750
  }
1751
+ /** ListTable 内置表格密度对应的行高。 */
1752
+ type ListTableDensity = 32 | 48 | 56;
1748
1753
  /**
1749
1754
  * XLSX 导出参数。
1750
1755
  */
@@ -1807,6 +1812,10 @@ declare class ListTable<RecordType = Record<string, unknown>> {
1807
1812
  * 重置筛选状态。
1808
1813
  */
1809
1814
  resetFilter(): void;
1815
+ /**
1816
+ * 设置并持久化内置表格密度。
1817
+ */
1818
+ changeDensity(density: ListTableDensity): void;
1810
1819
  /**
1811
1820
  * 销毁实例。
1812
1821
  */
@@ -1842,4 +1851,4 @@ interface ListTableValidationTarget {
1842
1851
  columnKey: string;
1843
1852
  }
1844
1853
 
1845
- export { type CreateCellEditorSessionParams, type DebugHitTestResult, type FilterPanelConfig, type FilterPanelOptionItem, type FilterPanelTexts, type FixedPopupConfig, type HeaderContextMenuColumnItem, type HeaderContextMenuConfig, type HeaderContextMenuDensity, ListTable, type ListTableAutoMergeRule, type ListTableBarcodeCellContent, type ListTableBarcodeFormat, type ListTableButtonCellContent, type ListTableButtonPopconfirmOptions, type ListTableButtonSize, type ListTableButtonType, type ListTableCarouselScrollOptions, type ListTableCellContent, type ListTableCellContentClickContext, type ListTableCellEditorSession, type ListTableCellSpan, type ListTableCellStyle, type ListTableChartCellContent, type ListTableChartSize, type ListTableChartType, type ListTableColorCellContent, type ListTableColumn, type ListTableContextMenuFeature, type ListTableContextMenuOptions, type ListTableCustomChartCellContent, type ListTableDangerConfirmRequest, type ListTableDataFormat, type ListTableDataFormatOptions, type ListTableDataFormatType, type ListTableDebugOptions, type ListTableDebugSnapshot, type ListTableEditAutoCompleteEnter, type ListTableEditFilterOption, type ListTableEditOption, type ListTableEditValueType, type ListTableEditable, type ListTableEditorAutoCompleteEnter, type ListTableEditorConfig, type ListTableEditorFactory, type ListTableEditorFilterOption, type ListTableEditorNavigateDirection, type ListTableEditorOption, type ListTableEditorRect, type ListTableEditorRequest, type ListTableEditorTheme, type ListTableEditorValueType, type ListTableExportXlsxOptions, type ListTableFilterConditionOperator, type ListTableFilterConditionRelation, type ListTableFilterMatchMode, type ListTableFilterOption, type ListTableFilterOptionValue, type ListTableFilterPanelAdapter, type ListTableFilterState, type ListTableFilterType, type ListTableFilterValue$1 as ListTableFilterValue, type ListTableFixedPopupAdapter, type ListTableFormItemProps, type ListTableFormItemPropsConfig, type ListTableFormRule, type ListTableFormRules, type ListTableGroupingOptions, type ListTableHeaderContextMenuAdapter, type ListTableHighlightMode, type ListTableHorizontalAlign, type ListTableIconCellContent, type ListTableImageCellContent, type ListTableImageObjectFit, type ListTableImagePreviewRequest, type ListTableLoadingAdapter, type ListTableLoadingRequest, type ListTableMergeCellOptions, type ListTableNestedTableCellContent, type ListTableNestedTableColumn, type ListTableOptions, type ListTablePaginationAdapter, type ListTablePaginationOptions, type ListTablePerformanceMetric, type ListTableProgressCellContent, type ListTableProgressShape, type ListTableProgressSize, type ListTableQrCodeCellContent, type ListTableQrCodeLevel, type ListTableQueryChange, type ListTableQueryChangeExtra, type ListTableQueryFilters, type ListTableQueryOptions, type ListTableQueryPagination, type ListTableQuerySorter, type ListTableRateCellContent, type ListTableRateSize, type ListTableRowDragMode, type ListTableRowDragOptions, type ListTableRowDragPayload, type ListTableRowDragSourceInfo, type ListTableRowDragZone, type ListTableRowEventProps, type ListTableRowSelectionChangeInfo, type ListTableRowSelectionOptions, type ListTableRowSelectorOptions, type ListTableScrollToOptions, type ListTableScrollbarOptions, type ListTableSearchRequest, type ListTableSelectionState, type ListTableSortItem, type ListTableSortState, type ListTableSparklineChartCellContent, type ListTableSparklineSize, type ListTableSummaryConfig, type ListTableSummaryRoundingMode, type ListTableSummaryType, type ListTableSymbolType, type ListTableTagCellContent, type ListTableTheme, type ListTableTooltipAdapter, type ListTableTooltipRequest, type ListTableUiOptions, type ListTableValidationError, type ListTableValidationErrorField, type ListTableValidationFailure, type ListTableValidationTarget, type PaginationConfig, type RenderCellDescriptor };
1854
+ export { type CreateCellEditorSessionParams, type DebugHitTestResult, type FilterPanelConfig, type FilterPanelOptionItem, type FilterPanelTexts, type FixedPopupConfig, type HeaderContextMenuColumnItem, type HeaderContextMenuConfig, type HeaderContextMenuDensity, ListTable, type ListTableAutoMergeRule, type ListTableBarcodeCellContent, type ListTableBarcodeFormat, type ListTableButtonCellContent, type ListTableButtonPopconfirmOptions, type ListTableButtonSize, type ListTableButtonType, type ListTableCarouselScrollOptions, type ListTableCellContent, type ListTableCellContentClickContext, type ListTableCellEditorSession, type ListTableCellSpan, type ListTableCellStyle, type ListTableChartCellContent, type ListTableChartSize, type ListTableChartType, type ListTableColorCellContent, type ListTableColumn, type ListTableContextMenuFeature, type ListTableContextMenuOptions, type ListTableCustomChartCellContent, type ListTableDangerConfirmRequest, type ListTableDataFormat, type ListTableDataFormatOptions, type ListTableDataFormatType, type ListTableDebugOptions, type ListTableDebugSnapshot, type ListTableDensity, type ListTableEditAutoCompleteEnter, type ListTableEditFilterOption, type ListTableEditOption, type ListTableEditValueType, type ListTableEditable, type ListTableEditorAutoCompleteEnter, type ListTableEditorConfig, type ListTableEditorFactory, type ListTableEditorFilterOption, type ListTableEditorNavigateDirection, type ListTableEditorOption, type ListTableEditorRect, type ListTableEditorRequest, type ListTableEditorTheme, type ListTableEditorValueType, type ListTableExportXlsxOptions, type ListTableFilterConditionOperator, type ListTableFilterConditionRelation, type ListTableFilterMatchMode, type ListTableFilterOption, type ListTableFilterOptionValue, type ListTableFilterPanelAdapter, type ListTableFilterState, type ListTableFilterType, type ListTableFilterValue$1 as ListTableFilterValue, type ListTableFixedPopupAdapter, type ListTableFormItemProps, type ListTableFormItemPropsConfig, type ListTableFormRule, type ListTableFormRules, type ListTableGroupingOptions, type ListTableHeaderContextMenuAdapter, type ListTableHighlightMode, type ListTableHorizontalAlign, type ListTableIconCellContent, type ListTableImageCellContent, type ListTableImageObjectFit, type ListTableImagePreviewRequest, type ListTableLoadingAdapter, type ListTableLoadingRequest, type ListTableMergeCellOptions, type ListTableNestedTableCellContent, type ListTableNestedTableColumn, type ListTableOptions, type ListTablePaginationAdapter, type ListTablePaginationOptions, type ListTablePerformanceMetric, type ListTableProgressCellContent, type ListTableProgressShape, type ListTableProgressSize, type ListTableQrCodeCellContent, type ListTableQrCodeLevel, type ListTableQueryChange, type ListTableQueryChangeExtra, type ListTableQueryFilters, type ListTableQueryOptions, type ListTableQueryPagination, type ListTableQuerySorter, type ListTableRateCellContent, type ListTableRateSize, type ListTableRowDragMode, type ListTableRowDragOptions, type ListTableRowDragPayload, type ListTableRowDragSourceInfo, type ListTableRowDragZone, type ListTableRowEventProps, type ListTableRowSelectionChangeInfo, type ListTableRowSelectionOptions, type ListTableRowSelectorOptions, type ListTableScrollToOptions, type ListTableScrollbarOptions, type ListTableSearchRequest, type ListTableSelectionState, type ListTableSortItem, type ListTableSortState, type ListTableSparklineChartCellContent, type ListTableSparklineSize, type ListTableSummaryConfig, type ListTableSummaryRoundingMode, type ListTableSummaryType, type ListTableSymbolType, type ListTableTagCellContent, type ListTableTheme, type ListTableTooltipAdapter, type ListTableTooltipRequest, type ListTableUiOptions, type ListTableValidationError, type ListTableValidationErrorField, type ListTableValidationFailure, type ListTableValidationTarget, type PaginationConfig, type RenderCellDescriptor };
package/dist/index.d.ts CHANGED
@@ -1410,9 +1410,8 @@ interface ListTableScrollbarOptions {
1410
1410
  verticalBottom?: number;
1411
1411
  /**
1412
1412
  * 滚动条可见性。
1413
- * - `true`: 始终显示
1413
+ * - `true` / `undefined`: 始终显示（默认）
1414
1414
  * - `false`: 始终隐藏
1415
- * - `undefined`: 自动模式（滚动/悬停时显示，随后自动隐藏）
1416
1415
  */
1417
1416
  visible?: boolean;
1418
1417
  }
@@ -1620,6 +1619,8 @@ interface ListTableUiOptions {
1620
1619
  onSearchRequest?: (request: ListTableSearchRequest | null) => void;
1621
1620
  onImagePreviewRequest?: (request: ListTableImagePreviewRequest | null) => void;
1622
1621
  onDangerConfirmRequest?: (request: ListTableDangerConfirmRequest | null) => void;
1622
+ /** 持久化配置或内部操作改变表格密度时通知适配层。 */
1623
+ onDensityChange?: (density: 32 | 48 | 56) => void;
1623
1624
  }
1624
1625
  /**
1625
1626
  * 行选择器配置。
@@ -1681,14 +1682,16 @@ interface ListTableOptions<RecordType = Record<string, unknown>> {
1681
1682
  * 数据行高度。
1682
1683
  *
1683
1684
  * - 传入数字时使用固定高度
1684
- * - 默认 `auto`，会按当前列宽和单元格内容自动计算
1685
- * - 自动计算结果最小不低于 `40px`
1685
+ * - 传入 `auto` 时按当前列宽和单元格内容自动计算
1686
+ * - 未传时默认使用紧凑密度 `32px`
1687
+ * - 未单独配置时，表头、汇总行和分组栏同步采用该高度
1686
1688
  *
1687
- * @default "auto"
1689
+ * @default 32
1688
1690
  */
1689
1691
  rowHeight?: number | "auto";
1692
+ /** 表头行高，未传时采用 `rowHeight`。 */
1690
1693
  headerRowHeight?: number;
1691
- /** 汇总行高度。 */
1694
+ /** 汇总行高度，未传时采用 `rowHeight`。 */
1692
1695
  summaryRowHeight?: number;
1693
1696
  overscanRowCount?: number;
1694
1697
  query?: ListTableQueryOptions<RecordType>;
@@ -1714,7 +1717,7 @@ interface ListTableOptions<RecordType = Record<string, unknown>> {
1714
1717
  */
1715
1718
  resizable?: boolean;
1716
1719
  /**
1717
- * 列配置持久化存储键。设置后列宽、固定、排序、过滤、缩放状态会自动保存到 IndexDB。
1720
+ * 列配置持久化存储键。设置后列宽、固定、排序、过滤、缩放和表格密度会自动保存到 IndexDB。
1718
1721
  */
1719
1722
  storageKey?: string;
1720
1723
  draggable?: boolean;
@@ -1745,6 +1748,8 @@ interface ListTableScrollToOptions {
1745
1748
  colIndex?: number;
1746
1749
  behavior?: "auto" | "smooth";
1747
1750
  }
1751
+ /** ListTable 内置表格密度对应的行高。 */
1752
+ type ListTableDensity = 32 | 48 | 56;
1748
1753
  /**
1749
1754
  * XLSX 导出参数。
1750
1755
  */
@@ -1807,6 +1812,10 @@ declare class ListTable<RecordType = Record<string, unknown>> {
1807
1812
  * 重置筛选状态。
1808
1813
  */
1809
1814
  resetFilter(): void;
1815
+ /**
1816
+ * 设置并持久化内置表格密度。
1817
+ */
1818
+ changeDensity(density: ListTableDensity): void;
1810
1819
  /**
1811
1820
  * 销毁实例。
1812
1821
  */
@@ -1842,4 +1851,4 @@ interface ListTableValidationTarget {
1842
1851
  columnKey: string;
1843
1852
  }
1844
1853
 
1845
- export { type CreateCellEditorSessionParams, type DebugHitTestResult, type FilterPanelConfig, type FilterPanelOptionItem, type FilterPanelTexts, type FixedPopupConfig, type HeaderContextMenuColumnItem, type HeaderContextMenuConfig, type HeaderContextMenuDensity, ListTable, type ListTableAutoMergeRule, type ListTableBarcodeCellContent, type ListTableBarcodeFormat, type ListTableButtonCellContent, type ListTableButtonPopconfirmOptions, type ListTableButtonSize, type ListTableButtonType, type ListTableCarouselScrollOptions, type ListTableCellContent, type ListTableCellContentClickContext, type ListTableCellEditorSession, type ListTableCellSpan, type ListTableCellStyle, type ListTableChartCellContent, type ListTableChartSize, type ListTableChartType, type ListTableColorCellContent, type ListTableColumn, type ListTableContextMenuFeature, type ListTableContextMenuOptions, type ListTableCustomChartCellContent, type ListTableDangerConfirmRequest, type ListTableDataFormat, type ListTableDataFormatOptions, type ListTableDataFormatType, type ListTableDebugOptions, type ListTableDebugSnapshot, type ListTableEditAutoCompleteEnter, type ListTableEditFilterOption, type ListTableEditOption, type ListTableEditValueType, type ListTableEditable, type ListTableEditorAutoCompleteEnter, type ListTableEditorConfig, type ListTableEditorFactory, type ListTableEditorFilterOption, type ListTableEditorNavigateDirection, type ListTableEditorOption, type ListTableEditorRect, type ListTableEditorRequest, type ListTableEditorTheme, type ListTableEditorValueType, type ListTableExportXlsxOptions, type ListTableFilterConditionOperator, type ListTableFilterConditionRelation, type ListTableFilterMatchMode, type ListTableFilterOption, type ListTableFilterOptionValue, type ListTableFilterPanelAdapter, type ListTableFilterState, type ListTableFilterType, type ListTableFilterValue$1 as ListTableFilterValue, type ListTableFixedPopupAdapter, type ListTableFormItemProps, type ListTableFormItemPropsConfig, type ListTableFormRule, type ListTableFormRules, type ListTableGroupingOptions, type ListTableHeaderContextMenuAdapter, type ListTableHighlightMode, type ListTableHorizontalAlign, type ListTableIconCellContent, type ListTableImageCellContent, type ListTableImageObjectFit, type ListTableImagePreviewRequest, type ListTableLoadingAdapter, type ListTableLoadingRequest, type ListTableMergeCellOptions, type ListTableNestedTableCellContent, type ListTableNestedTableColumn, type ListTableOptions, type ListTablePaginationAdapter, type ListTablePaginationOptions, type ListTablePerformanceMetric, type ListTableProgressCellContent, type ListTableProgressShape, type ListTableProgressSize, type ListTableQrCodeCellContent, type ListTableQrCodeLevel, type ListTableQueryChange, type ListTableQueryChangeExtra, type ListTableQueryFilters, type ListTableQueryOptions, type ListTableQueryPagination, type ListTableQuerySorter, type ListTableRateCellContent, type ListTableRateSize, type ListTableRowDragMode, type ListTableRowDragOptions, type ListTableRowDragPayload, type ListTableRowDragSourceInfo, type ListTableRowDragZone, type ListTableRowEventProps, type ListTableRowSelectionChangeInfo, type ListTableRowSelectionOptions, type ListTableRowSelectorOptions, type ListTableScrollToOptions, type ListTableScrollbarOptions, type ListTableSearchRequest, type ListTableSelectionState, type ListTableSortItem, type ListTableSortState, type ListTableSparklineChartCellContent, type ListTableSparklineSize, type ListTableSummaryConfig, type ListTableSummaryRoundingMode, type ListTableSummaryType, type ListTableSymbolType, type ListTableTagCellContent, type ListTableTheme, type ListTableTooltipAdapter, type ListTableTooltipRequest, type ListTableUiOptions, type ListTableValidationError, type ListTableValidationErrorField, type ListTableValidationFailure, type ListTableValidationTarget, type PaginationConfig, type RenderCellDescriptor };
1854
+ export { type CreateCellEditorSessionParams, type DebugHitTestResult, type FilterPanelConfig, type FilterPanelOptionItem, type FilterPanelTexts, type FixedPopupConfig, type HeaderContextMenuColumnItem, type HeaderContextMenuConfig, type HeaderContextMenuDensity, ListTable, type ListTableAutoMergeRule, type ListTableBarcodeCellContent, type ListTableBarcodeFormat, type ListTableButtonCellContent, type ListTableButtonPopconfirmOptions, type ListTableButtonSize, type ListTableButtonType, type ListTableCarouselScrollOptions, type ListTableCellContent, type ListTableCellContentClickContext, type ListTableCellEditorSession, type ListTableCellSpan, type ListTableCellStyle, type ListTableChartCellContent, type ListTableChartSize, type ListTableChartType, type ListTableColorCellContent, type ListTableColumn, type ListTableContextMenuFeature, type ListTableContextMenuOptions, type ListTableCustomChartCellContent, type ListTableDangerConfirmRequest, type ListTableDataFormat, type ListTableDataFormatOptions, type ListTableDataFormatType, type ListTableDebugOptions, type ListTableDebugSnapshot, type ListTableDensity, type ListTableEditAutoCompleteEnter, type ListTableEditFilterOption, type ListTableEditOption, type ListTableEditValueType, type ListTableEditable, type ListTableEditorAutoCompleteEnter, type ListTableEditorConfig, type ListTableEditorFactory, type ListTableEditorFilterOption, type ListTableEditorNavigateDirection, type ListTableEditorOption, type ListTableEditorRect, type ListTableEditorRequest, type ListTableEditorTheme, type ListTableEditorValueType, type ListTableExportXlsxOptions, type ListTableFilterConditionOperator, type ListTableFilterConditionRelation, type ListTableFilterMatchMode, type ListTableFilterOption, type ListTableFilterOptionValue, type ListTableFilterPanelAdapter, type ListTableFilterState, type ListTableFilterType, type ListTableFilterValue$1 as ListTableFilterValue, type ListTableFixedPopupAdapter, type ListTableFormItemProps, type ListTableFormItemPropsConfig, type ListTableFormRule, type ListTableFormRules, type ListTableGroupingOptions, type ListTableHeaderContextMenuAdapter, type ListTableHighlightMode, type ListTableHorizontalAlign, type ListTableIconCellContent, type ListTableImageCellContent, type ListTableImageObjectFit, type ListTableImagePreviewRequest, type ListTableLoadingAdapter, type ListTableLoadingRequest, type ListTableMergeCellOptions, type ListTableNestedTableCellContent, type ListTableNestedTableColumn, type ListTableOptions, type ListTablePaginationAdapter, type ListTablePaginationOptions, type ListTablePerformanceMetric, type ListTableProgressCellContent, type ListTableProgressShape, type ListTableProgressSize, type ListTableQrCodeCellContent, type ListTableQrCodeLevel, type ListTableQueryChange, type ListTableQueryChangeExtra, type ListTableQueryFilters, type ListTableQueryOptions, type ListTableQueryPagination, type ListTableQuerySorter, type ListTableRateCellContent, type ListTableRateSize, type ListTableRowDragMode, type ListTableRowDragOptions, type ListTableRowDragPayload, type ListTableRowDragSourceInfo, type ListTableRowDragZone, type ListTableRowEventProps, type ListTableRowSelectionChangeInfo, type ListTableRowSelectionOptions, type ListTableRowSelectorOptions, type ListTableScrollToOptions, type ListTableScrollbarOptions, type ListTableSearchRequest, type ListTableSelectionState, type ListTableSortItem, type ListTableSortState, type ListTableSparklineChartCellContent, type ListTableSparklineSize, type ListTableSummaryConfig, type ListTableSummaryRoundingMode, type ListTableSummaryType, type ListTableSymbolType, type ListTableTagCellContent, type ListTableTheme, type ListTableTooltipAdapter, type ListTableTooltipRequest, type ListTableUiOptions, type ListTableValidationError, type ListTableValidationErrorField, type ListTableValidationFailure, type ListTableValidationTarget, type PaginationConfig, type RenderCellDescriptor };