TextArea (soft_wrap=False) cuts off the end of a line that has double-width characters before a tab

Open
#6,779 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
frontend

Research direction

Start by comparing Document.get_size() with TextArea's expand_tabs_inline path, then run the supplied reproduction with 中中\tEND and soft_wrap=False. Done means the measured width matches the drawn cell width and the full line, including END, is visible; the reporter says they already have a PR with a test ready.

Written by the indexing model from the issue text.

Description

Hi! I hit this while writing generated tests against Textual's widgets.

With soft_wrap=False, TextArea sets its virtual width from Document.get_size(), which measures each line with cell_len(line.expandtabs(tab_width)). str.expandtabs counts a double-width character as one column, so after CJK text the tab stops land in a different place from where TextArea draws them (it uses expand_tabs_inline, which counts cells). The width can come out too small, and then the end of the line can't be seen or scrolled to.

import asyncio

import textual
from textual.app import App, ComposeResult
from textual.widgets import TextArea

TEXT = "中中\tEND"  # 中中 is 4 cells, the tab pads to column 8, then END: 11 cells

class TextAreaApp(App):
    def compose(self) -> ComposeResult:
        yield TextArea(TEXT, soft_wrap=False, show_line_numbers=False, tab_behavior="indent")

async def main() -> None:
    app = TextAreaApp()
    async with app.run_test(size=(40, 5)) as pilot:
        text_area = app.query_one(TextArea)
        await pilot.pause()
        print("indent_width:", text_area.indent_width)
        print("first line on screen:", repr(text_area.render_line(0).text.rstrip()))
        print("screenshot contains 'END':", "END" in app.export_screenshot())
        print("document.get_size():", text_area.document.get_size(text_area.indent_width))
        print("virtual_size:", text_area.virtual_size)
    print("Textual", textual.__version__)

asyncio.run(main())

Output on Textual 8.2.7 (and the same on main at 5e5b7ef):

indent_width: 4
first line on screen: '中中    EN'
screenshot contains 'END': False
document.get_size(): Size(width=9, height=1)
virtual_size: Size(width=10, height=1)

The TextArea is 40 cells wide, but the "D" is never drawn: expandtabs puts the tab stop at column 4 (counting 中中 as 2 columns), so the line measures 9 cells instead of 11. I expected get_size() to measure tabs the same way the line is drawn. Using expand_tabs_inline there gives Size(width=11, height=1) and the whole line shows. I have a PR with a test ready.

Dominant language
Python
Stars
37.7k
Forks
1.5k
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Textualize/textual

All issues in Textualize/textual

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.