Unverified Commit 798f4ce8 authored by Jiwon Choi's avatar Jiwon Choi Committed by GitHub

[dev-overlay] remove hide dev tools shortcut (#76066)

### Why?

Since it may conflict with other utils or the app's shortcuts, we
disable it until we find a good way to solve the issue.

| Light | Dark |
|--------|--------|
| ![CleanShot 2025-02-15 at 06 31
07](https://github.com/user-attachments/assets/8660d87b-8d21-47c5-b313-7a11f5ef195c)
| ![CleanShot 2025-02-15 at 06 30
05](https://github.com/user-attachments/assets/7d6c2e44-de8b-4d21-b567-2a2bc2aefb2f)
|

Closes NDX-835
parent a79950dc
...@@ -3,11 +3,9 @@ import type { OverlayState } from '../../../../../shared' ...@@ -3,11 +3,9 @@ import type { OverlayState } from '../../../../../shared'
import { useState, useEffect, useRef, createContext, useContext } from 'react' import { useState, useEffect, useRef, createContext, useContext } from 'react'
import { Toast } from '../../toast' import { Toast } from '../../toast'
import { NextLogo } from './internal/next-logo' import { Cross, NextLogo } from './internal/next-logo'
import { useIsDevBuilding } from '../../../../../../../dev/dev-build-indicator/internal/initialize-for-new-overlay' import { useIsDevBuilding } from '../../../../../../../dev/dev-build-indicator/internal/initialize-for-new-overlay'
import { useIsDevRendering } from './internal/dev-render-indicator' import { useIsDevRendering } from './internal/dev-render-indicator'
import { useKeyboardShortcut } from '../../../hooks/use-keyboard-shortcut'
import { MODIFIERS } from '../../../hooks/use-keyboard-shortcut'
import { useDelayedRender } from '../../../hooks/use-delayed-render' import { useDelayedRender } from '../../../hooks/use-delayed-render'
// TODO: add E2E tests to cover different scenarios // TODO: add E2E tests to cover different scenarios
...@@ -22,15 +20,6 @@ export function DevToolsIndicator({ ...@@ -22,15 +20,6 @@ export function DevToolsIndicator({
setIsErrorOverlayOpen: Dispatch<SetStateAction<boolean>> setIsErrorOverlayOpen: Dispatch<SetStateAction<boolean>>
}) { }) {
const [isDevToolsIndicatorOpen, setIsDevToolsIndicatorOpen] = useState(true) const [isDevToolsIndicatorOpen, setIsDevToolsIndicatorOpen] = useState(true)
// Register `(cmd|ctrl) + .` to show/hide the error indicator.
useKeyboardShortcut({
key: '.',
modifiers: [MODIFIERS.CTRL_CMD],
callback: () => {
setIsDevToolsIndicatorOpen(!isDevToolsIndicatorOpen)
setIsErrorOverlayOpen(!isDevToolsIndicatorOpen)
},
})
return ( return (
isDevToolsIndicatorOpen && ( isDevToolsIndicatorOpen && (
...@@ -264,7 +253,7 @@ function DevToolsPopover({ ...@@ -264,7 +253,7 @@ function DevToolsPopover({
<MenuItem <MenuItem
data-hide-dev-tools data-hide-dev-tools
label="Hide Dev Tools" label="Hide Dev Tools"
value={<HideShortcut />} value={<Cross color="var(--color-gray-900)" />}
onClick={hide} onClick={hide}
index={isTurbopack ? 1 : 2} index={isTurbopack ? 1 : 2}
/> />
...@@ -343,34 +332,6 @@ function IssueCount({ children }: { children: number }) { ...@@ -343,34 +332,6 @@ function IssueCount({ children }: { children: number }) {
) )
} }
function HideShortcut() {
const isMac =
// Feature detect for `navigator.userAgentData` which is experimental:
// https://developer.mozilla.org/en-US/docs/Web/API/NavigatorUAData/platform
'userAgentData' in navigator
? (navigator.userAgentData as any).platform === 'macOS'
: // This is the least-bad option to detect the modifier key when using `navigator.platform`:
// https://developer.mozilla.org/en-US/docs/Web/API/Navigator/platform#examples
navigator.platform.indexOf('Mac') === 0 ||
navigator.platform === 'iPhone'
return (
<span className="shortcut">
{isMac ? (
<kbd aria-label="Command">⌘</kbd>
) : (
<kbd
aria-label="Control"
style={{ width: 'fit-content', padding: '0 4px' }}
>
Ctrl
</kbd>
)}
<kbd>.</kbd>
</span>
)
}
////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////
function useFocusTrap( function useFocusTrap(
......
...@@ -454,7 +454,7 @@ export const NextLogo = forwardRef(function NextLogo( ...@@ -454,7 +454,7 @@ export const NextLogo = forwardRef(function NextLogo(
triggerRef.current?.focus() triggerRef.current?.focus()
}} }}
> >
<Cross /> <Cross data-cross />
</button> </button>
</div> </div>
)} )}
...@@ -569,15 +569,15 @@ function NextMark({ isLoading }: { isLoading?: boolean }) { ...@@ -569,15 +569,15 @@ function NextMark({ isLoading }: { isLoading?: boolean }) {
) )
} }
function Cross() { export function Cross(props: React.SVGProps<SVGSVGElement>) {
return ( return (
<svg <svg
data-cross
width="12" width="12"
height="12" height="12"
viewBox="0 0 14 14" viewBox="0 0 14 14"
fill="none" fill="none"
xmlns="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg"
{...props}
> >
<path <path
fillRule="evenodd" fillRule="evenodd"
......
/**
* @jest-environment jsdom
*/
/* eslint-disable import/no-extraneous-dependencies */
import { renderHook } from '@testing-library/react'
import { useKeyboardShortcut } from './use-keyboard-shortcut'
import { MODIFIERS } from './use-keyboard-shortcut'
describe('useKeyboardShortcut', () => {
let addEventListenerSpy: jest.SpyInstance
let removeEventListenerSpy: jest.SpyInstance
beforeEach(() => {
addEventListenerSpy = jest.spyOn(window, 'addEventListener')
removeEventListenerSpy = jest.spyOn(window, 'removeEventListener')
})
afterEach(() => {
jest.clearAllMocks()
})
it('should add and remove event listener', () => {
const callback = jest.fn()
const { unmount } = renderHook(() =>
useKeyboardShortcut({
key: 'k',
callback,
modifiers: [MODIFIERS.CTRL_CMD],
})
)
// When used `expect.any(Function)`, received:
// error TS21228: [ban-function-calls] Constructing functions from strings can lead to XSS.
const eventListener = addEventListenerSpy.mock.calls[0][1]
expect(typeof eventListener).toBe('function')
expect(addEventListenerSpy).toHaveBeenCalledWith('keydown', eventListener)
unmount()
expect(removeEventListenerSpy).toHaveBeenCalled()
})
it('should trigger callback when correct key and modifier are pressed', () => {
const callback = jest.fn()
renderHook(() =>
useKeyboardShortcut({
key: 'k',
callback,
modifiers: [MODIFIERS.CTRL_CMD],
})
)
// Simulate keydown event with Cmd/Ctrl + K
window.dispatchEvent(
new KeyboardEvent('keydown', {
key: 'k',
metaKey: true,
})
)
expect(callback).toHaveBeenCalledTimes(1)
})
it('should work with multiple modifiers', () => {
const callback = jest.fn()
renderHook(() =>
useKeyboardShortcut({
key: 'k',
callback,
modifiers: [MODIFIERS.CTRL_CMD, MODIFIERS.SHIFT],
})
)
// Should not trigger with just Cmd/Ctrl
window.dispatchEvent(
new KeyboardEvent('keydown', {
key: 'k',
metaKey: true,
})
)
expect(callback).not.toHaveBeenCalled()
// Should trigger with Cmd/Ctrl + Shift
window.dispatchEvent(
new KeyboardEvent('keydown', {
key: 'k',
metaKey: true,
shiftKey: true,
})
)
expect(callback).toHaveBeenCalledTimes(1)
})
it('should be case insensitive', () => {
const callback = jest.fn()
renderHook(() =>
useKeyboardShortcut({
key: 'k',
callback,
modifiers: [MODIFIERS.CTRL_CMD],
})
)
window.dispatchEvent(
new KeyboardEvent('keydown', {
key: 'K', // uppercase
metaKey: true,
})
)
expect(callback).toHaveBeenCalledTimes(1)
})
it('should prevent default event behavior', () => {
const callback = jest.fn()
renderHook(() =>
useKeyboardShortcut({
key: 'k',
callback,
modifiers: [MODIFIERS.CTRL_CMD],
})
)
const event = new KeyboardEvent('keydown', {
key: 'k',
metaKey: true,
})
const preventDefaultSpy = jest.spyOn(event, 'preventDefault')
window.dispatchEvent(event)
expect(preventDefaultSpy).toHaveBeenCalled()
})
})
import { useEffect } from 'react'
export const MODIFIERS = {
CTRL_CMD: 'CTRL_CMD',
ALT: 'ALT',
SHIFT: 'SHIFT',
} as const
type KeyboardShortcutProps = {
key: string
callback: () => void
modifiers: (typeof MODIFIERS)[keyof typeof MODIFIERS][]
}
export function useKeyboardShortcut({
key,
callback,
modifiers,
}: KeyboardShortcutProps) {
useEffect(() => {
const handleKeyDown = (e: KeyboardEvent) => {
const modifiersPressed = modifiers.every((modifier) => {
switch (modifier) {
case MODIFIERS.CTRL_CMD:
return e.metaKey || e.ctrlKey
case MODIFIERS.ALT:
return e.altKey
case MODIFIERS.SHIFT:
return e.shiftKey
default:
return false
}
})
if (modifiersPressed && e.key.toLowerCase() === key.toLowerCase()) {
e.preventDefault()
callback()
}
}
window.addEventListener('keydown', handleKeyDown)
return () => window.removeEventListener('keydown', handleKeyDown)
}, [key, callback, modifiers])
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment