Skip to content

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

Add keyboard shortcut to close/open side menu in Data Studio (#67413)

Maz Amelia1a62cd60318
diff --git a/.loki/reference/chrome_laptop_App_Databases_DatabaseForm_Default.png b/.loki/reference/chrome_laptop_App_Databases_DatabaseForm_Default.png
deleted file mode 100644
index 4180037e248..00000000000
Binary files a/.loki/reference/chrome_laptop_App_Databases_DatabaseForm_Default.png and /dev/null differ
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/DataStudioLayout/DataStudioLayout.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/DataStudioLayout/DataStudioLayout.tsx
index 9f3f0cc1d92..d9f53eb8cf7 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/DataStudioLayout/DataStudioLayout.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/DataStudioLayout/DataStudioLayout.tsx
@@ -5,8 +5,10 @@ import { t } from "ttag";
import DataStudioLogo from "assets/img/data-studio-logo.svg";
import { ForwardRefLink } from "metabase/common/components/Link";
import { useUserKeyValue } from "metabase/common/hooks/use-user-key-value";
+import { isMac } from "metabase/lib/browser";
import { useSelector } from "metabase/lib/redux";
import * as Urls from "metabase/lib/urls";
+import { useRegisterShortcut } from "metabase/palette/hooks/useRegisterShortcut";
import {
PLUGIN_DEPENDENCIES,
PLUGIN_FEATURE_LEVEL_PERMISSIONS,
@@ -46,6 +48,16 @@ export function DataStudioLayout({ children }: DataStudioLayoutProps) {
});
const isNavbarOpened = _isNavbarOpened !== false;
+ useRegisterShortcut(
+ [
+ {
+ id: "toggle-navbar",
+ perform: () => setIsNavbarOpened(!isNavbarOpened),
+ },
+ ],
+ [isNavbarOpened],
+ );
+
return isLoading ? (
<Center h="100%">
<Loader />
@@ -231,6 +243,12 @@ function DataStudioTab({
);
}
+const getSidebarTooltipLabel = (isNavbarOpened: boolean) => {
+ const message = isNavbarOpened ? t`Close sidebar` : t`Open sidebar`;
+ const shortcut = isMac() ? "(⌘ + .)" : "(Ctrl + .)";
+ return `${message} ${shortcut}`;
+};
+
type DataStudioNavbarToggleProps = {
isNavbarOpened: boolean;
onNavbarToggle: (isOpened: boolean) => void;
@@ -243,37 +261,51 @@ function DataStudioNavbarToggle({
return (
<Flex justify="space-between" mb={2}>
<Group gap="sm">
- <UnstyledButton
- className={cx(S.toggle, {
- [S.hoverButton]: !isNavbarOpened,
- [S.disablePointer]: isNavbarOpened,
- })}
- p="0.5rem"
- bdrs="md"
- onClick={() => !isNavbarOpened && onNavbarToggle(true)}
+ <Tooltip
+ label={getSidebarTooltipLabel(isNavbarOpened)}
+ withArrow
+ offset={-12}
+ openDelay={1000}
>
- <img
- alt="Data Studio Logo"
- className={cx(S.hideOnHover, S.logo)}
- src={DataStudioLogo}
- />
- <FixedSizeIcon
- name="sidebar_open"
- className={S.showOnHover}
- c="text-secondary"
- />
- </UnstyledButton>
+ <UnstyledButton
+ className={cx(S.toggle, {
+ [S.hoverButton]: !isNavbarOpened,
+ [S.disablePointer]: isNavbarOpened,
+ })}
+ p="0.5rem"
+ bdrs="md"
+ onClick={() => !isNavbarOpened && onNavbarToggle(true)}
+ >
+ <img
+ alt="Data Studio Logo"
+ className={cx(S.hideOnHover, S.logo)}
+ src={DataStudioLogo}
+ />
+ <FixedSizeIcon
+ name="sidebar_open"
+ className={S.showOnHover}
+ c="text-secondary"
+ />
+ </UnstyledButton>
+ </Tooltip>
{isNavbarOpened && <PLUGIN_REMOTE_SYNC.GitSyncAppBarControls />}
</Group>
{isNavbarOpened && (
- <UnstyledButton
- className={S.toggle}
- p="0.5rem"
- bdrs="md"
- onClick={() => onNavbarToggle(false)}
+ <Tooltip
+ label={getSidebarTooltipLabel(isNavbarOpened)}
+ withArrow
+ offset={-12}
+ openDelay={1000}
>
- <FixedSizeIcon name="sidebar_closed" c="text-secondary" />
- </UnstyledButton>
+ <UnstyledButton
+ className={S.toggle}
+ p="0.5rem"
+ bdrs="md"
+ onClick={() => onNavbarToggle(false)}
+ >
+ <FixedSizeIcon name="sidebar_closed" c="text-secondary" />
+ </UnstyledButton>
+ </Tooltip>
)}
</Flex>
);