@vef-framework/components 1.0.122 → 1.0.123

package/esm/vef-table/hooks/use-computed-values.js

@@ -0,0 +1,39 @@
+"use strict";
+import { useDeepMemo } from '@vef-framework/hooks';
+import { computeValue } from '../helper.js';
+
+"use strict";
+function useComputedValues(values, value, record, rowIndex, returnAsObject = false) {
+  const computedValues = useDeepMemo(
+    () => values.reduce((acc, it) => {
+      const {
+        key,
+        rawValue,
+        defaultValue
+      } = it;
+      const computedValue = computeValue(rawValue, value, record, rowIndex, defaultValue);
+      acc[key] = computedValue;
+      return acc;
+    }, {}),
+    [
+      record,
+      rowIndex,
+      value,
+      values
+    ]
+  );
+  if (returnAsObject) {
+    return values.reduce(
+      (acc, { key }) => {
+        acc[key] = computedValues[key];
+        return acc;
+      },
+      {}
+    );
+  }
+  return values.map(
+    ({ key }) => computedValues[key]
+  );
+}
+
+export { useComputedValues };

package/esm/vef-table/hooks/use-data.js

@@ -0,0 +1,58 @@
+"use strict";
+import { useDataQuery } from '@vef-framework/hooks';
+import { isShallowEqual, isNumber, isArray } from '@vef-framework/shared';
+import { useRef } from 'react';
+
+"use strict";
+function useData({ apiParams, ...queryConfig }, paginated, paginationParams) {
+  const lastApiParamsRef = useRef();
+  const {
+    data,
+    isLoading,
+    isFetching,
+    isSuccess,
+    refetch
+  } = useDataQuery({
+    apiParams: paginated ? {
+      ...paginationParams,
+      page: isShallowEqual(lastApiParamsRef.current, apiParams) ? paginationParams.page : 1,
+      ...apiParams
+    } : apiParams,
+    keepPreviousData: true,
+    staleTime: 0,
+    ...queryConfig
+  });
+  lastApiParamsRef.current = apiParams;
+  if (isSuccess) {
+    if (paginated) {
+      if (!Object.hasOwn(data, "total") || !Object.hasOwn(data, "items")) {
+        throw new Error(
+          "The paginated data of VefTable is invalid. The data must contain the `total` and `items` properties. Please check the data."
+        );
+      }
+      if (!isNumber(data.total)) {
+        throw new Error(
+          "The `total` property of the paginated data of VefTable is invalid. It must be a number."
+        );
+      }
+      if (!isArray(data.items)) {
+        throw new Error(
+          "The `items` property of the paginated data of VefTable is invalid. It must be an array."
+        );
+      }
+    } else {
+      if (!isArray(data)) {
+        throw new Error("The data of VefTable is invalid. It must be an array.");
+      }
+    }
+  }
+  return {
+    data: paginated ? data?.items : data,
+    isFetching,
+    isLoading,
+    total: paginated ? data?.total : void 0,
+    refetch
+  };
+}
+
+export { useData };

package/esm/vef-table/hooks/use-default-column-configs.js

@@ -0,0 +1,28 @@
+"use strict";
+import { useMemo } from 'react';
+
+"use strict";
+function useDefaultColumnConfigs(columns) {
+  return useMemo(() => {
+    const columnConfigs = /* @__PURE__ */ new Map();
+    let currentOrder = 1;
+    for (const column of columns) {
+      const {
+        name,
+        title,
+        fixed,
+        configurable
+      } = column;
+      columnConfigs.set(name, {
+        title: title ?? name,
+        show: true,
+        fixed,
+        order: currentOrder++,
+        configurable: configurable ?? true
+      });
+    }
+    return columnConfigs;
+  }, [columns]);
+}
+
+export { useDefaultColumnConfigs };

package/esm/vef-table/hooks/use-display-value.js

@@ -0,0 +1,37 @@
+"use strict";
+import { isNullish, isFunction, isExpression, compileDynamicFn } from '@vef-framework/shared';
+import { useMemo } from 'react';
+
+"use strict";
+function useDisplayValue(value, record, rowIndex, config) {
+  const {
+    defaultValue,
+    formatter,
+    prefix,
+    suffix
+  } = config;
+  const valueToUse = isNullish(value) ? defaultValue : value;
+  return useMemo(() => {
+    if (isFunction(formatter)) {
+      return formatter(value, record, rowIndex);
+    }
+    if (isExpression(formatter)) {
+      const fn = compileDynamicFn(formatter, "value", "record", "rowIndex", `return ${formatter.expression}`);
+      return fn(value, record, rowIndex);
+    }
+    if (isNullish(valueToUse)) {
+      return;
+    }
+    return `${prefix ?? ""}${valueToUse}${suffix ?? ""}`;
+  }, [
+    formatter,
+    valueToUse,
+    prefix,
+    suffix,
+    value,
+    record,
+    rowIndex
+  ]);
+}
+
+export { useDisplayValue };

