Skip to content

Make registerMarker's cursor offset optional #3611

Closed
Closed
Make registerMarker's cursor offset optional#3611
Labels
area/apigood first issuehelp wantedtype/enhancementFeatures or improvements to existing features
@Tyriar

Description

@Tyriar
Tyriar
opened on Jan 21, 2022

We've been using markers more and more in xterm.js and found that every case so far looks like registerMarker(0)

We should make the argument optional and have it imply 0 (same line as the cursor).

xterm.js/typings/xterm.d.ts

Lines 860 to 866 in 6c18b7f

/**
* (EXPERIMENTAL) Adds a marker to the normal buffer and returns it. If the
* alt buffer is active, undefined is returned.
* @param cursorYOffset The y position offset of the marker from the cursor.
* @returns The new marker or undefined.
*/
registerMarker(cursorYOffset: number): IMarker | undefined;

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/apigood first issuehelp wantedtype/enhancementFeatures or improvements to existing features

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions