Skip to content
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

Allow tooltips/hovering on symbols in outline view and breadcrumbs #102650

Open
piersdeseilligny opened this issue Jul 15, 2020 · 1 comment
Open
Assignees
Labels
breadcrumbs feature-request Request for new features or functionality outline Source outline view issues
Milestone

Comments

@piersdeseilligny
Copy link

Currently, the information which breadcrumbs and the outline view can provide is limited to two strings: the title and the "detail" (breadcrumbs are not even able to display the detail string). For the underlying complexity of the information being presented, this seems quite limiting.

In order to optionally provide more information about a symbol (and without cluttering the UI), it would be really nice if if symbols could at least provide a tooltip, through an extremely simple DocumentSymbol.tooltip: string property (basically identical to the underlying tooltip property of TreeItem).

If this feature were to be taken all the way, hovering over symbols in the breadcrumbs or outline view could display information about the symbol from the document's registered HoverProvider for the symbol's selectionRange. This could be enabled/disabled on a symbol-by-symbol basis (something along the lines of DocumentSymbol.triggerhoverprovider: boolean). This would make the breadcrumbs and outline view significantly more useful for understanding the structure of a document without fully diving into the code.

Bad behaviour

image

unhelpful, repetitive, ugly: i already know the name of the symbol, it's just there

Good behaviour

betterhover

helpful, useful, and pretty: the only way I could know what this part of the document does is by clicking the symbol and hovering over it in the editor

DocumentSymbols help explain the structure of the code - why limit this explanation to the name, especially when there's more information about them so readily available?

@jrieken jrieken added breadcrumbs feature-request Request for new features or functionality outline Source outline view issues labels Jul 16, 2020
@jrieken jrieken added this to the Backlog milestone Jul 16, 2020
@fowl2
Copy link

fowl2 commented Jul 24, 2020

note that if the "title" is long, the tooltip displaying it 'again' might not be redundant

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breadcrumbs feature-request Request for new features or functionality outline Source outline view issues
Projects
None yet
Development

No branches or pull requests

3 participants