Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

QueryEditor: run via Cmd+Enter hotkey (#85035)

Radek Pietruszewski72b90dc1336e
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonTransformEditor.tsx b/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonTransformEditor.tsx
index 3bcf8e76554..77b015709c1 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonTransformEditor.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonTransformEditor.tsx
@@ -1,8 +1,8 @@
-import { useHotkeys } from "@mantine/hooks";
import { useEffect } from "react";
import { usePrevious } from "react-use";
import type { PythonTransformEditorProps } from "metabase/plugins";
+import { useToggleRunHotkey } from "metabase/querying/editor/hooks/use-toggle-run-hotkey";
import { Flex, Stack } from "metabase/ui";
import type {
DatabaseId,
@@ -99,18 +99,13 @@ export function PythonTransformEditor({
uiOptions?.hidePreview,
]);
- const handleCmdEnter = () => {
- if (!isEditMode) {
- return;
- }
- if (isRunning) {
- cancel();
- } else if (isRunnable) {
- handleRun();
- }
- };
-
- useHotkeys([["mod+Enter", handleCmdEnter]], []);
+ useToggleRunHotkey({
+ isEnabled: Boolean(isEditMode),
+ isRunning,
+ isRunnable,
+ run: handleRun,
+ cancel: cancel,
+ });
return (
<Flex h="100%" w="100%" direction="column">
diff --git a/frontend/src/metabase/metrics/components/MetricQueryEditor/utils.ts b/frontend/src/metabase/metrics/components/MetricQueryEditor/utils.ts
index 847fa3cc1e2..82cb6ef2aed 100644
--- a/frontend/src/metabase/metrics/components/MetricQueryEditor/utils.ts
+++ b/frontend/src/metabase/metrics/components/MetricQueryEditor/utils.ts
@@ -13,5 +13,6 @@ export function getEditorOptions(
cardVizSettings: settings,
readOnly,
canConvertToNative: false,
+ canRunViaHotkey: true,
};
}
diff --git a/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx b/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx
index 19b24741c5c..1210fbc160b 100644
--- a/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx
+++ b/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx
@@ -9,6 +9,7 @@ import type * as Lib from "metabase-lib";
import type { DatasetQuery } from "metabase-types/api";
import { useQueryEditor } from "../../hooks/use-query-editor";
+import { useToggleRunHotkey } from "../../hooks/use-toggle-run-hotkey";
import type {
QueryEditorUiOptions,
QueryEditorUiState,
@@ -92,6 +93,14 @@ export function QueryEditor({
const { ref, height: availableHeight } = useElementSize();
+ useToggleRunHotkey({
+ isEnabled: Boolean(uiOptions?.canRunViaHotkey && !uiOptions?.readOnly),
+ isRunning,
+ isRunnable,
+ run: runQuery,
+ cancel: cancelQuery,
+ });
+
if (isLoading || error != null) {
return (
<Center h={height}>
diff --git a/frontend/src/metabase/querying/editor/hooks/use-toggle-run-hotkey.ts b/frontend/src/metabase/querying/editor/hooks/use-toggle-run-hotkey.ts
new file mode 100644
index 00000000000..597b3d93ed5
--- /dev/null
+++ b/frontend/src/metabase/querying/editor/hooks/use-toggle-run-hotkey.ts
@@ -0,0 +1,27 @@
+import { useHotkeys } from "@mantine/hooks";
+
+type UseToggleRunHotkeyOptions = {
+ isEnabled: boolean;
+ isRunning: boolean;
+ isRunnable: boolean;
+ run: () => void;
+ cancel: () => void;
+};
+
+export function useToggleRunHotkey({
+ isEnabled,
+ isRunning,
+ isRunnable,
+ run,
+ cancel,
+}: UseToggleRunHotkeyOptions) {
+ const onHotkey = () => {
+ if (isRunning) {
+ cancel();
+ } else if (isRunnable) {
+ run();
+ }
+ };
+
+ useHotkeys(isEnabled ? [["mod+Enter", onHotkey]] : [], []);
+}
diff --git a/frontend/src/metabase/querying/editor/types.ts b/frontend/src/metabase/querying/editor/types.ts
index 8eaa052da32..99d4ca30ae0 100644
--- a/frontend/src/metabase/querying/editor/types.ts
+++ b/frontend/src/metabase/querying/editor/types.ts
@@ -83,6 +83,8 @@ export type QueryEditorUiOptions = {
hideRunButton?: boolean;
hidePreviewQueryButton?: boolean;
resizable?: boolean;
+ /** If true, a mod+Enter hotkey to run query will be attached */
+ canRunViaHotkey?: boolean;
};
/**
diff --git a/frontend/src/metabase/transforms/components/TransformEditor/utils.ts b/frontend/src/metabase/transforms/components/TransformEditor/utils.ts
index cd268fbe2c3..d8f15a71a28 100644
--- a/frontend/src/metabase/transforms/components/TransformEditor/utils.ts
+++ b/frontend/src/metabase/transforms/components/TransformEditor/utils.ts
@@ -61,6 +61,7 @@ export function getEditorOptions(
},
shouldShowLibrary: false,
canUseSampleDatabase: false,
+ canRunViaHotkey: true,
readOnly,
};
}