insomnia/packages/insomnia-app/app/ui/components/hotkey.tsx
2021-12-01 19:25:13 +00:00

64 lines
1.7 KiB
TypeScript

import classnames from 'classnames';
import { KeyBindings, KeyCombination } from 'insomnia-common';
import React, { FC, memo } from 'react';
import { isMac } from '../../common/constants';
import { constructKeyCombinationDisplay, getPlatformKeyCombinations } from '../../common/hotkeys';
interface Props {
/** One of these two must be given. If both is given, keyCombination will be used. */
keyCombination?: KeyCombination;
keyBindings?: KeyBindings;
className?: string;
/** Show fallback message if keyCombination is not given, but keyBindings has no key combinations. */
useFallbackMessage?: boolean;
}
export const Hotkey: FC<Props> = memo(({ keyCombination, keyBindings, className, useFallbackMessage }) => {
if (keyCombination == null && keyBindings == null) {
console.error('Hotkey needs one of keyCombination or keyBindings!');
return null;
}
let keyComb: KeyCombination | null = null;
if (keyCombination != null) {
keyComb = keyCombination;
} else if (keyBindings != null) {
const keyCombs = getPlatformKeyCombinations(keyBindings);
// Only take the first key combination if there is a mapping.
if (keyCombs.length > 0) {
keyComb = keyCombs[0];
}
}
let display = '';
if (keyComb != null) {
display = constructKeyCombinationDisplay(keyComb, false);
}
const isFallback = display.length === 0 && useFallbackMessage;
if (isFallback) {
display = 'Not defined';
}
const classes = {
'font-normal': isMac(),
italic: isFallback,
};
return (
<span
className={classnames(className, classes)}
style={{ verticalAlign: 'middle' }}
>
{display}
</span>
);
});
Hotkey.displayName = 'Hotkey';