Skip to content

Allow pasting in the terminal #3824

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

Merged
datho7561 merged 1 commit into from
Jan 23, 2024
Merged

Allow pasting in the terminal #3824

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
97 changes: 70 additions & 27 deletions src/webview/openshift-terminal/app/terminalInstance.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Licensed under the MIT License. See LICENSE file in the project root for license information.
*-----------------------------------------------------------------------------------------------*/

import { Box, Button, Paper, Stack, Typography } from '@mui/material';
import { Box, Button, Paper, Stack, Typography, debounce } from '@mui/material';
import React from 'react';
import { VSCodeMessage } from './vscodeMessage';
import { Terminal, ITheme } from 'xterm';
Expand All @@ -20,20 +20,21 @@ const TerminalContextMenu = (props: {
onClearHandler: React.MouseEventHandler<HTMLButtonElement>;
onCopyHandler: React.MouseEventHandler<HTMLButtonElement>;
onSelectAllHandler: React.MouseEventHandler<HTMLButtonElement>;
onPasteHandler: React.MouseEventHandler<HTMLButtonElement>;
}) => {
return (
<Paper
variant="outlined"
variant='outlined'
sx={{
borderRadius: '6px',
backgroundColor: 'var(--vscode-editor-background)',
borderColor: 'var(--vscode-menu-border)',
boxShadow: '0px 0px 8px var(--vscode-widget-shadow)',
}}
>
<Stack direction="column" minWidth="200px" marginX="4px" marginY="3px">
<Stack direction='column' minWidth='200px' marginX='4px' marginY='3px'>
<Button
variant="text"
variant='text'
onClick={props.onCopyHandler}
sx={{
width: '100%',
Expand All @@ -46,17 +47,17 @@ const TerminalContextMenu = (props: {
}}
>
<Stack
direction="row"
justifyContent="space-between"
marginX="13px"
direction='row'
justifyContent='space-between'
marginX='13px'
style={{ width: '100%' }}
>
<Typography variant="body1">Copy</Typography>
<Typography variant="body1">Ctrl+Shift+C</Typography>
<Typography variant='body1'>Copy</Typography>
<Typography variant='body1'>Ctrl+Shift+C</Typography>
</Stack>
</Button>
<Button
variant="text"
variant='text'
onClick={props.onSelectAllHandler}
sx={{
width: '100%',
Expand All @@ -69,17 +70,40 @@ const TerminalContextMenu = (props: {
}}
>
<Stack
direction="row"
justifyContent="space-between"
marginX="13px"
direction='row'
justifyContent='space-between'
marginX='13px'
style={{ width: '100%' }}
>
<Typography variant="body1">Select All</Typography>
<Typography variant="body1">Ctrl+Shift+A</Typography>
<Typography variant='body1'>Select All</Typography>
<Typography variant='body1'>Ctrl+Shift+A</Typography>
</Stack>
</Button>
<Button
variant="text"
variant='text'
onClick={props.onPasteHandler}
sx={{
width: '100%',
textTransform: 'none',
'&:hover': {
backgroundColor:
'color-mix(in srgb, var(--vscode-button-background) 50%, black)',
},
paddingY: '4px',
}}
>
<Stack
direction='row'
justifyContent='space-between'
marginX='13px'
style={{ width: '100%' }}
>
<Typography variant='body1'>Paste</Typography>
<Typography variant='body1'>Ctrl+Shift+V</Typography>
</Stack>
</Button>
<Button
variant='text'
onClick={props.onClearHandler}
sx={{
width: '100%',
Expand All @@ -92,12 +116,12 @@ const TerminalContextMenu = (props: {
}}
>
<Stack
direction="row"
justifyContent="flex-start"
marginX="13px"
direction='row'
justifyContent='flex-start'
marginX='13px'
style={{ width: '100%' }}
>
<Typography variant="body1">Clear</Typography>
<Typography variant='body1'>Clear</Typography>
</Stack>
</Button>
</Stack>
Expand Down Expand Up @@ -139,6 +163,13 @@ export const TerminalInstance = (props: {
setContextMenuOpen(false);
};

const handlePaste = () => {
void navigator.clipboard.readText().then((clipboardContent: string) => {
term.paste(clipboardContent);
});
setContextMenuOpen(false);
};

const handleSelectAll = () => {
term.selectAll();
setContextMenuOpen(false);
Expand All @@ -152,7 +183,7 @@ export const TerminalInstance = (props: {
uuid: props.uuid,
},
});
}
};

// The xtermjs addon that can be used to resize the terminal according to the size of the div
const fitAddon = React.useMemo(() => {
Expand All @@ -165,7 +196,7 @@ export const TerminalInstance = (props: {
kind: 'openExternal',
data: {
uuid: props.uuid,
url: uri
url: uri,
},
});
}
Expand All @@ -190,6 +221,17 @@ export const TerminalInstance = (props: {
term.selectAll();
keyboardEvent.stopPropagation();
return false;
} else if (keyboardEvent.code === 'KeyV') {
// Ctrl+Shift+V pastes
debounce(() => {
void navigator.clipboard
.readText() //
.then((clipboardContent: string) => {
term.paste(clipboardContent);
});
});
keyboardEvent.stopPropagation();
return false;
}
}

Expand Down Expand Up @@ -363,11 +405,11 @@ export const TerminalInstance = (props: {
return (
<Box
onContextMenu={handleContextMenu}
marginY="8px"
marginX="16px"
width="100%"
height="100%"
overflow="scroll"
marginY='8px'
marginX='16px'
width='100%'
height='100%'
overflow='scroll'
>
<div
style={{
Expand All @@ -381,6 +423,7 @@ export const TerminalInstance = (props: {
onCopyHandler={handleCopy}
onSelectAllHandler={handleSelectAll}
onClearHandler={handleClear}
onPasteHandler={handlePaste}
/>
</div>
<div
Expand Down
⚡