feat(grid): add configurable column width layout

Closes #10366
This commit is contained in:
t8y2 authored and t8y2 committed 2026-09-27 12:04:10 +08:00
1 parent 72f8dfeb7c
commit 4a7b8f0f27
21 files changed
+165 -2

No files matched your search

@@ -14,6 +14,7 @@ import DataGrid from "@/components/grid/DataGrid.vue";
import DataGridColumnLayoutPopover from "@/components/grid/DataGridColumnLayoutPopover.vue";
import DataGridCopyFormatControl from "@/components/grid/DataGridCopyFormatControl.vue";
import DataGridFontFamilyControl from "@/components/grid/DataGridFontFamilyControl.vue";
import DataGridColumnWidthModeControl from "@/components/grid/DataGridColumnWidthModeControl.vue";
import LightTooltip from "@/components/ui/LightTooltip.vue";
import { Switch } from "@/components/ui/switch";
import QueryLoadingState from "@/components/common/QueryLoadingState.vue";
@@ -2833,6 +2834,7 @@ defineExpose({ focusSearch });
</button>
</div>
</div>
<DataGridColumnWidthModeControl />
<DataGridFontFamilyControl />
<div class="flex items-center justify-between gap-3 px-3 py-1.5 text-xs">
<div class="min-w-0 flex items-center gap-2 font-medium">
@@ -1113,6 +1113,7 @@ describe("DocumentBrowser MongoDB filter value types", () => {
buttonWithTitle("grid.viewOptions").click();
await flushUi();
expect(document.body.textContent).toContain("grid.renderMode");
expect(document.body.textContent).toContain("grid.columnWidthMode");
expect(document.body.textContent).toContain("grid.tableFontFamily");
expect(document.body.textContent).toContain("grid.tableFontSize");
expect(document.body.textContent).toContain("grid.transposeMultiRowToggle");
@@ -1121,6 +1122,9 @@ describe("DocumentBrowser MongoDB filter value types", () => {
buttonWithText("grid.columnWidthCompact").click();
expect(settings.updateEditorSettings).toHaveBeenCalledWith({ columnWidthDensity: "compact" });
buttonWithText("grid.columnWidthModeContent").click();
expect(settings.updateEditorSettings).toHaveBeenCalledWith({ dataGridColumnWidthMode: "content" });
buttonWithText("grid.domRenderMode").click();
expect(settings.updateEditorSettings).toHaveBeenCalledWith({ dataGridRenderMode: "dom" });
@@ -2266,6 +2266,7 @@ function scrollToColumnIndex(columnIndex: number) {
// --- Column resize composable ---
const columnWidthDensity = computed(() => settingsStore.editorSettings.columnWidthDensity);
const columnWidthMode = computed(() => settingsStore.editorSettings.dataGridColumnWidthMode ?? "fill");
const tableFontFamily = computed(() => settingsStore.editorSettings.tableFontFamily);
const columnWidthCacheKey = computed(() => props.columnWidthCacheKey?.trim() || props.cacheKey?.trim() || undefined);
const columnStructureSignature = computed(() => createDataGridColumnStructureSignature(props.result.columns, props.result.column_types));
@@ -2317,6 +2318,7 @@ const { initColumnWidths, onResizeStart, autoFitColumn, autoFitAllColumns, rende
sourceRows: computed(() => props.result.rows),
columnIndexes: visibleColumnIndexes,
density: columnWidthDensity,
widthMode: columnWidthMode,
compactColumnHeaderActions,
columnIndexIndicators: visibleColumnIndexIndicators,
cacheKey: columnWidthCacheKey,
@@ -0,0 +1,37 @@
<script setup lang="ts">
import { computed } from "vue";
import { useI18n } from "vue-i18n";
import { useSettingsStore, type DataGridColumnWidthMode } from "@/stores/settingsStore";
const { t } = useI18n();
const settingsStore = useSettingsStore();
const columnWidthMode = computed(() => settingsStore.editorSettings.dataGridColumnWidthMode ?? "fill");
function setColumnWidthMode(value: DataGridColumnWidthMode) {
settingsStore.updateEditorSettings({ dataGridColumnWidthMode: value });
}
</script>
<template>
<div class="flex items-center justify-between gap-3 px-3 py-1.5 text-xs">
<div class="min-w-0 flex items-center gap-2 font-medium">
<span class="flex h-3.5 w-3.5 shrink-0 items-center justify-center text-[11px] text-muted-foreground" aria-hidden="true">↔</span>
<span>{{ t("grid.columnWidthMode") }}</span>
</div>
<div role="group" :aria-label="t('grid.columnWidthMode')" class="grid w-48 grid-cols-2 rounded-md border bg-muted/40 p-0.5">
<button
v-for="mode in ['fill', 'content'] as const"
:key="mode"
type="button"
class="h-5 min-w-0 truncate whitespace-nowrap rounded-[5px] px-1.5 text-xs transition-colors"
:class="columnWidthMode === mode ? 'bg-background font-semibold text-foreground shadow-sm' : 'text-muted-foreground hover:text-foreground'"
:aria-pressed="columnWidthMode === mode"
:data-column-width-mode="mode"
:title="t(`grid.columnWidthMode${mode === 'fill' ? 'Fill' : 'Content'}`)"
@click="setColumnWidthMode(mode)"
>
{{ t(`grid.columnWidthMode${mode === "fill" ? "Fill" : "Content"}`) }}
</button>
</div>
</div>
</template>
@@ -70,6 +70,7 @@ import ResultSetNavigator from "@/components/layout/ResultSetNavigator.vue";
import QueryResultViewSwitcher from "@/components/layout/QueryResultViewSwitcher.vue";
import DataGridCopyFormatControl from "@/components/grid/DataGridCopyFormatControl.vue";
import DataGridFontFamilyControl from "@/components/grid/DataGridFontFamilyControl.vue";
import DataGridColumnWidthModeControl from "@/components/grid/DataGridColumnWidthModeControl.vue";
import DataGridColumnLayoutPopover from "@/components/grid/DataGridColumnLayoutPopover.vue";
import type { DataGridColumnLayoutHandle } from "@/components/grid/dataGridColumnLayoutPopover";
import type { ColumnInfo } from "@/components/editor/ColumnInfoPanel.vue";
@@ -1900,6 +1901,7 @@ defineExpose({
</button>
</div>
</div>
<DataGridColumnWidthModeControl />
<DataGridFontFamilyControl />
<div class="flex items-center justify-between gap-3 px-3 py-1.5 text-xs">
<div class="min-w-0 flex items-center gap-2 font-medium">
@@ -2534,6 +2536,7 @@ defineExpose({
</button>
</div>
</div>
<DataGridColumnWidthModeControl />
<DataGridFontFamilyControl />
<div class="flex items-center justify-between gap-3 px-3 py-1.5 text-xs">
<div class="min-w-0 flex items-center gap-2 font-medium">
@@ -1,11 +1,12 @@
// @vitest-environment happy-dom
import { computed, isRef, nextTick, ref } from "vue";
import { computed, isRef, nextTick, ref, type Ref } from "vue";
import { beforeEach, describe, expect, it } from "vitest";
import { DATA_GRID_COL_AUTO_FIT_MAX_WIDTH, DATA_GRID_COL_MIN_WIDTH, sampleDataGridColumnValues } from "@/lib/dataGrid/dataGridColumnWidth";
import { clearDataGridColumnWidthStates, createDataGridColumnMeasurementSignature, createDataGridColumnStructureSignature, DATA_GRID_COLUMN_WIDTH_STATE_LIMIT, dataGridColumnWidthStateCount, loadDataGridColumnWidthState, saveDataGridColumnWidthState } from "@/lib/dataGrid/dataGridColumnWidthState";
import { DATA_GRID_ROW_NUM_WIDTH, dataGridRowNumberColumnWidth, resizeDataGridColumnWidth, useDataGridColumnResize } from "@/composables/useDataGridColumnResize";
import { resultGridColumnWidthCacheKey } from "@/lib/tabs/tabPresentation";
import type { DataGridColumnWidthMode } from "@/stores/settingsStore";
function createResizeState(options: {
columns: string[];
@@ -18,6 +19,7 @@ function createResizeState(options: {
indexIndicatorColumnIndexes?: number[] | ReturnType<typeof ref<number[]>>;
headerTextWidth?: number;
viewportWidth?: number | ReturnType<typeof ref<number>>;
widthMode?: DataGridColumnWidthMode | Ref<DataGridColumnWidthMode>;
displayValue?: (value: string | number | boolean | null, columnIndex: number) => string | number | boolean | null;
}) {
const compact = ref(options.compactColumnHeaderActions ?? true);
@@ -27,11 +29,13 @@ function createResizeState(options: {
const rows = isRef(options.rows) ? options.rows : ref(options.rows);
const indexIndicatorColumnIndexes = isRef(options.indexIndicatorColumnIndexes) ? options.indexIndicatorColumnIndexes : ref(options.indexIndicatorColumnIndexes ?? []);
const viewportWidth = isRef(options.viewportWidth) ? options.viewportWidth : ref(options.viewportWidth ?? 0);
const widthMode = isRef(options.widthMode) ? options.widthMode : ref(options.widthMode ?? "fill");
const state = useDataGridColumnResize({
columns: computed(() => options.columns),
sourceRows: computed(() => rows.value),
columnIndexes: computed(() => options.columnIndexes ?? options.columns.map((_, index) => index)),
density,
widthMode,
compactColumnHeaderActions: computed(() => compact.value),
columnIndexIndicators: computed(() => options.columns.map((_, index) => indexIndicatorColumnIndexes.value.includes(index))),
cacheKey: computed(() => options.cacheKey),
@@ -50,6 +54,9 @@ function createResizeState(options: {
setDensity(value: "compact" | "standard" | "comfortable") {
density.value = value;
},
setWidthMode(value: DataGridColumnWidthMode) {
widthMode.value = value;
},
setHeaderTextWidth(width: number) {
headerTextWidth.value = width;
headerMeasurementKey.value += 1;
@@ -108,6 +115,39 @@ describe("useDataGridColumnResize", () => {
expect(state.renderedColumnWidths.value[1]).toBeGreaterThan(intrinsic[1]);
});
it("keeps measured content widths without distributing spare viewport space", () => {
const state = createResizeState({
columns: ["id", "name"],
rows: [[1, "a"]],
viewportWidth: 400,
widthMode: "content",
});
state.initColumnWidths();
expect(state.renderedColumnWidths.value).toEqual(state.columnWidths.value);
expect(state.totalWidth.value).toBeLessThan(400);
});
it("switches the open grid layout immediately without changing a manual width", () => {
const state = createResizeState({
columns: ["id", "name"],
rows: [[1, "a"]],
viewportWidth: 600,
});
state.initColumnWidths();
state.onResizeStart(0, new MouseEvent("mousedown", { clientX: 100, cancelable: true }));
document.dispatchEvent(new MouseEvent("mouseup", { clientX: 140 }));
const manualWidth = state.columnWidths.value[0];
state.setWidthMode("content");
expect(state.renderedColumnWidths.value).toEqual(state.columnWidths.value);
expect(state.renderedColumnWidths.value[0]).toBe(manualWidth);
state.setWidthMode("fill");
expect(state.renderedColumnWidths.value[0]).toBe(manualWidth);
expect(state.totalWidth.value).toBe(600);
});
it("tracks the cursor while dragging under spare width and stores the final width without stale rendering", async () => {
const state = createResizeState({
columns: ["id", "name"],
@@ -1,7 +1,7 @@
import { ref, shallowRef, computed, watch, type ComputedRef, type Ref } from "vue";
import { calculateDataGridColumnWidth, DATA_GRID_AUTO_FIT_VALUE_TEXT_LIMIT, DATA_GRID_COL_AUTO_FIT_MAX_WIDTH, DATA_GRID_COL_MIN_WIDTH, COLUMN_WIDTH_DENSITY_PRESETS, sampleDataGridColumnValues } from "@/lib/dataGrid/dataGridColumnWidth";
import { createDataGridColumnMeasurementSignature, loadDataGridColumnWidthState, removeDataGridColumnWidthState, saveDataGridColumnWidthState } from "@/lib/dataGrid/dataGridColumnWidthState";
import type { ColumnWidthDensity } from "@/stores/settingsStore";
import type { ColumnWidthDensity, DataGridColumnWidthMode } from "@/stores/settingsStore";
type CellValue = string | number | boolean | null;
@@ -35,6 +35,7 @@ export interface UseDataGridColumnResizeOptions {
sourceRows: ComputedRef<CellValue[][]>;
columnIndexes: ComputedRef<number[]>;
density: Ref<ColumnWidthDensity>;
widthMode: Ref<DataGridColumnWidthMode>;
compactColumnHeaderActions: ComputedRef<boolean>;
columnIndexIndicators?: ComputedRef<readonly boolean[]>;
cacheKey?: ComputedRef<string | undefined>;
@@ -250,6 +251,7 @@ export function useDataGridColumnResize(options: UseDataGridColumnResizeOptions)
const renderedColumnWidths = computed(() => {
const widths = columnWidths.value.slice();
if (options.widthMode.value === "content") return widths;
const viewportWidth = options.viewportWidth?.value ?? 0;
const surplus = viewportWidth - resolvedRowNumberWidth.value - widths.reduce((sum, width) => sum + width, 0);
if (surplus <= 0) return widths;
+3
View File
@@ -2437,6 +2437,9 @@ export default withEnglishFallback({
columnWidthCompact: "Yığcam",
columnWidthStandard: "Standart",
columnWidthComfortable: "Rahat",
columnWidthMode: "Sütun eni düzəni",
columnWidthModeFill: "Mövcud eni doldur",
columnWidthModeContent: "Məzmun eni",
searchColumn: "Sütun/şərh axtar...",
noColumnsFound: "Sütun tapılmadı",
queryError: "Sorğu xətası",
+3
View File
@@ -2781,6 +2781,9 @@ export default {
columnWidthCompact: "Compact",
columnWidthStandard: "Standard",
columnWidthComfortable: "Comfortable",
columnWidthMode: "Width layout",
columnWidthModeFill: "Fill available width",
columnWidthModeContent: "Content width",
searchColumn: "Search column/comment...",
noColumnsFound: "No columns found",
queryError: "Query Error",
+3
View File
@@ -2574,6 +2574,9 @@ export default withEnglishFallback({
columnWidthCompact: "Compacto",
columnWidthStandard: "Estándar",
columnWidthComfortable: "Amplio",
columnWidthMode: "Distribución del ancho",
columnWidthModeFill: "Llenar ancho disponible",
columnWidthModeContent: "Ancho del contenido",
searchColumn: "Buscar columna/comentario...",
noColumnsFound: "No se encontraron columnas",
tableInfo: "Información de tabla",
+3
View File
@@ -2541,6 +2541,9 @@ export default withEnglishFallback({
columnWidthCompact: "Compatto",
columnWidthStandard: "Standard",
columnWidthComfortable: "Ampio",
columnWidthMode: "Layout larghezza",
columnWidthModeFill: "Riempi larghezza disponibile",
columnWidthModeContent: "Larghezza contenuto",
searchColumn: "Cerca colonna/commento...",
noColumnsFound: "Nessuna colonna trovata",
queryError: "Errore Query",
+3
View File
@@ -2547,6 +2547,9 @@ export default withEnglishFallback({
columnWidthCompact: "コンパクト",
columnWidthStandard: "標準",
columnWidthComfortable: "ゆったり",
columnWidthMode: "列幅レイアウト",
columnWidthModeFill: "使用可能幅を埋める",
columnWidthModeContent: "コンテンツ幅",
searchColumn: "列/コメントを検索...",
noColumnsFound: "列が見つかりません",
queryError: "クエリエラー",
+3
View File
@@ -2539,6 +2539,9 @@ export default withEnglishFallback({
columnWidthCompact: "좁게",
columnWidthStandard: "표준",
columnWidthComfortable: "넓게",
columnWidthMode: "열 너비 레이아웃",
columnWidthModeFill: "사용 가능 너비 채우기",
columnWidthModeContent: "콘텐츠 너비",
searchColumn: "컬럼/주석 검색...",
noColumnsFound: "컬럼이 없습니다",
queryError: "쿼리 오류",
+3
View File
@@ -2542,6 +2542,9 @@ export default withEnglishFallback({
columnWidthCompact: "Compacto",
columnWidthStandard: "Padrão",
columnWidthComfortable: "Amplo",
columnWidthMode: "Layout de largura",
columnWidthModeFill: "Preencher largura disponível",
columnWidthModeContent: "Largura do conteúdo",
searchColumn: "Buscar coluna/comentário...",
noColumnsFound: "Nenhuma coluna encontrada",
queryError: "Erro na Consulta",
+3
View File
@@ -2659,6 +2659,9 @@ export default withEnglishFallback({
columnWidthCompact: "Компактная",
columnWidthStandard: "Стандартная",
columnWidthComfortable: "Комфортная",
columnWidthMode: "Распределение ширины",
columnWidthModeFill: "Заполнить доступную ширину",
columnWidthModeContent: "По содержимому",
searchColumn: "Поиск столбца или комментария...",
noColumnsFound: "Столбцы не найдены",
queryError: "Ошибка запроса",
+3
View File
@@ -2432,6 +2432,9 @@ export default withEnglishFallback({
columnWidthCompact: "Sıkışık",
columnWidthStandard: "Standart",
columnWidthComfortable: "Ferah",
columnWidthMode: "Sütun genişliği düzeni",
columnWidthModeFill: "Kullanılabilir genişliği doldur",
columnWidthModeContent: "İçerik genişliği",
searchColumn: "Sütun/açıklama ara...",
noColumnsFound: "Sütun bulunamadı",
queryError: "Sorgu Hatası",
+3
View File
@@ -2694,6 +2694,9 @@ export default withEnglishFallback({
columnWidthCompact: "紧凑",
columnWidthStandard: "标准",
columnWidthComfortable: "宽松",
columnWidthMode: "列宽布局",
columnWidthModeFill: "填满可用宽度",
columnWidthModeContent: "按内容宽度",
searchColumn: "搜索列/注释...",
noColumnsFound: "未找到列",
queryError: "查询出错",
+3
View File
@@ -2545,6 +2545,9 @@ export default withEnglishFallback({
columnWidthCompact: "緊湊",
columnWidthStandard: "標準",
columnWidthComfortable: "寬鬆",
columnWidthMode: "欄寬配置",
columnWidthModeFill: "填滿可用寬度",
columnWidthModeContent: "依內容寬度",
searchColumn: "搜尋欄/註解...",
noColumnsFound: "未找到欄",
dataUnavailable: "資料表資料需要重新載入。",
@@ -482,6 +482,14 @@ describe("normalizeEditorSettings", () => {
expect(invalid.dataGridBooleanDisplayMode).toBe("dropdown");
});
it("normalizes the persistent data grid column width mode", () => {
expect(DEFAULT_EDITOR_SETTINGS.dataGridColumnWidthMode).toBe("fill");
expect(normalizeEditorSettings({}).dataGridColumnWidthMode).toBe("fill");
expect(normalizeEditorSettings({ dataGridColumnWidthMode: "fill" }).dataGridColumnWidthMode).toBe("fill");
expect(normalizeEditorSettings({ dataGridColumnWidthMode: "content" }).dataGridColumnWidthMode).toBe("content");
expect(normalizeEditorSettings({ dataGridColumnWidthMode: "invalid" as any }).dataGridColumnWidthMode).toBe("fill");
});
it("defaults the cell detail hover button on and preserves only boolean values", () => {
expect(normalizeEditorSettings({}).dataGridCellDetailButtonVisible).toBe(true);
expect(normalizeEditorSettings({ dataGridCellDetailButtonVisible: true }).dataGridCellDetailButtonVisible).toBe(true);
+10
View File
@@ -676,6 +676,8 @@ const STRUCTURE_EDITOR_DENSITIES = ["compact", "standard", "comfortable"] as con
export type StructureEditorDensity = (typeof STRUCTURE_EDITOR_DENSITIES)[number];
const COLUMN_WIDTH_DENSITIES = ["compact", "standard", "comfortable"] as const;
export type ColumnWidthDensity = (typeof COLUMN_WIDTH_DENSITIES)[number];
const DATA_GRID_COLUMN_WIDTH_MODES = ["fill", "content"] as const;
export type DataGridColumnWidthMode = (typeof DATA_GRID_COLUMN_WIDTH_MODES)[number];
const CELL_DETAIL_PANEL_LAYOUTS = ["bottom", "right"] as const;
export type CellDetailPanelLayout = (typeof CELL_DETAIL_PANEL_LAYOUTS)[number];
const TAB_LAYOUT_MODES = ["scroll", "wrap"] as const;
@@ -881,6 +883,7 @@ export interface EditorSettings {
showIndexIndicatorsInHeader: boolean;
compactColumnHeaderActions: boolean;
columnWidthDensity: ColumnWidthDensity;
dataGridColumnWidthMode: DataGridColumnWidthMode;
dataGridQuickEntry: boolean;
dataGridFilterEditorView: DataGridFilterEditorView;
dataGridToolbarLayout: DataGridToolbarLayout;
@@ -1162,6 +1165,7 @@ export const DEFAULT_EDITOR_SETTINGS: EditorSettings = {
showIndexIndicatorsInHeader: true,
compactColumnHeaderActions: true,
columnWidthDensity: "standard",
dataGridColumnWidthMode: "fill",
dataGridQuickEntry: false,
dataGridFilterEditorView: "quick",
dataGridToolbarLayout: "single",
@@ -1303,6 +1307,10 @@ function normalizeColumnWidthDensity(value: unknown): ColumnWidthDensity {
return COLUMN_WIDTH_DENSITIES.includes(value as ColumnWidthDensity) ? (value as ColumnWidthDensity) : DEFAULT_EDITOR_SETTINGS.columnWidthDensity;
}
function normalizeDataGridColumnWidthMode(value: unknown): DataGridColumnWidthMode {
return DATA_GRID_COLUMN_WIDTH_MODES.includes(value as DataGridColumnWidthMode) ? (value as DataGridColumnWidthMode) : DEFAULT_EDITOR_SETTINGS.dataGridColumnWidthMode;
}
function normalizeTabLayout(value: unknown): TabLayoutMode {
return TAB_LAYOUT_MODES.includes(value as TabLayoutMode) ? (value as TabLayoutMode) : DEFAULT_EDITOR_SETTINGS.tabLayout;
}
@@ -1719,6 +1727,7 @@ export function normalizeEditorSettings(settings: Partial<EditorSettings>, exist
showIndexIndicatorsInHeader: settings.showIndexIndicatorsInHeader ?? DEFAULT_EDITOR_SETTINGS.showIndexIndicatorsInHeader,
compactColumnHeaderActions: settings.compactColumnHeaderActions ?? DEFAULT_EDITOR_SETTINGS.compactColumnHeaderActions,
columnWidthDensity: normalizeColumnWidthDensity(settings.columnWidthDensity),
dataGridColumnWidthMode: normalizeDataGridColumnWidthMode(settings.dataGridColumnWidthMode),
dataGridQuickEntry: settings.dataGridQuickEntry ?? DEFAULT_EDITOR_SETTINGS.dataGridQuickEntry,
dataGridFilterEditorView: normalizeDataGridFilterEditorView(settings.dataGridFilterEditorView),
dataGridToolbarLayout: normalizeDataGridToolbarLayout(settings.dataGridToolbarLayout),
@@ -2557,6 +2566,7 @@ export const useSettingsStore = defineStore("settings", () => {
if (partial.showIndexIndicatorsInHeader !== undefined) editorSettings.value.showIndexIndicatorsInHeader = partial.showIndexIndicatorsInHeader;
if (partial.compactColumnHeaderActions !== undefined) editorSettings.value.compactColumnHeaderActions = partial.compactColumnHeaderActions;
if (partial.columnWidthDensity !== undefined) editorSettings.value.columnWidthDensity = normalizeColumnWidthDensity(partial.columnWidthDensity);
if (partial.dataGridColumnWidthMode !== undefined) editorSettings.value.dataGridColumnWidthMode = normalizeDataGridColumnWidthMode(partial.dataGridColumnWidthMode);
if (partial.dataGridQuickEntry !== undefined) editorSettings.value.dataGridQuickEntry = partial.dataGridQuickEntry;
if (partial.dataGridFilterEditorView !== undefined) editorSettings.value.dataGridFilterEditorView = normalizeDataGridFilterEditorView(partial.dataGridFilterEditorView);
if (partial.dataGridToolbarLayout !== undefined) editorSettings.value.dataGridToolbarLayout = normalizeDataGridToolbarLayout(partial.dataGridToolbarLayout);