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

docs(shortcuts): add example usage for arrow keys #859

Merged
merged 2 commits into from Oct 26, 2023

Conversation

brycecammo
Copy link
Contributor

@brycecammo brycecammo commented Oct 24, 2023

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Added example usage for arrow keys in the keyboard shortcuts section of the docs (after spending a bit too long yesterday trying to figure out the correct syntax).

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

(This is my first time creating a PR - let me know if I've done something wrong!)

@vercel
Copy link

vercel bot commented Oct 24, 2023

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Updated (UTC)
ui βœ… Ready (Inspect) Visit Preview Oct 26, 2023 4:13am

Copy link
Contributor

smarroufin commented Oct 25, 2023

Hi @brycecammo!

Thanks for the update, indeed the initial shortcuts doc lacks detail 😬
Your example is good. And if I may, in addition I would suggest displaying a more generic message to help others find the shortcut key they need, something like this after the list 🀷 :

::callout
To find out the appropriate shortcut key, please refer to the [`KeyboardEvent`](https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values). The `KeyboardEvent.key` has to be written in lower case.
::

Feel free to improve my phrasing, it might not be that clear for everybody πŸ˜…

@brycecammo
Copy link
Contributor Author

Good idea @smarroufin! I've updated with your suggestion.

Copy link
Contributor

@smarroufin smarroufin left a comment

Choose a reason for hiding this comment

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

LGTM πŸ™

@benjamincanac benjamincanac merged commit 68f024f into nuxt:dev Oct 26, 2023
1 check passed
@benjamincanac
Copy link
Member

Thanks 😊

@brycecammo brycecammo deleted the docs/shortcuts-arrow-key-example branch October 26, 2023 08:51
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.

None yet

3 participants