Merge pull request #126 from github/cbodfield/localized-mod-ssr

Make localizeMod SSR safe

Author: dgreif

src/hotkey.ts

@@ -76,7 +76,7 @@ const modifierKeyNames: string[] = ['Control', 'Alt', 'Meta', 'Shift']
  *   platforms.
  * - Ensures modifiers are sorted in a consistent order
  * @param hotkey a hotkey string
- * @param platform NOTE: this param is only intended to be used to mock `navigator.platform` in tests
+ * @param platform NOTE: this param is only intended to be used to mock `navigator.platform` in tests. `window.navigator.platform` is used by default.
  * @returns {string} normalized representation of the given hotkey string
  */
 export function normalizeHotkey(hotkey: string, platform?: string | undefined): NormalizedHotkeyString {
@@ -88,8 +88,11 @@ export function normalizeHotkey(hotkey: string, platform?: string | undefined):
 
 const matchApplePlatform = /Mac|iPod|iPhone|iPad/i
 
-function localizeMod(hotkey: string, platform: string = navigator.platform): string {
-  const localModifier = matchApplePlatform.test(platform) ? 'Meta' : 'Control'
+function localizeMod(hotkey: string, platform?: string | undefined): string {
+  const ssrSafeWindow = typeof window === 'undefined' ? undefined : window
+  const safePlatform = platform ?? ssrSafeWindow?.navigator.platform ?? ''
+
+  const localModifier = matchApplePlatform.test(safePlatform) ? 'Meta' : 'Control'
   return hotkey.replace('Mod', localModifier)
 }
 

test/test-normalize-hotkey.js

@@ -25,6 +25,8 @@ describe('normalizeHotkey', () => {
     ['Mod+)', 'Meta+)', 'mac'], // TODO: on a mac upper-case keys are lowercased when Meta is pressed
     ['Mod+Alt+a', 'Control+Alt+a', 'win / linux'],
     ['Mod+Alt+a', 'Alt+Meta+a', 'mac'],
+    // undefined platform doesn't localize and falls back to windows (SSR)
+    ['Mod+a', 'Control+a', undefined],
     // Modifier sorting
     ['Shift+Alt+Meta+Control+m', 'Control+Alt+Meta+Shift+m'],
     ['Shift+Alt+Mod+m', 'Control+Alt+Shift+m', 'win']