xtermjs/xterm.js

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

Open

#4 978 ouverte le 3 mars 2024

Voir sur GitHub
 (10 commentaires) (0 réactions) (1 assigné)TypeScript (1 574 forks)batch import
help wantedtype/bug

Métriques du dépôt

Stars
 (16 196 stars)
Métriques de merge PR
 (Merge moyen 4j 3h) (81 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Étudiez le comportement de Terminal.open() lorsqu'il est appelé plusieurs fois. Le problème fournit une reproduction dans CodeSandbox (App.tsx) et fait référence à l'issue précédente #1323. Vérifiez la logique de nettoyage dans la méthode open et si le terminal se détache correctement de l'ancien élément DOM. Recherchez tout état qui pourrait ne pas être réinitialisé lors des appels ultérieurs. Envisagez d'ajouter une vérification ou de mettre à jour la documentation pour clarifier l'utilisation attendue.
Stack technique
typescriptjavascripthtmlcss
Domaine
frontend
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
En attente d'un mainteneur
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Familiarity with xterm.js APIUnderstanding of DOM lifecycle
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60