xtermjs/xterm.js

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

Open

#4,978 建立於 2024年3月3日

在 GitHub 查看
 (10 留言) (0 反應) (1 負責人)TypeScript (16,196 star) (1,574 fork)batch import
help wantedtype/bug

描述

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

貢獻者指南

技術棧
typescriptjavascripthtmlcss
領域
frontend
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
needs maintainer response
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Familiarity with xterm.js APIUnderstanding of DOM lifecycle
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.