feat(grid): add frozen columns
This commit is contained in:
1 parent
6e5f582320
commit
dfab2d09ed
16 files changed
+809
-28
No files matched your search
@@ -187,4 +187,223 @@ describe("useDataGridColumnLayout", () => {
|
||||
window.dispatchEvent(new PointerEvent("pointerup", { clientX: 180, clientY: 10 }));
|
||||
expect(persist).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
describe("frozen columns", () => {
|
||||
it("starts with frozenColumnCount of 0", () => {
|
||||
const scope = effectScope();
|
||||
const state = scope.run(() =>
|
||||
useDataGridColumnLayoutState({
|
||||
columns: ref(["id", "name", "email"]),
|
||||
sourceColumns: ref(undefined),
|
||||
commentByColumn: ref(new Map()),
|
||||
displayableColumnIndexes: ref([0, 1, 2]),
|
||||
allNullColumnIndexes: ref([]),
|
||||
columnOrderKeys: ref(["id\0\0", "name\0\0", "email\0\0"]),
|
||||
layoutScopeKey: ref("frozen-test-layout"),
|
||||
tableScopeKey: ref(""),
|
||||
}),
|
||||
)!;
|
||||
expect(state.frozenColumnCount.value).toBe(0);
|
||||
scope.stop();
|
||||
});
|
||||
|
||||
it("freezeToColumn sets frozenColumnCount to visibleColIdx + 1", () => {
|
||||
const scope = effectScope();
|
||||
const state = scope.run(() =>
|
||||
useDataGridColumnLayoutState({
|
||||
columns: ref(["id", "name", "email"]),
|
||||
sourceColumns: ref(undefined),
|
||||
commentByColumn: ref(new Map()),
|
||||
displayableColumnIndexes: ref([0, 1, 2]),
|
||||
allNullColumnIndexes: ref([]),
|
||||
columnOrderKeys: ref(["id\0\0", "name\0\0", "email\0\0"]),
|
||||
layoutScopeKey: ref("frozen-test-layout-2"),
|
||||
tableScopeKey: ref(""),
|
||||
}),
|
||||
)!;
|
||||
|
||||
state.freezeToColumn(0);
|
||||
expect(state.frozenColumnCount.value).toBe(1);
|
||||
|
||||
state.freezeToColumn(2);
|
||||
expect(state.frozenColumnCount.value).toBe(3);
|
||||
|
||||
scope.stop();
|
||||
});
|
||||
|
||||
it("unfreezeAllColumns resets frozenColumnCount to 0", () => {
|
||||
const scope = effectScope();
|
||||
const state = scope.run(() =>
|
||||
useDataGridColumnLayoutState({
|
||||
columns: ref(["id", "name", "email"]),
|
||||
sourceColumns: ref(undefined),
|
||||
commentByColumn: ref(new Map()),
|
||||
displayableColumnIndexes: ref([0, 1, 2]),
|
||||
allNullColumnIndexes: ref([]),
|
||||
columnOrderKeys: ref(["id\0\0", "name\0\0", "email\0\0"]),
|
||||
layoutScopeKey: ref("frozen-test-layout-3"),
|
||||
tableScopeKey: ref(""),
|
||||
}),
|
||||
)!;
|
||||
|
||||
state.freezeToColumn(1);
|
||||
expect(state.frozenColumnCount.value).toBe(2);
|
||||
|
||||
state.unfreezeAllColumns();
|
||||
expect(state.frozenColumnCount.value).toBe(0);
|
||||
|
||||
scope.stop();
|
||||
});
|
||||
|
||||
it("persists frozenColumnCount to localStorage", () => {
|
||||
const scope = effectScope();
|
||||
const state = scope.run(() =>
|
||||
useDataGridColumnLayoutState({
|
||||
columns: ref(["id", "name", "email"]),
|
||||
sourceColumns: ref(undefined),
|
||||
commentByColumn: ref(new Map()),
|
||||
displayableColumnIndexes: ref([0, 1, 2]),
|
||||
allNullColumnIndexes: ref([]),
|
||||
columnOrderKeys: ref(["id\0\0", "name\0\0", "email\0\0"]),
|
||||
layoutScopeKey: ref("frozen-persist-layout"),
|
||||
tableScopeKey: ref(""),
|
||||
}),
|
||||
)!;
|
||||
|
||||
state.freezeToColumn(1);
|
||||
const raw = localStorage.getItem("dbx-data-grid-frozen-columns:frozen-persist-layout");
|
||||
expect(raw).not.toBeNull();
|
||||
expect(JSON.parse(raw!)).toEqual({ version: 1, frozenCount: 2 });
|
||||
|
||||
scope.stop();
|
||||
});
|
||||
|
||||
it("removes localStorage key when unfreezing all columns", () => {
|
||||
const scope = effectScope();
|
||||
const state = scope.run(() =>
|
||||
useDataGridColumnLayoutState({
|
||||
columns: ref(["id", "name", "email"]),
|
||||
sourceColumns: ref(undefined),
|
||||
commentByColumn: ref(new Map()),
|
||||
displayableColumnIndexes: ref([0, 1, 2]),
|
||||
allNullColumnIndexes: ref([]),
|
||||
columnOrderKeys: ref(["id\0\0", "name\0\0", "email\0\0"]),
|
||||
layoutScopeKey: ref("frozen-remove-layout"),
|
||||
tableScopeKey: ref(""),
|
||||
}),
|
||||
)!;
|
||||
|
||||
state.freezeToColumn(0);
|
||||
expect(localStorage.getItem("dbx-data-grid-frozen-columns:frozen-remove-layout")).not.toBeNull();
|
||||
|
||||
state.unfreezeAllColumns();
|
||||
expect(localStorage.getItem("dbx-data-grid-frozen-columns:frozen-remove-layout")).toBeNull();
|
||||
|
||||
scope.stop();
|
||||
});
|
||||
|
||||
it("restores frozenColumnCount from localStorage on load", async () => {
|
||||
localStorage.setItem("dbx-data-grid-frozen-columns:frozen-restore-layout", JSON.stringify({ version: 1, frozenCount: 2 }));
|
||||
|
||||
const scope = effectScope();
|
||||
const state = scope.run(() =>
|
||||
useDataGridColumnLayoutState({
|
||||
columns: ref(["id", "name", "email"]),
|
||||
sourceColumns: ref(undefined),
|
||||
commentByColumn: ref(new Map()),
|
||||
displayableColumnIndexes: ref([0, 1, 2]),
|
||||
allNullColumnIndexes: ref([]),
|
||||
columnOrderKeys: ref(["id\0\0", "name\0\0", "email\0\0"]),
|
||||
layoutScopeKey: ref("frozen-restore-layout"),
|
||||
tableScopeKey: ref(""),
|
||||
}),
|
||||
)!;
|
||||
|
||||
await nextTick();
|
||||
expect(state.frozenColumnCount.value).toBe(2);
|
||||
|
||||
scope.stop();
|
||||
});
|
||||
|
||||
it("restores the pre-freeze order after reload before unfreezing selected columns", async () => {
|
||||
const options = {
|
||||
columns: ref(["id", "name", "email"]),
|
||||
sourceColumns: ref(undefined),
|
||||
commentByColumn: ref(new Map()),
|
||||
displayableColumnIndexes: ref([0, 1, 2]),
|
||||
allNullColumnIndexes: ref([]),
|
||||
columnOrderKeys: ref(["id\0\0", "name\0\0", "email\0\0"]),
|
||||
layoutScopeKey: ref("frozen-reload-layout"),
|
||||
tableScopeKey: ref(""),
|
||||
};
|
||||
const firstScope = effectScope();
|
||||
const firstState = firstScope.run(() => useDataGridColumnLayoutState(options))!;
|
||||
|
||||
firstState.freezeSelectedColumns([2]);
|
||||
expect(firstState.orderedDisplayableColumnIndexes.value).toEqual([2, 0, 1]);
|
||||
firstScope.stop();
|
||||
|
||||
const reloadedScope = effectScope();
|
||||
const reloadedState = reloadedScope.run(() => useDataGridColumnLayoutState(options))!;
|
||||
await nextTick();
|
||||
reloadedState.unfreezeAllColumns();
|
||||
|
||||
expect(reloadedState.frozenColumnCount.value).toBe(0);
|
||||
expect(reloadedState.orderedDisplayableColumnIndexes.value).toEqual([0, 1, 2]);
|
||||
reloadedScope.stop();
|
||||
});
|
||||
|
||||
it("shrinks the persisted frozen count when visible columns are hidden", async () => {
|
||||
const scope = effectScope();
|
||||
const state = scope.run(() =>
|
||||
useDataGridColumnLayoutState({
|
||||
columns: ref(["id", "name", "email"]),
|
||||
sourceColumns: ref(undefined),
|
||||
commentByColumn: ref(new Map()),
|
||||
displayableColumnIndexes: ref([0, 1, 2]),
|
||||
allNullColumnIndexes: ref([]),
|
||||
columnOrderKeys: ref(["id\0\0", "name\0\0", "email\0\0"]),
|
||||
layoutScopeKey: ref("frozen-hidden-layout"),
|
||||
tableScopeKey: ref(""),
|
||||
}),
|
||||
)!;
|
||||
|
||||
state.freezeToColumn(2);
|
||||
state.toggleColumnVisibility(1);
|
||||
await nextTick();
|
||||
|
||||
expect(state.frozenColumnCount.value).toBe(2);
|
||||
expect(JSON.parse(localStorage.getItem("dbx-data-grid-frozen-columns:frozen-hidden-layout")!)).toMatchObject({ frozenCount: 2 });
|
||||
scope.stop();
|
||||
});
|
||||
|
||||
it("allows changing frozen count from one value to another", () => {
|
||||
const scope = effectScope();
|
||||
const state = scope.run(() =>
|
||||
useDataGridColumnLayoutState({
|
||||
columns: ref(["id", "name", "email", "phone"]),
|
||||
sourceColumns: ref(undefined),
|
||||
commentByColumn: ref(new Map()),
|
||||
displayableColumnIndexes: ref([0, 1, 2, 3]),
|
||||
allNullColumnIndexes: ref([]),
|
||||
columnOrderKeys: ref(["id\0\0", "name\0\0", "email\0\0", "phone\0\0"]),
|
||||
layoutScopeKey: ref("frozen-change-layout"),
|
||||
tableScopeKey: ref(""),
|
||||
}),
|
||||
)!;
|
||||
|
||||
state.freezeToColumn(1);
|
||||
expect(state.frozenColumnCount.value).toBe(2);
|
||||
|
||||
// 增加冻结列数
|
||||
state.freezeToColumn(3);
|
||||
expect(state.frozenColumnCount.value).toBe(4);
|
||||
|
||||
// 减少冻结列数
|
||||
state.freezeToColumn(0);
|
||||
expect(state.frozenColumnCount.value).toBe(1);
|
||||
|
||||
scope.stop();
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user