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

feat($plugin-search): Add support for search hotkeys #1848

Merged
merged 7 commits into from
Sep 12, 2019

Conversation

evaera
Copy link
Contributor

@evaera evaera commented Sep 10, 2019

Summary

Adds hotkey to focus SearchBox component with configurable keys, defaulting to s and /.

This makes it much easier to switch to the docs and focus the searchbox when using documentation in tandem with programming. Sites like docs.rs and even GitHub itself support this behavior.

Fixes #624

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

@evaera evaera changed the title fix #624 - Add support for search hotkeys fix: #624 - Add support for search hotkeys Sep 10, 2019
@kefranabg kefranabg changed the title fix: #624 - Add support for search hotkeys feat($plugin-search): Add support for search hotkeys Sep 10, 2019
Copy link
Collaborator

@kefranabg kefranabg left a comment

Choose a reason for hiding this comment

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

Nice job @evaera 💪

@flozero
Copy link
Collaborator

flozero commented Sep 10, 2019

Hello thank's for your work ! Can please add the event on function and destroy the event on the lifecycle beforeDestroy please

@flozero flozero added need feedback Awaiting author response type: enhancement Request to enhance an existing feature version: 1.x Relates to version 1 of VuePress labels Sep 10, 2019
@evaera
Copy link
Contributor Author

evaera commented Sep 11, 2019

@f3ltron Yes, it's been updated.

@kefranabg kefranabg merged commit 1ba06ae into vuejs:master Sep 12, 2019
@vue-bot
Copy link

vue-bot commented Sep 12, 2019

Hey @evaera, thank you for your time and effort spent on this PR, contributions like yours help make Vue better for everyone. Cheers! 💚

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need feedback Awaiting author response type: enhancement Request to enhance an existing feature version: 1.x Relates to version 1 of VuePress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] Search input autofocus or keyboard shortcut
4 participants