@cerberus-design/data-grid 0.25.3 → 1.0.0-rc.5

package/dist/store.js

@@ -1,283 +1,244 @@
-'use client';
-import { createSignal, createComputed, batch } from '@cerberus-design/signals';
-import { determineRowHeight, determinePageIndex, determinePageSize, determinePageRange, determineInitialCount } from './utils.js';
-import { DEFAULT_PAGE_IDX } from './const.js';
-
+"use client";
+import { determineInitialCount, determinePageIndex, determinePageRange, determinePageSize, determineRowHeight } from "./utils.js";
+import { batch, createComputed, createSignal } from "@cerberus-design/signals";
+//#region src/store.ts
+/**
+* Internal signal-based Store engine driving the state. We expose this in
+* the public Context API.
+*/
 function createGridStore(options) {
-  const [containerWidth, setContainerWidth] = createSignal(0);
-  const [rows, setRows] = createSignal(options.data);
-  const [rowSize] = createSignal(determineRowHeight(options.rowSize));
-  const [globalFilter, setGlobalFilter] = createSignal("");
-  const [sorting, setSorting] = createSignal([]);
-  const [pageIndex, setPageIndex] = createSignal(
-    determinePageIndex(options.initialState?.pagination)
-  );
-  const [pageSize, setPageSize] = createSignal(
-    determinePageSize(options.initialState?.pagination)
-  );
-  const [pageRange] = createSignal(
-    determinePageRange(options.initialState?.pagination)
-  );
-  const [isServerPaginated] = createSignal(
-    Boolean(determineInitialCount(options.initialState?.pagination))
-  );
-  const initialCols = options.columns.map((col) => {
-    const pinnable = Boolean(col.features?.pinning);
-    const filterable = Boolean(col.features?.filter);
-    const sortable = Boolean(col.features?.sort);
-    const hasFeatures = pinnable || filterable || sortable;
-    const minWForFeatures = 100;
-    let finalWidth = col.width ?? 150;
-    if (hasFeatures && col.width && col.width < minWForFeatures) {
-      finalWidth = minWForFeatures;
-    }
-    const [isVisible] = createSignal(true);
-    const [isFlex, setFlex] = createSignal(col.width === void 0);
-    const [pinned, setPinned] = createSignal(
-      col.features?.pinning?.defaultPosition ?? false
-    );
-    const [width, setColWidth] = createSignal(finalWidth);
-    return {
-      id: col.id,
-      isFlex,
-      isVisible,
-      original: col,
-      pinned,
-      width,
-      getValue: col.accessor,
-      // feature flags
-      pinnable,
-      filterable,
-      sortable,
-      // setters
-      setFlex,
-      setPinned,
-      setColWidth
-    };
-  });
-  const [columns] = createSignal(initialCols);
-  const currentPageRange = createComputed(
-    () => {
-      const dataIdx = pageIndex() - 1;
-      const isFirstPage = dataIdx === 0;
-      const start = isFirstPage ? 0 : dataIdx * pageSize() - 1;
-      return {
-        start,
-        end: pageIndex() * pageSize()
-      };
-    }
-  );
-  const processedRows = createComputed(() => {
-    let result = [...rows()];
-    const filter = globalFilter().toLowerCase();
-    const sortState = sorting();
-    if (filter) {
-      result = result.filter((row) => {
-        return columns().some((col) => {
-          if (!col.filterable) return false;
-          const val = String(col.getValue(row)).toLowerCase();
-          return val.includes(filter);
-        });
-      });
-    }
-    if (sortState.length > 0) {
-      result.sort((a, b) => {
-        for (const sort of sortState) {
-          const col = columns().find((c) => c.id === sort.id);
-          if (!col) continue;
-          const valA = col.getValue(a);
-          const valB = col.getValue(b);
-          if (valA === valB) continue;
-          let comparison = 0;
-          const customComparator = typeof col.original.features?.sort === "object" ? col.original.features.sort.comparator : void 0;
-          if (customComparator) {
-            comparison = customComparator(valA, valB);
-          } else {
-            comparison = valA > valB ? 1 : -1;
-          }
-          return sort.desc ? -comparison : comparison;
-        }
-        return 0;
-      });
-    }
-    return result;
-  });
-  const rowCount = createComputed(
-    () => determineInitialCount(options?.initialState?.pagination) ?? processedRows().length
-  );
-  const pageCount = createComputed(() => Math.ceil(rowCount() / pageSize()));
-  const orderedColumns = createComputed(() => {
-    const left = [];
-    const center = [];
-    const right = [];
-    columns().forEach((col) => {
-      const pin = col.pinned();
-      if (pin === "left") left.push(col);
-      else if (pin === "right") right.push(col);
-      else center.push(col);
-    });
-    return [...left, ...center, ...right];
-  });
-  const visibleRows = createComputed(() => {
-    if (pageSize() && pageCount() > 1) {
-      const currentRange = currentPageRange();
-      return processedRows().slice(currentRange.start, currentRange.end);
-    }
-    return processedRows();
-  });
-  const rootCssVars = createComputed(() => {
-    const vars = {};
-    const visibleCols = [];
-    const cols = columns();
-    const cWidth = containerWidth();
-    let fixedSpace = 0;
-    let flexCount = 0;
-    for (let i = 0; i < cols.length; i++) {
-      const col = cols[i];
-      if (!col.isVisible()) continue;
-      visibleCols.push(col);
-      if (col.isFlex()) {
-        flexCount++;
-      } else {
-        fixedSpace += col.width();
-      }
-      const order = orderedColumns().findIndex(
-        (orderedCol) => orderedCol.id === col.id
-      );
-      vars[`--col-${col.id}-order`] = `${order}`;
-    }
-    const remainingSpace = Math.max(0, cWidth - fixedSpace);
-    const flexWidth = flexCount > 0 ? remainingSpace / flexCount : 0;
-    let leftOffset = 0;
-    let totalW = 0;
-    const computedWidths = new Float64Array(visibleCols.length);
-    for (let i = 0; i < visibleCols.length; i++) {
-      const col = visibleCols[i];
-      let finalWidth = col.width();
-      if (col.isFlex()) {
-        finalWidth = Math.max(col.original.minWidth ?? 150, flexWidth);
-      }
-      computedWidths[i] = finalWidth;
-      totalW += finalWidth;
-      vars[`--col-${col.id}-width`] = `${finalWidth}px`;
-      if (col.pinned() === "left") {
-        vars[`--col-${col.id}-left`] = `${leftOffset}px`;
-        leftOffset += finalWidth;
-      }
-    }
-    let rightOffset = 0;
-    for (let i = visibleCols.length - 1; i >= 0; i--) {
-      const col = visibleCols[i];
-      if (col.pinned() === "right") {
-        vars[`--col-${col.id}-right`] = `${rightOffset}px`;
-        rightOffset += computedWidths[i];
-      }
-    }
-    vars["--total-grid-width"] = `${totalW}px`;
-    vars["--row-height"] = `${rowSize()}px`;
-    return vars;
-  });
-  const totalWidth = createComputed(
-    () => columns().reduce((acc, c) => acc + c.width(), 0)
-  );
-  return {
-    columns,
-    rows,
-    globalFilter,
-    sorting,
-    pageCount,
-    pageIndex,
-    pageSize,
-    pageRange,
-    currentPageRange,
-    isServerPaginated,
-    rootCssVars,
-    rowCount,
-    rowSize,
-    totalWidth,
-    visibleRows,
-    // Actions
-    updateData: (newData) => {
-      setRows(newData);
-    },
-    setSort: (colId, direction, multi = false) => {
-      if (direction === null) {
-        setSorting(sorting().filter((s) => s.id !== colId));
-        return;
-      }
-      const current = sorting();
-      const newSort = { id: colId, desc: direction === "desc" };
-      if (multi) {
-        const existingIndex = current.findIndex((s) => s.id === colId);
-        if (existingIndex >= 0) {
-          const next = [...current];
-          next[existingIndex] = newSort;
-          setSorting(next);
-        } else {
-          setSorting([...current, newSort]);
-        }
-      } else {
-        setSorting([newSort]);
-      }
-    },
-    togglePinned: (colId, state) => {
-      const col = columns().find((c) => c.id === colId);
-      if (col) col.setPinned(state ?? false);
-    },
-    toggleSort: (colId, multi) => {
-      const current = sorting();
-      const exists = current.findIndex((s) => s.id === colId) !== -1;
-      const updatedSort = current.map((s) => {
-        if (s.id === colId) {
-          return { ...s, desc: !s.desc };
-        }
-        return s;
-      });
-      if (exists) {
-        setSorting(multi ? [...current, ...updatedSort] : [...updatedSort]);
-      } else {
-        const newSort = { id: colId, desc: true };
-        setSorting(multi ? [...current, newSort] : [newSort]);
-      }
-    },
-    setPage: (details) => {
-      setPageIndex(details.page);
-      options.onPageChange?.(details);
-    },
-    setPageSize: (size) => {
-      if (isServerPaginated()) {
-        setPageIndex(DEFAULT_PAGE_IDX);
-      }
-      setPageSize(size);
-    },
-    setGlobalFilter: (val) => {
-      batch(() => {
-        setGlobalFilter(val);
-        setPageIndex(DEFAULT_PAGE_IDX);
-      });
-    },
-    setContainerWidth: (w) => {
-      setContainerWidth(w);
-    },
-    resizeColumn: (colId, delta) => {
-      const col = columns().find((c) => c.id === colId);
-      if (col) {
-        if (col.isFlex()) {
-          const fixedSpace = columns().filter((c) => !c.isFlex()).reduce((a, b) => a + b.width(), 0);
-          const flexCount = columns().filter((c) => c.isFlex()).length;
-          const currentFlexWidth = Math.max(
-            col.original.minWidth ?? 150,
-            (containerWidth() - fixedSpace) / flexCount
-          );
-          col.setColWidth(currentFlexWidth);
-          col.setFlex(false);
-        }
-        col.setColWidth(
-          Math.max(col.original.minWidth ?? 50, col.width() + delta)
-        );
-      }
-    }
-  };
+	const [containerWidth, setContainerWidth] = createSignal(0);
+	const [rows, setRows] = createSignal(options.data);
+	const [rowSize] = createSignal(determineRowHeight(options.rowSize));
+	const [globalFilter, setGlobalFilter] = createSignal("");
+	const [sorting, setSorting] = createSignal([]);
+	const [pageIndex, setPageIndex] = createSignal(determinePageIndex(options.initialState?.pagination));
+	const [pageSize, setPageSize] = createSignal(determinePageSize(options.initialState?.pagination));
+	const [pageRange] = createSignal(determinePageRange(options.initialState?.pagination));
+	const [isServerPaginated] = createSignal(Boolean(determineInitialCount(options.initialState?.pagination)));
+	const [columns] = createSignal(options.columns.map((col) => {
+		const pinnable = Boolean(col.features?.pinning);
+		const filterable = Boolean(col.features?.filter);
+		const sortable = Boolean(col.features?.sort);
+		const hasFeatures = pinnable || filterable || sortable;
+		const minWForFeatures = 100;
+		let finalWidth = col.width ?? 150;
+		if (hasFeatures && col.width && col.width < minWForFeatures) finalWidth = minWForFeatures;
+		const [isVisible] = createSignal(true);
+		const [isFlex, setFlex] = createSignal(col.width === void 0);
+		const [pinned, setPinned] = createSignal(col.features?.pinning?.defaultPosition ?? false);
+		const [width, setColWidth] = createSignal(finalWidth);
+		return {
+			id: col.id,
+			isFlex,
+			isVisible,
+			original: col,
+			pinned,
+			width,
+			getValue: col.accessor,
+			pinnable,
+			filterable,
+			sortable,
+			setFlex,
+			setPinned,
+			setColWidth
+		};
+	}));
+	const currentPageRange = createComputed(() => {
+		const dataIdx = pageIndex() - 1;
+		return {
+			start: dataIdx === 0 ? 0 : dataIdx * pageSize() - 1,
+			end: pageIndex() * pageSize()
+		};
+	});
+	const processedRows = createComputed(() => {
+		let result = [...rows()];
+		const filter = globalFilter().toLowerCase();
+		const sortState = sorting();
+		if (filter) result = result.filter((row) => {
+			return columns().some((col) => {
+				if (!col.filterable) return false;
+				return String(col.getValue(row)).toLowerCase().includes(filter);
+			});
+		});
+		if (sortState.length > 0) result.sort((a, b) => {
+			for (const sort of sortState) {
+				const col = columns().find((c) => c.id === sort.id);
+				if (!col) continue;
+				const valA = col.getValue(a);
+				const valB = col.getValue(b);
+				if (valA === valB) continue;
+				let comparison = 0;
+				const customComparator = typeof col.original.features?.sort === "object" ? col.original.features.sort.comparator : void 0;
+				if (customComparator) comparison = customComparator(valA, valB);
+				else comparison = valA > valB ? 1 : -1;
+				return sort.desc ? -comparison : comparison;
+			}
+			return 0;
+		});
+		return result;
+	});
+	const rowCount = createComputed(() => determineInitialCount(options?.initialState?.pagination) ?? processedRows().length);
+	const pageCount = createComputed(() => Math.ceil(rowCount() / pageSize()));
+	const orderedColumns = createComputed(() => {
+		const left = [];
+		const center = [];
+		const right = [];
+		columns().forEach((col) => {
+			const pin = col.pinned();
+			if (pin === "left") left.push(col);
+			else if (pin === "right") right.push(col);
+			else center.push(col);
+		});
+		return [
+			...left,
+			...center,
+			...right
+		];
+	});
+	const visibleRows = createComputed(() => {
+		if (pageSize() && pageCount() > 1) {
+			const currentRange = currentPageRange();
+			return processedRows().slice(currentRange.start, currentRange.end);
+		}
+		return processedRows();
+	});
+	return {
+		columns,
+		rows,
+		globalFilter,
+		sorting,
+		pageCount,
+		pageIndex,
+		pageSize,
+		pageRange,
+		currentPageRange,
+		isServerPaginated,
+		rootCssVars: createComputed(() => {
+			const vars = {};
+			const visibleCols = [];
+			const cols = columns();
+			const cWidth = containerWidth();
+			let fixedSpace = 0;
+			let flexCount = 0;
+			for (let i = 0; i < cols.length; i++) {
+				const col = cols[i];
+				if (!col.isVisible()) continue;
+				visibleCols.push(col);
+				if (col.isFlex()) flexCount++;
+				else fixedSpace += col.width();
+				const order = orderedColumns().findIndex((orderedCol) => orderedCol.id === col.id);
+				vars[`--col-${col.id}-order`] = `${order}`;
+			}
+			const remainingSpace = Math.max(0, cWidth - fixedSpace);
+			const flexWidth = flexCount > 0 ? remainingSpace / flexCount : 0;
+			let leftOffset = 0;
+			let totalW = 0;
+			const computedWidths = new Float64Array(visibleCols.length);
+			for (let i = 0; i < visibleCols.length; i++) {
+				const col = visibleCols[i];
+				let finalWidth = col.width();
+				if (col.isFlex()) finalWidth = Math.max(col.original.minWidth ?? 150, flexWidth);
+				computedWidths[i] = finalWidth;
+				totalW += finalWidth;
+				vars[`--col-${col.id}-width`] = `${finalWidth}px`;
+				if (col.pinned() === "left") {
+					vars[`--col-${col.id}-left`] = `${leftOffset}px`;
+					leftOffset += finalWidth;
+				}
+			}
+			let rightOffset = 0;
+			for (let i = visibleCols.length - 1; i >= 0; i--) {
+				const col = visibleCols[i];
+				if (col.pinned() === "right") {
+					vars[`--col-${col.id}-right`] = `${rightOffset}px`;
+					rightOffset += computedWidths[i];
+				}
+			}
+			vars["--total-grid-width"] = `${totalW}px`;
+			vars["--row-height"] = `${rowSize()}px`;
+			return vars;
+		}),
+		rowCount,
+		rowSize,
+		totalWidth: createComputed(() => columns().reduce((acc, c) => acc + c.width(), 0)),
+		visibleRows,
+		updateData: (newData) => {
+			setRows(newData);
+		},
+		setSort: (colId, direction, multi = false) => {
+			if (direction === null) {
+				setSorting(sorting().filter((s) => s.id !== colId));
+				return;
+			}
+			const current = sorting();
+			const newSort = {
+				id: colId,
+				desc: direction === "desc"
+			};
+			if (multi) {
+				const existingIndex = current.findIndex((s) => s.id === colId);
+				if (existingIndex >= 0) {
+					const next = [...current];
+					next[existingIndex] = newSort;
+					setSorting(next);
+				} else setSorting([...current, newSort]);
+			} else setSorting([newSort]);
+		},
+		togglePinned: (colId, state) => {
+			const col = columns().find((c) => c.id === colId);
+			if (col) col.setPinned(state ?? false);
+		},
+		toggleSort: (colId, multi) => {
+			const current = sorting();
+			const exists = current.findIndex((s) => s.id === colId) !== -1;
+			const updatedSort = current.map((s) => {
+				if (s.id === colId) return {
+					...s,
+					desc: !s.desc
+				};
+				return s;
+			});
+			if (exists) setSorting(multi ? [...current, ...updatedSort] : [...updatedSort]);
+			else {
+				const newSort = {
+					id: colId,
+					desc: true
+				};
+				setSorting(multi ? [...current, newSort] : [newSort]);
+			}
+		},
+		setPage: (details) => {
+			setPageIndex(details.page);
+			options.onPageChange?.(details);
+		},
+		setPageSize: (size) => {
+			if (isServerPaginated()) setPageIndex(1);
+			setPageSize(size);
+		},
+		setGlobalFilter: (val) => {
+			batch(() => {
+				setGlobalFilter(val);
+				setPageIndex(1);
+			});
+		},
+		setContainerWidth: (w) => {
+			setContainerWidth(w);
+		},
+		resizeColumn: (colId, delta) => {
+			const col = columns().find((c) => c.id === colId);
+			if (col) {
+				if (col.isFlex()) {
+					const fixedSpace = columns().filter((c) => !c.isFlex()).reduce((a, b) => a + b.width(), 0);
+					const flexCount = columns().filter((c) => c.isFlex()).length;
+					const currentFlexWidth = Math.max(col.original.minWidth ?? 150, (containerWidth() - fixedSpace) / flexCount);
+					col.setColWidth(currentFlexWidth);
+					col.setFlex(false);
+				}
+				col.setColWidth(Math.max(col.original.minWidth ?? 50, col.width() + delta));
+			}
+		}
+	};
 }
-
+//#endregion
 export { createGridStore };

package/dist/utils.cjs

@@ -1,57 +1,35 @@
-'use client';
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
-const _const = require('./const.cjs');
-
-function determineRowHeight(rowSize = _const.SM) {
-  const prebuiltSizes = _const.ROW_SIZES.items;
-  if (typeof rowSize === "number") {
-    return rowSize;
-  }
-  if (prebuiltSizes.includes(rowSize)) {
-    const size = _const.ROW_SIZES.results[rowSize];
-    return size;
-  }
-  console.error(
-    "Unknown row size provided to Data Grid. The rowSize prop requires a number to determine pixel-based value.",
-    rowSize
-  );
-  return 0;
+"use client";
+const require_const = require("./const.cjs");
+//#region src/utils.ts
+function determineRowHeight(rowSize = "sm") {
+	const prebuiltSizes = require_const.ROW_SIZES.items;
+	if (typeof rowSize === "number") return rowSize;
+	if (prebuiltSizes.includes(rowSize)) return require_const.ROW_SIZES.results[rowSize];
+	console.error("Unknown row size provided to Data Grid. The rowSize prop requires a number to determine pixel-based value.", rowSize);
+	return 0;
 }
 function determinePageSize(options) {
-  if (!options) return 0;
-  if (typeof options === "boolean" && options === true) {
-    return _const.SM_PAGE_SIZE;
-  }
-  if (options.customRange?.length) {
-    return options.customRange[0];
-  }
-  return options.pageSize ?? _const.SM_PAGE_SIZE;
+	if (!options) return 0;
+	if (typeof options === "boolean" && options === true) return 25;
+	if (options.customRange?.length) return options.customRange[0];
+	return options.pageSize ?? 25;
 }
 function determinePageIndex(options) {
-  if (!options) return _const.DEFAULT_PAGE_IDX;
-  if (typeof options === "boolean" && options === true) {
-    return _const.DEFAULT_PAGE_IDX;
-  }
-  return options.defaultPage ?? _const.DEFAULT_PAGE_IDX;
+	if (!options) return 1;
+	if (typeof options === "boolean" && options === true) return 1;
+	return options.defaultPage ?? 1;
 }
 function determinePageRange(options) {
-  if (!options) return _const.DEFAULT_PAGE_SIZES;
-  if (typeof options === "boolean" && options === true) {
-    return _const.DEFAULT_PAGE_SIZES;
-  }
-  return options.customRange ?? _const.DEFAULT_PAGE_SIZES;
+	if (!options) return require_const.DEFAULT_PAGE_SIZES;
+	if (typeof options === "boolean" && options === true) return require_const.DEFAULT_PAGE_SIZES;
+	return options.customRange ?? require_const.DEFAULT_PAGE_SIZES;
 }
 function determineInitialCount(options) {
-  if (!options) return void 0;
-  if (typeof options === "boolean" && options === true) {
-    return void 0;
-  }
-  return options?.count ?? void 0;
+	if (!options) return void 0;
+	if (typeof options === "boolean" && options === true) return;
+	return options?.count ?? void 0;
 }
-
+//#endregion
 exports.determineInitialCount = determineInitialCount;
 exports.determinePageIndex = determinePageIndex;
 exports.determinePageRange = determinePageRange;