package/esm/vef-table/hooks/use-helper-columns.js

@@ -0,0 +1,68 @@
+"use strict";
+import { jsx } from '@emotion/react/jsx-runtime';
+import { useAuthorizedItems } from '@vef-framework/hooks';
+import { isDeepEqual } from '@vef-framework/shared';
+import { useMemo } from 'react';
+import VefColumnsSettings from '../components/columns-settings.js';
+import VefOperationButtons from '../components/operation-buttons.js';
+import VefSettingsIcon from '../components/settings-icon.js';
+import { useOperationColumnWidth } from './use-operation-column-width.js';
+
+"use strict";
+const DEFAULT_MAX_VISIBLE_OPERATION_BUTTONS = 3;
+function useHelperColumns({
+  showRowNumber,
+  operationButtons,
+  maxVisibleOperationButtons,
+  size
+}) {
+  const rowNumberColumn = useMemo(() => {
+    if (showRowNumber) {
+      return {
+        key: "_rowNumber",
+        title: "#",
+        align: "center",
+        fixed: "left",
+        // rowScope: "row",
+        width: 48,
+        shouldCellUpdate: () => false,
+        render: (_, __, rowIndex) => rowIndex + 1
+      };
+    }
+  }, [showRowNumber]);
+  const authorizedOperationButtons = useAuthorizedItems(operationButtons ?? []);
+  const operationColumnWidth = useOperationColumnWidth(
+    authorizedOperationButtons,
+    maxVisibleOperationButtons ?? DEFAULT_MAX_VISIBLE_OPERATION_BUTTONS,
+    size
+  );
+  const operationColumn = useMemo(() => {
+    if (authorizedOperationButtons && authorizedOperationButtons.length > 0) {
+      return {
+        key: "_operationButtons",
+        title: "操作",
+        align: "center",
+        fixed: "right",
+        filterIcon: () => /* @__PURE__ */ jsx(VefSettingsIcon, {}),
+        filterDropdown: () => /* @__PURE__ */ jsx(VefColumnsSettings, {}),
+        width: operationColumnWidth,
+        shouldCellUpdate: (record, prevRecord) => !isDeepEqual(record, prevRecord),
+        render: (_, record, rowIndex) => /* @__PURE__ */ jsx(
+          VefOperationButtons,
+          {
+            maxVisibleOperationButtons: maxVisibleOperationButtons ?? DEFAULT_MAX_VISIBLE_OPERATION_BUTTONS,
+            operationButtons: authorizedOperationButtons,
+            record,
+            rowIndex
+          }
+        )
+      };
+    }
+  }, [authorizedOperationButtons, maxVisibleOperationButtons, operationColumnWidth]);
+  return {
+    rowNumberColumn,
+    operationColumn
+  };
+}
+
+export { useHelperColumns };

package/esm/vef-table/hooks/use-operation-column-width.js

@@ -0,0 +1,51 @@
+"use strict";
+import { useThemeTokens } from '@vef-framework/hooks';
+import { max } from '@vef-framework/shared';
+import { useMemo } from 'react';
+
+"use strict";
+function useOperationColumnWidth(operationButtons, maxVisibleOperationButtons, size = "medium") {
+  const { Button: buttonThemeTokens } = useThemeTokens();
+  const cellInlinePadding = size === "large" ? 16 : 8;
+  const fontSize = buttonThemeTokens?.contentFontSizeSM ?? 16;
+  return useMemo(() => {
+    if (operationButtons.length === 0) {
+      return 0;
+    }
+    const showMoreButton = operationButtons.length > maxVisibleOperationButtons;
+    if (showMoreButton) {
+      const longestButtons = /* @__PURE__ */ new Set();
+      for (let i = 0; i < maxVisibleOperationButtons; i++) {
+        const longestButton = max(operationButtons, (button) => {
+          if (longestButtons.has(button)) {
+            return 0;
+          }
+          return button.label.length;
+        });
+        if (longestButton) {
+          longestButtons.add(longestButton);
+        }
+      }
+      return calculateButtonsWidth(Array.from(longestButtons), fontSize, cellInlinePadding, true);
+    }
+    return calculateButtonsWidth(operationButtons, fontSize, cellInlinePadding, false);
+  }, [
+    cellInlinePadding,
+    fontSize,
+    maxVisibleOperationButtons,
+    operationButtons
+  ]);
+}
+function calculateButtonsWidth(operationButtons, fontSize, cellInlinePadding, includeMoreButtonWidth) {
+  const fontWidth = fontSize + 4;
+  const buttonInlinePadding = 4 * 2;
+  return operationButtons.map((button) => {
+    const baseWidth = button.label.length * fontWidth + buttonInlinePadding;
+    if (button.icon) {
+      return baseWidth + fontWidth + 8;
+    }
+    return baseWidth;
+  }).reduce((acc, width) => acc + width, 0) + (includeMoreButtonWidth ? fontWidth + buttonInlinePadding : 0) + cellInlinePadding * 2;
+}
+
+export { useOperationColumnWidth };

