[folding] Allow to specify if decorator should hide in collapsed region

[alefragnani]

When you define decorators for an editor (activeEditor.setDecorations), you must define a Range, which can be a specific line where you want to add that decorator (an image with gutterIconPath for instance).

But if you Fold the lines where this decorator is defined, the icon is not hidden with the lines, but instead, it is shown in the line where the folding starts.

I didn't find anything in line or decorators that could be used to detect if the line is folded, so I think that the folding engine should be taking care of that, right?

Thanks in advance

[aeschli]

@alefragnani If you could add also a code snippet that would be great. That way I can use this as test once we add language agnostic folding.
Thanks a lot!

[alefragnani]

Hi @aeschli , I will post a code snippet latter, when I go back to my home 😄 , but in the meantime you could see the same behavior using breakpoints.

If you set a breakpoint inside a function and fold the entire function, the breakpoint is presented in the folding line.

If that is the expected behavior, than it's ok... I just thought it should suppress the icon.

Thanks

[alefragnani]

Hi @aeschli ,

The code is fairly simple. I just create a TextEditorDecorationType and assign it to the vscode.window.activeTextEditor with an array of Range, which each element defines a line in the text.

• Creating the decoration

    var bookmarkDecorationType = vscode.window.createTextEditorDecorationType({
        gutterIconPath: pathIcon,
        overviewRulerLane: vscode.OverviewRulerLane.Full,
        overviewRulerColor: 'rgba(21, 126, 251, 0.7)'
    });

• Defining the lines that will show the decoration. Each activeBookmark.bookmarks element is a number that represents a line number in the text

        var books: vscode.Range[] = [];
        for (var index = 0; index < activeBookmark.bookmarks.length; index++) {
            var element = activeBookmark.bookmarks[index];
            var decoration = new vscode.Range(element, 0, element, 0);
            books.push(decoration);
        }

• Adds the set of decorations to the activeTextEditor

    vscode.window.activeTextEditor.setDecorations(bookmarkDecorationType, books);

As you can see, the decoration is defined to individual lines, to display the icon in the Gutter (like breakpoints). But then, when the code is folded, the icon is shown in the folding line. Take a look at the GIF below.

Thanks for your help

[aeschli]

@alefragnani Ah, now I understand. Ignore my first comment (I removed it).
There's no API for you to find out if a line is visible or not. We actually try to avoid that.
Would it make sense that you could specify if your annotation should hide for a folded region?
@alexandrudima Alex, FYI.

[alefragnani]

@aeschli No problem. In fact it was my fault, because I should have added this GIF right in the first post 😄

About your suggestion, I totally agree 👍 .

Thanks again

[aeschli]

For the May release I added a new setting so that the fold controls stay always visible:
"editor.showFoldingControls": "always"

[notrealdev]

Hi @aeschli , fold controls avaiable on version 1.12.1 ??
"editor.showFoldingControls": "always"

[aeschli]

It will be in 1.13

[aeschli]

Sorry, I closed the wrong issue.

[martin77s]

"editor.showFoldingControls": "always"
stopped working in 1.17

[aeschli]

Thanks @martin77s, I created #35885

[aeschli]

Since 1.18, decorations inside folded regions are hidden for performance reasons. They are no longer shown in the gutter.
There are no plans to make this configurable.