feat(toolbar): show shortcut hints on hover tooltips
This commit is contained in:
1 parent
f47c209b15
commit
e08eda972b
8 files changed
+137
-21
No files matched your search
@@ -398,6 +398,7 @@ import { dataGridConditionColumnOptions, dataGridConditionIdentifierQuote, dataG
|
||||
import { isMacOS } from "@/lib/backend/platform";
|
||||
import { appendDebugLog, isDebugLoggingEnabled } from "@/lib/backend/debugLog";
|
||||
import { formatShortcut } from "@/lib/editor/shortcutRegistry";
|
||||
import { formatShortcutTooltip } from "@/lib/editor/shortcutDisplay";
|
||||
import { SearchableSelect } from "@/components/ui/searchable-select";
|
||||
import { useDataGridColumnFormatter } from "@/composables/useDataGridColumnFormatter";
|
||||
import { useDataGridTableMetadataLoaders } from "@/composables/useDataGridTableMetadataLoaders";
|
||||
@@ -2212,6 +2213,7 @@ function goToColumnTriggerElement(): HTMLElement | undefined {
|
||||
}
|
||||
|
||||
const goToColumnSelectedIndex = ref(0);
|
||||
const goToColumnTooltip = computed(() => formatShortcutTooltip(t("grid.goToColumn"), settingsStore.editorSettings.shortcuts.goToColumn));
|
||||
const columnOrderKeys = computed(() => uniqueDataGridColumnOrderKeys(props.result.columns, props.sourceColumns));
|
||||
const resolvedColumnLayoutScopeKey = computed(
|
||||
() =>
|
||||
@@ -12868,7 +12870,7 @@ useUpdateBlocker(() => (hasPendingChanges.value || hasPendingDataEditorDraft.val
|
||||
</Button>
|
||||
</PopoverTrigger>
|
||||
</TooltipTrigger>
|
||||
<TooltipContent side="bottom">{{ t("grid.goToColumn") }}</TooltipContent>
|
||||
<TooltipContent side="bottom">{{ goToColumnTooltip }}</TooltipContent>
|
||||
</Tooltip>
|
||||
<PopoverContent :reference="goToColumnTriggerElement()" align="end" class="w-56 p-2" @keydown="onGoToColumnKeydown">
|
||||
<div class="relative mb-1">
|
||||
|
||||
+1
@@ -205,6 +205,7 @@ describe("data grid icon-only toolbar tooltips", () => {
|
||||
await hover(button);
|
||||
|
||||
expect(showsTooltip("Go to column")).toBe(true);
|
||||
expect(visibleTooltipTexts().some((text) => text.includes("Go to column (") && text.includes("G)"))).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
@@ -14,6 +14,7 @@ import { MAC_TRAFFIC_LIGHT_X, macTrafficLightInsetPaddingForScale, shouldReserve
|
||||
import { useToast } from "@/composables/useToast";
|
||||
import { useSettingsStore } from "@/stores/settingsStore";
|
||||
import { isSystemAppThemeMode, type AppThemeMode } from "@/lib/app/appTheme";
|
||||
import { formatShortcutTooltip } from "@/lib/editor/shortcutDisplay";
|
||||
|
||||
const GithubIcon = {
|
||||
render() {
|
||||
@@ -96,6 +97,10 @@ const updateTooltip = computed(() => {
|
||||
if (props.hasUpdateAvailable && props.updateReadyToInstall) return t("updates.downloadedReady", { version: props.updateVersion ?? "" });
|
||||
return t("updates.check");
|
||||
});
|
||||
const sidebarExpandTooltip = computed(() => formatShortcutTooltip(t("sidebar.expand"), settingsStore.editorSettings.shortcuts.toggleSidebar));
|
||||
const newQueryTooltip = computed(() => formatShortcutTooltip(t("toolbar.newQuery"), settingsStore.editorSettings.shortcuts.newQuery));
|
||||
const aiTooltip = computed(() => formatShortcutTooltip("AI", settingsStore.editorSettings.shortcuts.toggleAiPanel));
|
||||
const settingsTooltip = computed(() => (props.hasMcpUpdateAvailable ? t("toolbar.mcpUpdateAvailable") : formatShortcutTooltip(t("settings.title"), settingsStore.editorSettings.shortcuts.openSettings)));
|
||||
|
||||
const sqlLibrarySaveFeedbackActive = ref(false);
|
||||
const SQL_LIBRARY_BOOKMARK_PATH = "M10 2 L10 10 L13 7 L16 10 L16 2";
|
||||
@@ -554,7 +559,7 @@ const toolbarStyle = computed(() => {
|
||||
<ChevronsRight class="h-4 w-4" />
|
||||
</Button>
|
||||
</TooltipTrigger>
|
||||
<TooltipContent>{{ t("sidebar.expand") }}</TooltipContent>
|
||||
<TooltipContent>{{ sidebarExpandTooltip }}</TooltipContent>
|
||||
</Tooltip>
|
||||
<Button variant="ghost" size="sm" :class="toolbarTextButtonClass" @click="emit('new-connection')">
|
||||
<span class="inline-flex items-center gap-1">
|
||||
@@ -563,10 +568,15 @@ const toolbarStyle = computed(() => {
|
||||
</span>
|
||||
</Button>
|
||||
|
||||
<Button v-if="canNewQuery" variant="ghost" size="sm" :class="toolbarTextButtonClass" @click="emit('new-query')">
|
||||
<FilePlus2 class="h-3.5 w-3.5" />
|
||||
<span :class="toolbarTextLabelClass">{{ t("toolbar.newQuery") }}</span>
|
||||
</Button>
|
||||
<Tooltip v-if="canNewQuery">
|
||||
<TooltipTrigger as-child>
|
||||
<Button variant="ghost" size="sm" :class="toolbarTextButtonClass" @click="emit('new-query')">
|
||||
<FilePlus2 class="h-3.5 w-3.5" />
|
||||
<span :class="toolbarTextLabelClass">{{ t("toolbar.newQuery") }}</span>
|
||||
</Button>
|
||||
</TooltipTrigger>
|
||||
<TooltipContent>{{ newQueryTooltip }}</TooltipContent>
|
||||
</Tooltip>
|
||||
|
||||
<template v-if="!toolbarCollapsed">
|
||||
<Button v-if="toolbarItems.dataTransfer" variant="ghost" size="sm" :class="toolbarTextButtonClass" @click="emit('open-transfer')" :disabled="!hasConnections">
|
||||
@@ -746,7 +756,7 @@ const toolbarStyle = computed(() => {
|
||||
<span v-if="showAiPanel" class="toolbar-panel-status" aria-hidden="true" />
|
||||
</Button>
|
||||
</TooltipTrigger>
|
||||
<TooltipContent>AI</TooltipContent>
|
||||
<TooltipContent>{{ aiTooltip }}</TooltipContent>
|
||||
</Tooltip>
|
||||
|
||||
<Tooltip v-if="toolbarItems.theme">
|
||||
@@ -781,7 +791,7 @@ const toolbarStyle = computed(() => {
|
||||
<span v-if="hasMcpUpdateAvailable" class="absolute right-1.5 top-1.5 h-2 w-2 rounded-full bg-red-500 ring-2 ring-background" :aria-label="t('toolbar.mcpUpdateAvailable')" :title="t('toolbar.mcpUpdateAvailable')" />
|
||||
</Button>
|
||||
</TooltipTrigger>
|
||||
<TooltipContent>{{ hasMcpUpdateAvailable ? t("toolbar.mcpUpdateAvailable") : t("settings.title") }}</TooltipContent>
|
||||
<TooltipContent>{{ settingsTooltip }}</TooltipContent>
|
||||
</Tooltip>
|
||||
|
||||
<Tooltip v-if="showLogout">
|
||||
|
||||
@@ -53,7 +53,7 @@ import { supportsQueryExecution } from "@/lib/database/databaseFeatureSupport";
|
||||
import { connectionIsDorisFamilyCatalogCapable } from "@/lib/database/databaseFeatureSupport";
|
||||
import { hexToRgba } from "@/lib/common/color";
|
||||
import { productionContextForDatabase } from "@/lib/database/productionSafety";
|
||||
import { formatShortcutDisplay } from "@/lib/editor/shortcutDisplay";
|
||||
import { formatShortcutDisplay, formatShortcutTooltip } from "@/lib/editor/shortcutDisplay";
|
||||
import { resolveNextEditorToolbarTier, type EditorToolbarTier } from "@/lib/tabs/editorToolbarLayout";
|
||||
import { canSaveSqlTab } from "@/lib/tabs/sqlTabSaveTarget";
|
||||
import { looksLikeDmlStatement } from "@/lib/sql/dmlChangePreview";
|
||||
@@ -308,10 +308,14 @@ const supportsTransaction = computed(() => supportsTransactionFeature(props.acti
|
||||
const hasDefaultDatabaseOption = computed(() => activeDatabaseOptions.value.includes(""));
|
||||
const schemaDatabaseKey = computed(() => props.activeTab.database || (isSingleDb.value ? "_" : ""));
|
||||
const saveTooltip = computed(() => {
|
||||
if (props.activeTab.objectSource) return t("objects.saveSource");
|
||||
if (props.activeTab.externalSqlPath) return t("toolbar.saveSqlFile");
|
||||
return t("toolbar.saveSql");
|
||||
let label = t("toolbar.saveSql");
|
||||
if (props.activeTab.objectSource) label = t("objects.saveSource");
|
||||
else if (props.activeTab.externalSqlPath) label = t("toolbar.saveSqlFile");
|
||||
return formatShortcutTooltip(label, settingsStore.editorSettings.shortcuts.saveSql);
|
||||
});
|
||||
const explainPlanTooltip = computed(() => formatShortcutTooltip(t("toolbar.explainPlan"), settingsStore.editorSettings.shortcuts.explainSql));
|
||||
const formatSqlTooltip = computed(() => formatShortcutTooltip(t("toolbar.formatSql"), settingsStore.editorSettings.shortcuts.formatSql));
|
||||
const exPasteSqlInConditionTooltip = computed(() => formatShortcutTooltip(t("toolbar.exPasteSqlInCondition"), settingsStore.editorSettings.shortcuts.exPasteSqlInCondition));
|
||||
const isObjectSourceTab = computed(() => !!props.activeTab.objectSource || !!props.activeTab.sourceLoad);
|
||||
const objectSourceRefreshing = computed(() => !!props.activeTab.sourceLoad && !props.activeTab.sourceLoad.error);
|
||||
|
||||
@@ -322,11 +326,7 @@ function refreshObjectSource() {
|
||||
}
|
||||
const executeShortcutDisplay = computed(() => formatShortcutDisplay(settingsStore.editorSettings.shortcuts.executeSql));
|
||||
const executeShortcutTooltip = computed(() => t("toolbar.executeShortcut", { shortcut: executeShortcutDisplay.value }));
|
||||
const executeInNewResultTabShortcutDisplay = computed(() => formatShortcutDisplay(settingsStore.editorSettings.shortcuts.executeSqlInNewResultTab));
|
||||
const executeInNewResultTabTooltip = computed(() => {
|
||||
const label = t("settings.shortcutExecuteSqlInNewResultTab");
|
||||
return executeInNewResultTabShortcutDisplay.value ? `${label} (${executeInNewResultTabShortcutDisplay.value})` : label;
|
||||
});
|
||||
const executeInNewResultTabTooltip = computed(() => formatShortcutTooltip(t("settings.shortcutExecuteSqlInNewResultTab"), settingsStore.editorSettings.shortcuts.executeSqlInNewResultTab));
|
||||
// executableSql 在无选区时可能是整篇文档;只要有 DML 语句出现就显示预览按钮,
|
||||
// 具体"当前语句"由编辑器(QueryEditor)按执行模式解析。
|
||||
const DML_KEYWORD_RE = /(^|\s)(update|insert|delete)\s/i;
|
||||
@@ -593,7 +593,7 @@ async function changeCatalog(selectedCatalog: string) {
|
||||
<GitBranch v-else class="h-3.5 w-3.5" />
|
||||
</Button>
|
||||
</TooltipTrigger>
|
||||
<TooltipContent>{{ activeTab.isExplaining ? t("toolbar.stopExplain") : t("toolbar.explainPlan") }}</TooltipContent>
|
||||
<TooltipContent>{{ activeTab.isExplaining ? t("toolbar.stopExplain") : explainPlanTooltip }}</TooltipContent>
|
||||
</Tooltip>
|
||||
<!-- Autotrace (DM) / EXPLAIN ANALYZE (Postgres) / actual plan (SQL Server) toggle -->
|
||||
<Tooltip v-if="showExplainAnalyzeToggle">
|
||||
@@ -619,7 +619,7 @@ async function changeCatalog(selectedCatalog: string) {
|
||||
<AlignLeft class="h-3.5 w-3.5" />
|
||||
</Button>
|
||||
</TooltipTrigger>
|
||||
<TooltipContent>{{ t("toolbar.formatSql") }}</TooltipContent>
|
||||
<TooltipContent>{{ formatSqlTooltip }}</TooltipContent>
|
||||
</Tooltip>
|
||||
<Tooltip v-if="showCompressButton">
|
||||
<TooltipTrigger as-child>
|
||||
@@ -770,7 +770,7 @@ async function changeCatalog(selectedCatalog: string) {
|
||||
<ClipboardPaste class="h-3.5 w-3.5" />
|
||||
</Button>
|
||||
</TooltipTrigger>
|
||||
<TooltipContent>{{ t("toolbar.exPasteSqlInCondition") }}</TooltipContent>
|
||||
<TooltipContent>{{ exPasteSqlInConditionTooltip }}</TooltipContent>
|
||||
</Tooltip>
|
||||
<Tooltip v-if="showMultiExecuteButton">
|
||||
<TooltipTrigger as-child>
|
||||
|
||||
@@ -246,4 +246,33 @@ describe("always-on-top button visibility", () => {
|
||||
|
||||
unmount();
|
||||
});
|
||||
|
||||
it("renders shortcut hints in toolbar button tooltips", async () => {
|
||||
const settingsStore = useSettingsStore();
|
||||
settingsStore.updateEditorSettings({
|
||||
shortcuts: {
|
||||
...settingsStore.editorSettings.shortcuts,
|
||||
newQuery: "Mod+N",
|
||||
toggleSidebar: "Mod+B",
|
||||
openSettings: "Mod+,",
|
||||
toggleAiPanel: "Mod+I",
|
||||
},
|
||||
});
|
||||
|
||||
const { host, unmount } = mount(AppToolbar, {
|
||||
...toolbarProps,
|
||||
showSidebarExpand: true,
|
||||
canNewQuery: true,
|
||||
});
|
||||
await settled();
|
||||
await nextTick();
|
||||
|
||||
const tooltips = [...host.querySelectorAll(".app-toolbar span")].map((el) => el.textContent?.trim() ?? "");
|
||||
expect(tooltips.some((text) => text.includes("toolbar.newQuery (") && text.includes("N)"))).toBe(true);
|
||||
expect(tooltips.some((text) => text.includes("sidebar.expand (") && text.includes("B)"))).toBe(true);
|
||||
expect(tooltips.some((text) => text.includes("settings.title (") && text.includes(","))).toBe(true);
|
||||
expect(tooltips.some((text) => text.includes("AI (") && text.includes("I)"))).toBe(true);
|
||||
|
||||
unmount();
|
||||
});
|
||||
});
|
||||
@@ -635,4 +635,63 @@ describe("EditorToolbar mount contract", () => {
|
||||
app.unmount();
|
||||
host.remove();
|
||||
});
|
||||
|
||||
it("renders shortcut hints on button hover tooltips", async () => {
|
||||
const connectionStore = useConnectionStore();
|
||||
connectionStore.connections = [
|
||||
{
|
||||
id: "conn-shortcut",
|
||||
name: "test",
|
||||
db_type: "mysql",
|
||||
color: "",
|
||||
} as never,
|
||||
];
|
||||
const settingsStore = useSettingsStore();
|
||||
settingsStore.updateEditorSettings({
|
||||
shortcuts: {
|
||||
...settingsStore.editorSettings.shortcuts,
|
||||
explainSql: "Mod+E",
|
||||
formatSql: "Shift+Mod+F",
|
||||
saveSql: "Mod+S",
|
||||
},
|
||||
});
|
||||
|
||||
const host = createHost();
|
||||
const app = createApp(EditorToolbar, {
|
||||
activeTab: {
|
||||
id: "tab-shortcut",
|
||||
title: "SQL",
|
||||
connectionId: "conn-shortcut",
|
||||
sql: "SELECT 1",
|
||||
mode: "query",
|
||||
isExecuting: false,
|
||||
isCancelling: false,
|
||||
isExplaining: false,
|
||||
},
|
||||
activeConnection: connectionStore.getConfig("conn-shortcut"),
|
||||
executableSql: "SELECT 1",
|
||||
explainMode: "explain",
|
||||
blockDangerousRedisCommands: false,
|
||||
sqlKeywordCase: "preserve",
|
||||
databaseRequiredSignal: 0,
|
||||
autoCommit: true,
|
||||
txnSessionId: undefined,
|
||||
txnAutoRolledBack: false,
|
||||
txnPossiblyDirty: false,
|
||||
stickyProvenReadOnlyState: false,
|
||||
});
|
||||
app.use(pinia);
|
||||
app.use(i18n);
|
||||
app.mount(host);
|
||||
await nextTick();
|
||||
await nextTick();
|
||||
|
||||
const tooltips = [...host.querySelectorAll(".app-editor-toolbar span")].map((el) => el.textContent?.trim() ?? "");
|
||||
expect(tooltips.some((text) => text.includes("toolbar.explainPlan (") && text.includes("E)"))).toBe(true);
|
||||
expect(tooltips.some((text) => text.includes("toolbar.formatSql (") && text.includes("F)"))).toBe(true);
|
||||
expect(tooltips.some((text) => text.includes("toolbar.saveSql (") && text.includes("S)"))).toBe(true);
|
||||
|
||||
app.unmount();
|
||||
host.remove();
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user