feat(commands): add command to view shortcut overview (#19021)

PostHog · Dec 4, 2023 · 5ba512a · 5ba512a
1 parent 79eebd4
commit 5ba512a
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/frontend/src/lib/components/CommandPalette/commandPaletteLogic.tsx b/frontend/src/lib/components/CommandPalette/commandPaletteLogic.tsx
@@ -63,6 +63,8 @@ import { dashboardsModel } from '~/models/dashboardsModel'
 import { DashboardType, InsightType } from '~/types'
 
 import { personalAPIKeysLogic } from '../../../scenes/settings/user/personalAPIKeysLogic'
+import { commandBarLogic } from '../CommandBar/commandBarLogic'
+import { BarStatus } from '../CommandBar/types'
 import { hedgehogbuddyLogic } from '../HedgehogBuddy/hedgehogbuddyLogic'
 import type { commandPaletteLogicType } from './commandPaletteLogicType'
 import { openCHQueriesDebugModal } from './DebugCHQueries'
@@ -144,6 +146,8 @@ export const commandPaletteLogic = kea<commandPaletteLogicType>([
             ['updateUser'],
             hedgehogbuddyLogic,
             ['setHedgehogModeEnabled'],
+            commandBarLogic,
+            ['setCommandBar'],
         ],
         values: [
             teamLogic,
@@ -935,6 +939,30 @@ export const commandPaletteLogic = kea<commandPaletteLogicType>([
                 },
             }
 
+            const shortcuts: Command = {
+                key: 'shortcuts',
+                scope: GLOBAL_COMMAND_SCOPE,
+                resolver: {
+                    icon: IconKeyboard,
+                    display: 'Open keyboard shortcut overview',
+                    executor: () => {
+                        actions.setCommandBar(BarStatus.SHOW_SHORTCUTS)
+
+                        // :HACKY: we need to return a dummy flow here, as otherwise
+                        // the executor will hide the command bar, which also displays
+                        // the shortcut overview
+                        const dummyFlow: CommandFlow = {
+                            resolver: () => ({
+                                icon: <></>,
+                                display: '',
+                                executor: true,
+                            }),
+                        }
+                        return dummyFlow
+                    },
+                },
+            }
+
             actions.registerCommand(goTo)
             actions.registerCommand(openUrls)
             actions.registerCommand(debugClickhouseQueries)
@@ -946,6 +974,7 @@ export const commandPaletteLogic = kea<commandPaletteLogicType>([
             if (values.featureFlags[FEATURE_FLAGS.POSTHOG_3000]) {
                 actions.registerCommand(toggleTheme)
                 actions.registerCommand(toggleHedgehogMode)
+                actions.registerCommand(shortcuts)
             }
         },
         beforeUnmount: () => {
@@ -959,6 +988,7 @@ export const commandPaletteLogic = kea<commandPaletteLogicType>([
             actions.deregisterCommand('debug-copy-session-recording-url')
             actions.deregisterCommand('toggle-theme')
             actions.deregisterCommand('toggle-hedgehog-mode')
+            actions.deregisterCommand('shortcuts')
         },
     })),
 ])