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

context sensitive help #4915

Merged
merged 19 commits into from
Aug 22, 2024
Merged

context sensitive help #4915

merged 19 commits into from
Aug 22, 2024

Conversation

willmcgugan
Copy link
Collaborator

@willmcgugan willmcgugan commented Aug 21, 2024

  • Adds widget help to the help panel (previously the "key panel").
    DOMNodes now have a HELP classvar which may be set to Markdown that renders in the help panel.
  • Removes some jankiness when summoning the command palette.
Screenshot 2024-08-21 at 13 33 27

@willmcgugan willmcgugan changed the title WIP context sensitive help context sensitive help Aug 21, 2024
@darrenburns
Copy link
Member

Should the sidebar have a title of "Help", or the name of the widget that the help is being displayed for? Or customisable? Or nothing? 😄

@darrenburns
Copy link
Member

This looks good to me but I think I'd want a title personally (which could always be hidden with display: none) and also some way of controlling it with the keyboard.

@willmcgugan
Copy link
Collaborator Author

The title of the widget is shown above the top group of keys.

I don't think it looks good with a title. Seems redundant, and it takes up 2 lines.

Agree about keyboard control, but I'll do that in another pass.

Screenshot 2024-08-22 at 10 42 33

@willmcgugan
Copy link
Collaborator Author

How about this?

Screen.Recording.2024-08-22.at.10.53.25.mov

@darrenburns
Copy link
Member

I agree it doesn't look great there! Maybe you're right 😄

@willmcgugan
Copy link
Collaborator Author

How about I hide it by default. And if a dev asks, they can unhide it?

@darrenburns
Copy link
Member

Seems like a reasonable compromise.

@willmcgugan
Copy link
Collaborator Author

Done. Can I get a 👍

@darrenburns
Copy link
Member

Could you add a snapshot test? After that it LGTM.

Copy link
Member

@darrenburns darrenburns left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@willmcgugan willmcgugan merged commit 68ba2e9 into main Aug 22, 2024
20 checks passed
@willmcgugan willmcgugan deleted the context-help branch August 22, 2024 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants