Skip to content

docs: added usage tip for registerMarker() #5317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 22, 2025

Conversation

tabarra
Copy link
Contributor

@tabarra tabarra commented Mar 2, 2025

Simple PR to add a usage tip for term.registerMarker().
Apologies if this sounds obvious, but definitely took me half an hour to figure out how to best deal with this issue.

Important

The issue with using the batched line index id only happens when there are lines reflowing above the marker position, and I don't know if the issue would be better solving by using the option from issue #5213.
Please disregard this PR if there are better options that I'm unaware.

tabarra added a commit to tabarra/txAdmin that referenced this pull request Mar 2, 2025
This happened when there was any line reflowing above it.
Context: xtermjs/xterm.js#5317
@Tyriar Tyriar force-pushed the docs/registerMarker-tip branch from b395a5c to 78fbae3 Compare April 22, 2025 09:54
Copy link
Member

@Tyriar Tyriar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. registerMarker isn't used too often with write calls so it clutters the docs having it there imo. I instead made the note about the callback clearer in the write* docs.

@Tyriar Tyriar enabled auto-merge April 22, 2025 09:55
@Tyriar Tyriar added this to the 6.0.0 milestone Apr 22, 2025
@Tyriar Tyriar self-assigned this Apr 22, 2025
@Tyriar Tyriar merged commit 2af170d into xtermjs:master Apr 22, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants