feat(grid): sort local filter values by count
This commit is contained in:
7 files changed
+310
-16
No files matched your search
+37
-1
@@ -1,5 +1,9 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { buildDataGridLocalFilterOptions, dataGridLocalFilterKey, restoreDataGridLocalColumnFilters, rowMatchesDataGridLocalColumnFilters, serializeDataGridLocalColumnFilters } from "@/lib/dataGrid/dataGridLocalColumnFilterState";
|
||||
import { buildDataGridLocalFilterOptions, dataGridLocalFilterKey, restoreDataGridLocalColumnFilters, rowMatchesDataGridLocalColumnFilters, serializeDataGridLocalColumnFilters, sortDataGridLocalFilterOptions, type DataGridLocalFilterOption } from "@/lib/dataGrid/dataGridLocalColumnFilterState";
|
||||
|
||||
function filterOption(label: string, count: number | null): DataGridLocalFilterOption {
|
||||
return { key: `str:${label}`, label, count, value: label };
|
||||
}
|
||||
|
||||
describe("data grid local column filter state", () => {
|
||||
it("round-trips selected values so a remounted grid restores its filters", () => {
|
||||
@@ -67,4 +71,36 @@ describe("data grid local column filter state", () => {
|
||||
{ key: "str:beta", label: "beta", count: 2, value: "beta" },
|
||||
]);
|
||||
});
|
||||
|
||||
it("sorts filter options by count in both directions and treats a missing count as zero", () => {
|
||||
const options = [filterOption("beta", 2), filterOption("alpha", 5), filterOption("delta", null), filterOption("gamma", 1)];
|
||||
|
||||
expect(sortDataGridLocalFilterOptions(options, { field: "count", direction: "asc" }).map((option) => option.label)).toEqual(["delta", "gamma", "beta", "alpha"]);
|
||||
expect(sortDataGridLocalFilterOptions(options, { field: "count", direction: "desc" }).map((option) => option.label)).toEqual(["alpha", "beta", "gamma", "delta"]);
|
||||
});
|
||||
|
||||
it("breaks equal-count ties by value ascending regardless of the count direction", () => {
|
||||
const options = [filterOption("delta", 3), filterOption("beta", 3), filterOption("alpha", 3)];
|
||||
|
||||
expect(sortDataGridLocalFilterOptions(options, { field: "count", direction: "asc" }).map((option) => option.label)).toEqual(["alpha", "beta", "delta"]);
|
||||
expect(sortDataGridLocalFilterOptions(options, { field: "count", direction: "desc" }).map((option) => option.label)).toEqual(["alpha", "beta", "delta"]);
|
||||
});
|
||||
|
||||
it("keeps null first for value ascending and last for value descending", () => {
|
||||
const options: DataGridLocalFilterOption[] = [filterOption("alpha", 1), { key: "__dbx_null__", label: "NULL", count: null, value: null }, filterOption("beta", 1)];
|
||||
|
||||
expect(sortDataGridLocalFilterOptions(options, { field: "value", direction: "asc" }).map((option) => option.value)).toEqual([null, "alpha", "beta"]);
|
||||
expect(sortDataGridLocalFilterOptions(options, { field: "value", direction: "desc" }).map((option) => option.value)).toEqual(["beta", "alpha", null]);
|
||||
});
|
||||
|
||||
it("returns a new sorted array without mutating the input options", () => {
|
||||
const options = [filterOption("beta", 2), filterOption("alpha", 5)];
|
||||
const snapshot = options.map((option) => ({ ...option }));
|
||||
|
||||
const sorted = sortDataGridLocalFilterOptions(options, { field: "count", direction: "desc" });
|
||||
|
||||
expect(sorted).not.toBe(options);
|
||||
expect(sorted.map((option) => option.label)).toEqual(["alpha", "beta"]);
|
||||
expect(options).toEqual(snapshot);
|
||||
});
|
||||
});
|
||||
@@ -9,6 +9,27 @@ export type DataGridLocalFilterOption = {
|
||||
value: CellValue;
|
||||
};
|
||||
|
||||
export type DataGridLocalFilterSort = {
|
||||
field: "value" | "count";
|
||||
direction: "asc" | "desc";
|
||||
};
|
||||
|
||||
function compareLocalFilterValues(a: DataGridLocalFilterOption, b: DataGridLocalFilterOption): number {
|
||||
if (a.value === null && b.value !== null) return -1;
|
||||
if (a.value !== null && b.value === null) return 1;
|
||||
return a.label.localeCompare(b.label, undefined, { numeric: true, sensitivity: "base" });
|
||||
}
|
||||
|
||||
export function sortDataGridLocalFilterOptions(options: readonly DataGridLocalFilterOption[], sort: DataGridLocalFilterSort): DataGridLocalFilterOption[] {
|
||||
const direction = sort.direction === "asc" ? 1 : -1;
|
||||
return [...options].sort((a, b) => {
|
||||
if (sort.field === "count") {
|
||||
return ((a.count ?? 0) - (b.count ?? 0)) * direction || compareLocalFilterValues(a, b);
|
||||
}
|
||||
return compareLocalFilterValues(a, b) * direction;
|
||||
});
|
||||
}
|
||||
|
||||
export function dataGridLocalFilterKey(value: CellValue): string {
|
||||
if (value === null) return "__dbx_null__";
|
||||
if (typeof value === "boolean") return `bool:${value}`;
|
||||
@@ -62,14 +83,7 @@ export function buildDataGridLocalFilterOptions<TRow>({
|
||||
addValue(row[columnIndex] ?? null);
|
||||
}
|
||||
|
||||
return [...byKey.values()].sort((a, b) => {
|
||||
if (a.value === null && b.value !== null) return -1;
|
||||
if (a.value !== null && b.value === null) return 1;
|
||||
return a.label.localeCompare(b.label, undefined, {
|
||||
numeric: true,
|
||||
sensitivity: "base",
|
||||
});
|
||||
});
|
||||
return sortDataGridLocalFilterOptions([...byKey.values()], { field: "value", direction: "asc" });
|
||||
}
|
||||
|
||||
export function restoreDataGridLocalColumnFilters(serialized: SerializedDataGridLocalColumnFilters | undefined, columnCount: number, currentColumns?: readonly string[], serializedColumns?: readonly string[]): Record<number, Set<string>> {
|
||||
|
||||
Reference in new issue
Block a user