Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: listen for the meta press failure on the keyup event #1968

Merged
merged 5 commits into from
Nov 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions packages/hooks/src/useKeyPress/__tests__/index.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,15 @@ describe('useKeyPress ', () => {
expect(callback.mock.calls.length).toBe(2);
unmount();
});

it('meta key should be work in keyup event', async () => {
renderHook(() =>
useKeyPress(['meta'], callback, {
events: ['keyup'],
}),
);

fireEvent.keyUp(document, { key: 'meta', keyCode: 91, metaKey: false });
expect(callback).toBeCalled();
});
});
16 changes: 14 additions & 2 deletions packages/hooks/src/useKeyPress/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { isFunction, isNumber, isString } from '../utils';
import type { BasicTarget } from '../utils/domTarget';
import { getTargetElement } from '../utils/domTarget';
import useDeepCompareEffectWithTarget from '../utils/useDeepCompareWithTarget';
import isAppleDevice from '../utils/isAppleDevice';

export type KeyPredicate = (event: KeyboardEvent) => boolean;
export type keyType = number | string;
Expand Down Expand Up @@ -122,12 +123,23 @@ const aliasKeyCodeMap = {
singlequote: 222,
};

if (isAppleDevice) {
aliasKeyCodeMap['meta'] = [91, 93];
} else {
aliasKeyCodeMap['meta'] = [91, 92];
}

// 修饰键
const modifierKey = {
ctrl: (event: KeyboardEvent) => event.ctrlKey,
shift: (event: KeyboardEvent) => event.shiftKey,
alt: (event: KeyboardEvent) => event.altKey,
meta: (event: KeyboardEvent) => event.metaKey,
meta: (event: KeyboardEvent) => {
if (event.type === 'keyup') {
return aliasKeyCodeMap['meta'].includes(event.keyCode);
}
return event.metaKey;
},
};

// 根据 event 计算激活键数量
Expand Down Expand Up @@ -169,7 +181,7 @@ function genFilterKey(event: KeyboardEvent, keyFilter: keyType, exactMatch: bool
// 组合键
const genModifier = modifierKey[key];
// keyCode 别名
const aliasKeyCode = aliasKeyCodeMap[key.toLowerCase()];
const aliasKeyCode: number | number[] = aliasKeyCodeMap[key.toLowerCase()];

if ((genModifier && genModifier(event)) || (aliasKeyCode && aliasKeyCode === event.keyCode)) {
genLen++;
Expand Down
5 changes: 5 additions & 0 deletions packages/hooks/src/utils/isAppleDevice.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
const isAppleDevice = /(mac|iphone|ipod|ipad)/i.test(
typeof navigator !== 'undefined' ? navigator?.platform : '',
);

export default isAppleDevice;