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.

Sign up for GitHub

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

Connect: Prepare keyboard shortcuts configuration #22193

Merged
merged 6 commits into from
Mar 3, 2023
Merged

Connect: Prepare keyboard shortcuts configuration #22193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
00353d8
Make naming around keyboard shortcuts more consistent
gzdunek Feb 23, 2023
86f2071
Use "+" instead of "-" as a separator
gzdunek Feb 23, 2023
b68cbb5
Rename some config keys to follow the same naming pattern
gzdunek Feb 23, 2023
857805e
Rename keyboard shortcuts to match config keys
gzdunek Feb 23, 2023
790087e
Extract `mapAcceleratorsToActions` to a function
gzdunek Feb 24, 2023
38aabfe
Rename other "keyboard shortcuts" to "accelerators" and "actions"
gzdunek Feb 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
187 changes: 93 additions & 94 deletions web/packages/teleterm/src/services/config/configService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,55 +35,55 @@ const createAppConfigSchema = (platform: Platform) => {
return z.object({
'usageReporting.enabled': z.boolean().default(false),
'keymap.tab1': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-1'])
z.string().default(defaultKeymap['tab1'])
),
'keymap.tab2': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-2'])
z.string().default(defaultKeymap['tab2'])
),
'keymap.tab3': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-3'])
z.string().default(defaultKeymap['tab3'])
),
'keymap.tab4': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-4'])
z.string().default(defaultKeymap['tab4'])
),
'keymap.tab5': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-5'])
z.string().default(defaultKeymap['tab5'])
),
'keymap.tab6': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-6'])
z.string().default(defaultKeymap['tab6'])
),
'keymap.tab7': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-7'])
z.string().default(defaultKeymap['tab7'])
),
'keymap.tab8': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-8'])
z.string().default(defaultKeymap['tab8'])
),
'keymap.tab9': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-9'])
z.string().default(defaultKeymap['tab9'])
),
'keymap.tabClose': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-close'])
'keymap.closeTab': omitStoredConfigValue(
z.string().default(defaultKeymap['closeTab'])
),
'keymap.tabNew': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-new'])
'keymap.newTab': omitStoredConfigValue(
z.string().default(defaultKeymap['newTab'])
),
'keymap.tabPrevious': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-previous'])
'keymap.previousTab': omitStoredConfigValue(
z.string().default(defaultKeymap['previousTab'])
),
'keymap.tabNext': omitStoredConfigValue(
z.string().default(defaultKeymap['tab-next'])
'keymap.nextTab': omitStoredConfigValue(
z.string().default(defaultKeymap['nextTab'])
),
'keymap.toggleConnections': omitStoredConfigValue(
z.string().default(defaultKeymap['toggle-connections'])
'keymap.openConnections': omitStoredConfigValue(
z.string().default(defaultKeymap['openConnections'])
),
'keymap.toggleClusters': omitStoredConfigValue(
z.string().default(defaultKeymap['toggle-clusters'])
'keymap.openClusters': omitStoredConfigValue(
z.string().default(defaultKeymap['openClusters'])
),
'keymap.toggleIdentity': omitStoredConfigValue(
z.string().default(defaultKeymap['toggle-identity'])
'keymap.openProfiles': omitStoredConfigValue(
z.string().default(defaultKeymap['openProfiles'])
),
'keymap.openQuickInput': omitStoredConfigValue(
z.string().default(defaultKeymap['open-quick-input'])
z.string().default(defaultKeymap['openQuickInput'])
),
/**
* This value can be provided by the user and is unsanitized. This means that it cannot be directly interpolated
Expand All @@ -106,87 +106,86 @@ export type AppConfig = z.infer<ReturnType<typeof createAppConfigSchema>>;
* Command-Control-Option-Shift for macOS
* Ctrl-Alt-Shift for other platforms
*/
export type KeyboardShortcutType =
| 'tab-1'
| 'tab-2'
| 'tab-3'
| 'tab-4'
| 'tab-5'
| 'tab-6'
| 'tab-7'
| 'tab-8'
| 'tab-9'
| 'tab-close'
| 'tab-new'
| 'tab-previous'
| 'tab-next'
| 'open-quick-input'
| 'toggle-connections'
| 'toggle-clusters'
| 'toggle-identity';
export type KeyboardShortcutAction =
| 'tab1'
| 'tab2'
| 'tab3'
| 'tab4'
| 'tab5'
| 'tab6'
| 'tab7'
| 'tab8'
| 'tab9'
| 'closeTab'
| 'newTab'
| 'previousTab'
| 'nextTab'
| 'openQuickInput'
| 'openConnections'
| 'openClusters'
| 'openProfiles';

export type KeyboardShortcutsConfig = Record<KeyboardShortcutType, string>;
const getDefaultKeymap = (platform: Platform) => {
switch (platform) {
case 'win32':
return {
'tab-1': 'Ctrl-1',
'tab-2': 'Ctrl-2',
'tab-3': 'Ctrl-3',
'tab-4': 'Ctrl-4',
'tab-5': 'Ctrl-5',
'tab-6': 'Ctrl-6',
'tab-7': 'Ctrl-7',
'tab-8': 'Ctrl-8',
'tab-9': 'Ctrl-9',
'tab-close': 'Ctrl-W',
'tab-new': 'Ctrl-T',
'tab-previous': 'Ctrl-Shift-Tab',
'tab-next': 'Ctrl-Tab',
'open-quick-input': 'Ctrl-K',
'toggle-connections': 'Ctrl-P',
'toggle-clusters': 'Ctrl-E',
'toggle-identity': 'Ctrl-I',
tab1: 'Ctrl+1',
tab2: 'Ctrl+2',
tab3: 'Ctrl+3',
tab4: 'Ctrl+4',
tab5: 'Ctrl+5',
tab6: 'Ctrl+6',
tab7: 'Ctrl+7',
tab8: 'Ctrl+8',
tab9: 'Ctrl+9',
closeTab: 'Ctrl+W',
newTab: 'Ctrl+T',
previousTab: 'Ctrl+Shift+Tab',
nextTab: 'Ctrl+Tab',
openQuickInput: 'Ctrl+K',
openConnections: 'Ctrl+P',
openClusters: 'Ctrl+E',
openProfiles: 'Ctrl+I',
};
case 'linux':
return {
'tab-1': 'Alt-1',
'tab-2': 'Alt-2',
'tab-3': 'Alt-3',
'tab-4': 'Alt-4',
'tab-5': 'Alt-5',
'tab-6': 'Alt-6',
'tab-7': 'Alt-7',
'tab-8': 'Alt-8',
'tab-9': 'Alt-9',
'tab-close': 'Ctrl-W',
'tab-new': 'Ctrl-T',
'tab-previous': 'Ctrl-Shift-Tab',
'tab-next': 'Ctrl-Tab',
'open-quick-input': 'Ctrl-K',
'toggle-connections': 'Ctrl-P',
'toggle-clusters': 'Ctrl-E',
'toggle-identity': 'Ctrl-I',
tab1: 'Alt+1',
tab2: 'Alt+2',
tab3: 'Alt+3',
tab4: 'Alt+4',
tab5: 'Alt+5',
tab6: 'Alt+6',
tab7: 'Alt+7',
tab8: 'Alt+8',
tab9: 'Alt+9',
closeTab: 'Ctrl+W',
newTab: 'Ctrl+T',
previousTab: 'Ctrl+Shift+Tab',
nextTab: 'Ctrl+Tab',
openQuickInput: 'Ctrl+K',
openConnections: 'Ctrl+P',
openClusters: 'Ctrl+E',
openProfiles: 'Ctrl+I',
};
case 'darwin':
return {
'tab-1': 'Command-1',
'tab-2': 'Command-2',
'tab-3': 'Command-3',
'tab-4': 'Command-4',
'tab-5': 'Command-5',
'tab-6': 'Command-6',
'tab-7': 'Command-7',
'tab-8': 'Command-8',
'tab-9': 'Command-9',
'tab-close': 'Command-W',
'tab-new': 'Command-T',
'tab-previous': 'Control-Shift-Tab',
'tab-next': 'Control-Tab',
'open-quick-input': 'Command-K',
'toggle-connections': 'Command-P',
'toggle-clusters': 'Command-E',
'toggle-identity': 'Command-I',
tab1: 'Command+1',
tab2: 'Command+2',
tab3: 'Command+3',
tab4: 'Command+4',
tab5: 'Command+5',
tab6: 'Command+6',
tab7: 'Command+7',
tab8: 'Command+8',
tab9: 'Command+9',
closeTab: 'Command+W',
newTab: 'Command+T',
previousTab: 'Control+Shift+Tab',
nextTab: 'Control+Tab',
openQuickInput: 'Command+K',
openConnections: 'Command+P',
openClusters: 'Command+E',
openProfiles: 'Command+I',
};
}
};
Expand Down
24 changes: 12 additions & 12 deletions web/packages/teleterm/src/ui/Documents/KeyboardShortcutsPanel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,31 +21,31 @@ import styled from 'styled-components';

import Document from 'teleterm/ui/Document';
import { useKeyboardShortcutFormatters } from 'teleterm/ui/services/keyboardShortcuts';
import { KeyboardShortcutType } from 'teleterm/services/config';
import { KeyboardShortcutAction } from 'teleterm/services/config';

export function KeyboardShortcutsPanel() {
const { getShortcut } = useKeyboardShortcutFormatters();
const { getAccelerator } = useKeyboardShortcutFormatters();

const items: { title: string; shortcutKey: KeyboardShortcutType }[] = [
const items: { title: string; shortcutAction: KeyboardShortcutAction }[] = [
{
title: 'Open New Tab',
shortcutKey: 'tab-new',
shortcutAction: 'newTab',
},
{
title: 'Go To Next Tab',
shortcutKey: 'tab-next',
shortcutAction: 'nextTab',
},
{
title: 'Open Connections',
shortcutKey: 'toggle-connections',
shortcutAction: 'openConnections',
},
{
title: 'Open Clusters',
shortcutKey: 'toggle-clusters',
shortcutAction: 'openClusters',
},
{
title: 'Open Profiles',
shortcutKey: 'toggle-identity',
shortcutAction: 'openProfiles',
},
];

Expand All @@ -55,25 +55,25 @@ export function KeyboardShortcutsPanel() {
{items.map(item => (
<Entry
title={item.title}
shortcut={getShortcut(item.shortcutKey, {
accelerator={getAccelerator(item.shortcutAction, {
useWhitespaceSeparator: true,
})}
key={item.shortcutKey}
key={item.shortcutAction}
/>
))}
</Grid>
</Document>
);
}

function Entry(props: { title: string; shortcut: string }) {
function Entry(props: { title: string; accelerator: string }) {
return (
<>
<Text textAlign="right" color="light" typography="subtitle1" py="4px">
{props.title}
</Text>
<MonoText bg="primary.main" textAlign="left" px="12px" py="4px">
{props.shortcut}
{props.accelerator}
</MonoText>
</>
);
Expand Down
11 changes: 6 additions & 5 deletions web/packages/teleterm/src/ui/QuickInput/useQuickInput.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import {
Suggestion,
} from 'teleterm/ui/services/quickInput/types';
import { routing } from 'teleterm/ui/uri';
import { KeyboardShortcutType } from 'teleterm/services/config';
import { KeyboardShortcutAction } from 'teleterm/services/config';

import { assertUnreachable, retryWithRelogin } from '../utils';

Expand Down Expand Up @@ -67,14 +67,15 @@ export default function useQuickInput() {
});
}
}

get();
}, [parseResult]);

const hasSuggestions =
suggestionsAttempt.status === 'success' &&
suggestionsAttempt.data.length > 0;
const openQuickInputShortcutKey: KeyboardShortcutType = 'open-quick-input';
const { getShortcut } = useKeyboardShortcutFormatters();
const openQuickInputShortcutAction: KeyboardShortcutAction = 'openQuickInput';
const { getAccelerator } = useKeyboardShortcutFormatters();

const onFocus = (e: any) => {
if (e.relatedTarget) {
Expand Down Expand Up @@ -162,7 +163,7 @@ export default function useQuickInput() {
};

useKeyboardShortcuts({
[openQuickInputShortcutKey]: () => {
[openQuickInputShortcutAction]: () => {
quickInputService.show();
},
});
Expand Down Expand Up @@ -193,7 +194,7 @@ export default function useQuickInput() {
onInputChange: quickInputService.setInputValue,
onHide: quickInputService.hide,
onShow: quickInputService.show,
keyboardShortcut: getShortcut(openQuickInputShortcutKey),
keyboardShortcut: getAccelerator(openQuickInputShortcutAction),
};
}

Expand Down
12 changes: 6 additions & 6 deletions web/packages/teleterm/src/ui/TabHost/TabHost.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ function getTestSetup({ documents }: { documents: Document[] }) {
// @ts-expect-error we don't provide entire config
getShortcutsConfig() {
return {
'tab-close': 'Command-W',
'tab-new': 'Command-T',
'open-quick-input': 'Command-K',
'toggle-connections': 'Command-P',
'toggle-clusters': 'Command-E',
'toggle-identity': 'Command-I',
closeTab: 'Command-W',
newTab: 'Command-T',
openQuickInput: 'Command-K',
openConnections: 'Command-P',
openClusters: 'Command-E',
openProfiles: 'Command-I',
};
},
};
Expand Down
6 changes: 3 additions & 3 deletions web/packages/teleterm/src/ui/TabHost/TabHost.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export function TabHost({ ctx }: { ctx: IAppContext }) {
localClusterUri:
ctx.workspacesService.getActiveWorkspace()?.localClusterUri,
});
const { getLabelWithShortcut } = useKeyboardShortcutFormatters();
const { getLabelWithAccelerator } = useKeyboardShortcutFormatters();

useTabShortcuts({
documentsService,
Expand Down Expand Up @@ -108,8 +108,8 @@ export function TabHost({ ctx }: { ctx: IAppContext }) {
onMoved={handleTabMoved}
disableNew={false}
onNew={openClusterTab}
newTabTooltip={getLabelWithShortcut('New Tab', 'tab-new')}
closeTabTooltip={getLabelWithShortcut('Close', 'tab-close')}
newTabTooltip={getLabelWithAccelerator('New Tab', 'newTab')}
closeTabTooltip={getLabelWithAccelerator('Close', 'closeTab')}
/>
</Flex>
<DocumentsRenderer />
Expand Down
Loading