Skip to content

Expand docs on the side in the suggest widget - #25812

Merged
Ramya Rao (ramya-rao-a) merged 6 commits into
masterfrom
ramyar/docs-on-the-side
May 8, 2017
Merged

Ramya Rao (ramya-rao-a) merged 6 commits into
masterfrom
ramyar/docs-on-the-side

Conversation

@ramya-rao-a

@ramya-rao-a Ramya Rao (ramya-rao-a) commented May 3, 2017 •

Copy link
Copy Markdown
Contributor

First draft for #18582

Features in the PR:

  • If either suggestion.details or suggestion.documentation exist, they will appear on the side of the suggest list. If no docs but details match then label, then the docs section is not shown
  • To use page up and down in the docs, press ctrl+space and then page up and down as usual
  • A logic based on cursor position and viewport length is in place to decide when to swap the list and the docs. Not fool proof yet. Just a starting point

Pending:

  • More testing on corner scenarios where the list and docs need to be swapped
  • Show docs below when editor window is too small
  • A visual cue for when focus is on the docs section vs the list
  • Test accessibility and screen reader

Update as of 5/7: Logic to decide when to swap list and docs, where to position the suggest widget and when to re-size the docs is finalized here: https://github.com/Microsoft/vscode/blob/ramyar/docs-on-the-side/src/vs/editor/contrib/suggest/browser/suggestWidget.ts#L817

@mention-bot

Copy link
Copy Markdown

Ramya Rao (@ramya-rao-a), thanks for your PR! By analyzing the history of the files in this pull request, we identified João Moreno (@joaomoreno) and Johannes Rieken (@jrieken) to be potential reviewers.

@joaomoreno

Copy link
Copy Markdown
Contributor

I'll file individual issues for the problems I find.

@joaomoreno João Moreno (joaomoreno) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code looks OK. I filed a few issues. Nothing blocking in my opinion, just a lot of tweaking. I'll leave the merge decision up to you.

height: 100%;
width: 100%;
width: 40%;
float: left;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Careful with floats. If all you have is two divs, you should use the usual inline-block display to lay them out side by side.

@ramya-rao-a
Ramya Rao (ramya-rao-a) merged commit 4e180de into master May 8, 2017
@joaomoreno
João Moreno (joaomoreno) deleted the ramyar/docs-on-the-side branch May 8, 2017 06:26
@github-actions github-actions Bot locked and limited conversation to collaborators Mar 27, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants