xtermjs/xterm.js

Browser Copy/Paste support documentation

Open

#2,478 opened on Oct 17, 2019

View on GitHub
 (12 comments) (0 reactions) (0 assignees)TypeScript (1,574 forks)batch import
help wantedtype/documentation

Repository metrics

Stars
 (16,196 stars)
PR merge metrics
 (Avg merge 4d 3h) (81 merged PRs in 30d)

Description

I'm using xterm.js in the browser and it seems copy/and paste functionality varies depending on the users browser and/or platform.

I can copy and paste using the standard Cmd + C and Cmd + V in Google Chrome and Firefox on Mac, but my Linux users are saying that Ctrl + C and Ctrl + V don't work for them in Google Chrome, but Ctrl + Shift + V does (But not Ctrl + Shift + C).

It would be good to get some documentation around what are the default keybindings and whether they are supported in all browsers – or some form of matrix to show which commands and browsers are supported so the information can be forwarded to users?

Contributor guide

Research direction
Review the xterm.js source code and documentation to identify default keybindings for copy and paste. Then test these keybindings across different browsers (Chrome, Firefox, Safari) on different platforms (macOS, Linux, Windows) to create a compatibility matrix. Update the documentation with the findings, including any known issues or workarounds.
Tech stack
typescript
Domain
documentationfrontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic knowledge of xterm.jsFamiliarity with browser keybindingsAccess to multiple browsers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75