package/esm/vef-table/hooks/use-pagination-props.js

@@ -0,0 +1,45 @@
+"use strict";
+import { useState, useMemo } from 'react';
+import { defaultPageSizeOptions } from '../../vef-pagination/props.js';
+
+"use strict";
+function usePaginationProps(paginated, size) {
+  const [paginationParams, setPaginationParams] = useState({
+    page: 1,
+    size: defaultPageSizeOptions[2]
+  });
+  const handlePaginationChange = useMemo(() => {
+    if (!paginated) {
+      return;
+    }
+    return (pageNumber, pageSize) => {
+      setPaginationParams({
+        page: pageNumber,
+        size: pageSize
+      });
+    };
+  }, [paginated, setPaginationParams]);
+  const paginationProps = useMemo(() => {
+    if (!paginated) {
+      return;
+    }
+    return {
+      pageNumber: paginationParams.page,
+      pageSize: paginationParams.size,
+      size: size === "small" ? "small" : "medium",
+      onChange: handlePaginationChange
+    };
+  }, [
+    handlePaginationChange,
+    paginated,
+    paginationParams.page,
+    paginationParams.size,
+    size
+  ]);
+  return {
+    paginationProps,
+    paginationParams
+  };
+}
+
+export { usePaginationProps };

package/esm/vef-table/hooks/use-row-props.js

@@ -0,0 +1,40 @@
+"use strict";
+import { useMemo } from 'react';
+
+"use strict";
+function useRowProps({
+  enableRowClick = false,
+  enableRowClickForSelection = false,
+  onRowClick,
+  disabledSelection,
+  handleRowClickSelection
+}) {
+  return useMemo(() => {
+    if (!enableRowClick) {
+      return;
+    }
+    return (record, index) => {
+      const disabled = disabledSelection?.(record) ?? false;
+      return {
+        style: {
+          cursor: disabled ? "not-allowed" : "pointer"
+          // backgroundColor: index! % 2 === 0 ? "#fcfcfc" : undefined,
+        },
+        onClick: disabled ? void 0 : () => {
+          if (!enableRowClickForSelection) {
+            onRowClick?.(record, index ?? -1);
+          }
+          handleRowClickSelection?.(record);
+        }
+      };
+    };
+  }, [
+    disabledSelection,
+    enableRowClick,
+    enableRowClickForSelection,
+    handleRowClickSelection,
+    onRowClick
+  ]);
+}
+
+export { useRowProps };

package/esm/vef-table/hooks/use-row-selection-config.js

