xtermjs/xterm.js

The terminal instance cannot be rendered correctly after calling `.open()` for the second time.

Open

#4,978 opened on Mar 3, 2024

View on GitHub
 (10 comments) (0 reactions) (1 assignee)TypeScript (16,196 stars) (1,574 forks)batch import
help wantedtype/bug

Description

I am new to using xtermjs. I am not sure whether the terminal instance can call the open() method multiple times. According to the official documentation and https://github.com/xtermjs/xterm.js/issues/1323, I tried it. When I removed the dom and mounted again, and used terminal.open(), xterm did not render after the second open.

Details

  • Browser and browser version: chrome 122.0.6261.94
  • OS version: macOS 14.3
  • xterm.js version: 5.4.0

Steps to reproduce

Reproduce

  1. Click the toggle button, xterm renders correctly.
  2. Click the toggle button, remove dom
  3. Click the toggle button, mount dom, xterm did not render after the second open

I'm sorry if there's something wrong with my usage

Contributor guide

Tech stack
typescriptjavascripthtmlcss
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with xterm.js APIUnderstanding of DOM lifecycle
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the behavior of Terminal.open() when called multiple times. The issue provides a reproduction in CodeSandbox (App.tsx) and references previous issue #1323. Check the source code for cleanup logic in the open method, and whether the terminal properly detaches from the old DOM element. Look for any state that might not be reset on subsequent calls. Consider adding a check or update to the documentation to clarify expected usage.