xtermjs/xterm.js

Auto fit addon doesn't work when parent element uses border-box

Open

#1,283 opened on Feb 12, 2018

View on GitHub
 (4 comments) (0 reactions) (1 assignee)TypeScript (16,196 stars) (1,574 forks)batch import
area/addon/fitgood first issuehelp wantedtype/bug

Description

The calculations for height and width of the parent in the auto fit plugin are incorrect when the parent element uses box-sizing: border-box. This is because the computed height includes the padding but the content does not.

The right implementation might be to get the client height of the parent element using gBCR and then subtract the parent padding.

/CC @taion

Contributor guide

Tech stack
typescriptcss
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
CSS box sizingJavaScriptxterm.js addon conventions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue is in the fit addon's fit.ts file (lines 30-31) where the computed height and width are incorrect when the parent uses border box. The fix involves using getBoundingClientRect (gBCR) to get the client height and width, then subtracting the parent padding. Implement this change in the fit function. Ensure tests pass and verify with a parent that has box sizing: border box.