docs: added usage tip for registerMarker()#5317
Merged
Tyriar merged 4 commits intoxtermjs:masterfrom Apr 22, 2025
Merged
Conversation
tabarra
added a commit
to citizenfx/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
force-pushed
the
docs/registerMarker-tip
branch
from
b395a5c to
78fbae3
Compare
Tyriar
approved these changes
Apr 22, 2025
Member
Tyriar
left a comment
Tyriar
left a comment
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.