@@ -0,0 +1,113 @@
+"use strict";
+import { isFunction } from '@vef-framework/shared';
+import { useMemo } from 'react';
+import { useSelectedRows } from './use-selected-rows.js';
+
+"use strict";
+function useRowSelectionConfig({
+  rowKey,
+  selectedKeys,
+  defaultSelectedKeys,
+  selectable,
+  enableRowClick,
+  enableRowClickForSelection,
+  multipleSelection = true,
+  showSelectAllCheckbox = true,
+  disabledSelection,
+  onRowSelect,
+  onRowDeselect,
+  onRowSelectionChange
+}) {
+  const {
+    selectedKeys: selectedKeysToUse,
+    selectedRecords,
+    onChange
+  } = useSelectedRows({
+    selectedKeys,
+    defaultSelectedKeys,
+    onRowSelectionChange
+  });
+  const handleRowClickSelection = useMemo(() => {
+    if (!enableRowClick || !enableRowClickForSelection) {
+      return;
+    }
+    return (record) => {
+      const key = isFunction(rowKey) ? rowKey(record) : record[rowKey];
+      if (selectedKeysToUse.includes(key)) {
+        if (!multipleSelection) {
+          return;
+        }
+        const newValue = selectedKeysToUse.filter((it) => it !== key);
+        const newSelectedRows = selectedRecords.current.filter((it) => (isFunction(rowKey) ? rowKey(it) : it[rowKey]) !== key);
+        onChange(newValue, newSelectedRows);
+        onRowDeselect?.(key, record);
+      } else {
+        const newValue = [key];
+        if (multipleSelection) {
+          newValue.push(...selectedKeysToUse);
+        }
+        const newSelectedRows = [record];
+        if (multipleSelection) {
+          newSelectedRows.push(...selectedRecords.current);
+        }
+        onChange(newValue, newSelectedRows);
+        onRowSelect?.(key, record);
+      }
+    };
+  }, [
+    enableRowClick,
+    enableRowClickForSelection,
+    multipleSelection,
+    onChange,
+    onRowDeselect,
+    onRowSelect,
+    rowKey,
+    selectedKeysToUse,
+    selectedRecords
+  ]);
+  const rowSelectionConfig = useMemo(() => {
+    if (!selectable) {
+      return;
+    }
+    const config = {
+      fixed: true,
+      hideSelectAll: !showSelectAllCheckbox,
+      preserveSelectedRowKeys: false,
+      selectedRowKeys: selectedKeysToUse,
+      type: multipleSelection ? "checkbox" : "radio",
+      getCheckboxProps: isFunction(disabledSelection) ? (record) => ({
+        disabled: disabledSelection(record)
+      }) : void 0,
+      onChange: (selectedRowKeys, selectedRows) => {
+        onChange(selectedRowKeys, selectedRows);
+      },
+      onSelect: isFunction(onRowSelect) || isFunction(onRowDeselect) ? (record, selected) => {
+        const key = isFunction(rowKey) ? rowKey(record) : record[rowKey];
+        if (selected) {
+          onRowSelect?.(key, record);
+        } else {
+          onRowDeselect?.(key, record);
+        }
+      } : void 0
+    };
+    return config;
+  }, [
+    selectable,
+    showSelectAllCheckbox,
+    selectedKeysToUse,
+    multipleSelection,
+    disabledSelection,
+    onRowSelect,
+    onRowDeselect,
+    onChange,
+    rowKey
+  ]);
+  return {
+    rowSelectionConfig,
+    handleRowClickSelection,
+    selectedKeys: selectedKeysToUse,
+    selectedRecords
+  };
+}
+
+export { useRowSelectionConfig };

package/esm/vef-table/hooks/use-selected-rows.js

@@ -0,0 +1,27 @@
+"use strict";
+import { useState, useRef, useCallback } from 'react';
+
+"use strict";
+function useSelectedRows({
+  selectedKeys,
+  defaultSelectedKeys,
+  onRowSelectionChange
+}) {
+  const [internalSelectedKeys, setInternalSelectedKeys] = useState(defaultSelectedKeys ?? []);
+  const selectedKeysToUse = selectedKeys ?? internalSelectedKeys;
+  const selectedRecords = useRef([]);
+  const onChange = useCallback((keys, records) => {
+    if (!selectedKeys) {
+      setInternalSelectedKeys(keys);
+    }
+    selectedRecords.current = records;
+    onRowSelectionChange?.(keys, records);
+  }, [onRowSelectionChange, selectedKeys]);
+  return {
+    selectedKeys: selectedKeysToUse,
+    selectedRecords,
+    onChange
+  };
+}
+
+export { useSelectedRows };

package/esm/vef-table/hooks/use-table-columns.js

@@ -0,0 +1,57 @@
+"use strict";
+import { jsx } from '@emotion/react/jsx-runtime';
+import { isNumber, isDeepEqual } from '@vef-framework/shared';
+import { useMemo } from 'react';
+import { columnComponents } from '../components/columns/index.js';
+
+"use strict";
+function useTableColumns(columns, rowNumberColumn, operationColumn) {
+  return useMemo(() => {
+    const columnsToUse = [];
+    const dataColumns = columns.map((column) => {
+      const {
+        title,
+        show,
+        sort,
+        fixed,
+        dependentColumnNames,
+        ...columnProps
+      } = column;
+      const sortToUse = isNumber(sort) ? { multiple: sort } : sort ?? false ? true : void 0;
+      const ColumnComponent = columnComponents[column.type];
+      return {
+        key: columnProps.name,
+        dataIndex: columnProps.name,
+        title: title || columnProps.name,
+        fixed,
+        hidden: !(show ?? true),
+        sorter: sortToUse,
+        align: columnProps.align,
+        width: columnProps.width,
+        shouldCellUpdate: (record, prevRecord) => !isDeepEqual(
+          dependentColumnNames.map((name) => record[name]),
+          dependentColumnNames.map((name) => prevRecord[name])
+        ),
+        render: (value, record, rowIndex) => /* @__PURE__ */ jsx(
+          ColumnComponent,
+          {
+            columnProps,
+            record,
+            rowIndex,
+            value
+          }
+        )
+      };
+    });
+    if (rowNumberColumn) {
+      columnsToUse.push(rowNumberColumn);
+    }
+    columnsToUse.push(...dataColumns);
+    if (operationColumn) {
+      columnsToUse.push(operationColumn);
+    }
+    return columnsToUse;
+  }, [columns, rowNumberColumn, operationColumn]);
+}
+
+export { useTableColumns };

package/esm/vef-table/hooks/use-table-context.js

@@ -0,0 +1,22 @@
+"use strict";
+import { createSelectableContext, noop } from '@vef-framework/shared';
+
+"use strict";
+const {
+  useContextSelector,
+  useContext,
+  ContextProvider: TableContextProvider
+} = createSelectableContext({
+  isFetching: false,
+  refetch: () => Promise.resolve({}),
+  selectedKeys: [],
+  selectedRecords: [],
+  defaultColumnConfigMap: /* @__PURE__ */ new Map(),
+  columnConfigMap: /* @__PURE__ */ new Map(),
+  setColumnConfigMap: noop,
+  columnConfigMapHasChanged: false
+});
+const useTableContextSelector = useContextSelector;
+const useTableContext = useContext;
+
+export { TableContextProvider, useTableContext, useTableContextSelector };

package/esm/vef-table/hooks/use-table-instance.js

@@ -0,0 +1,16 @@
+"use strict";
+import { useRef, useImperativeHandle } from 'react';
+
+"use strict";
+function useTableInstance(ref, data, refetch) {
+  const tableRef = useRef(null);
+  useImperativeHandle(ref, () => ({
+    getData: () => data,
+    refetch: async () => {
+      await refetch();
+    }
+  }));
+  return tableRef;
+}
+
+export { useTableInstance };

package/esm/vef-table/hooks/use-table-summary.js

@@ -0,0 +1,43 @@
+"use strict";
+import { jsx } from '@emotion/react/jsx-runtime';
+import { isFunction } from '@vef-framework/shared';
+import { Table } from 'antd';
+import { useMemo } from 'react';
+
+"use strict";
+const { Summary } = Table;
+const { Row, Cell } = Summary;
+function useTableSummary(columns) {
+  const summaryColumns = useMemo(() => columns.filter((column) => isFunction(column.summary)).map((column) => {
+    const {
+      name,
+      summary,
+      summaryColSpan
+    } = column;
+    return {
+      name,
+      summary,
+      summaryColSpan: summaryColSpan ?? 1
+    };
+  }), [columns]);
+  return useMemo(() => {
+    if (summaryColumns.length === 0) {
+      return;
+    }
+    return (records) => /* @__PURE__ */ jsx(Summary, { fixed: "bottom", children: /* @__PURE__ */ jsx(Row, { children: summaryColumns.map(({
+      name,
+      summary,
+      summaryColSpan
+    }, index) => /* @__PURE__ */ jsx(
+      Cell,
+      {
+        colSpan: summaryColSpan,
+        index,
+        children: summary(records)
+      },
+      name
+    )) }) });
+  }, [summaryColumns]);
+}
+
+export { useTableSummary };

package/esm/vef-table/hooks/use-table-width.js

@@ -0,0 +1,14 @@
+"use strict";
+import { useMemo } from 'react';
+
+"use strict";
+const defaultColumnWidth = 160;
+const selectionColumnWidth = 40;
+function useTableWidth(columns, selectable) {
+  return useMemo(() => {
+    const width = columns.filter((column) => column.hidden !== true).map((column) => column.width ?? column.minWidth ?? defaultColumnWidth).reduce((acc, w) => acc + w, 0);
+    return selectable ? width + selectionColumnWidth : width;
+  }, [columns, selectable]);
+}
+
+export { useTableWidth };