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: add support for keyboard shortcuts #65

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

lovelindhoni
Copy link
Contributor

  • Implemented most of the keyboard shortcuts specified in [RFC]: add support for keyboard shortcuts #26
  • Moved shortcuts prop and related methods to client.jsx
  • Made sure to not to overlap with the webaim keyboard shortcuts for web accessibility

Resolves #26 .

Checklist

Please ensure the following tasks are completed before submitting this pull request.

  • Read and understand the Code of Conduct.
  • Read and understood the licensing terms.
  • Searched for existing issues and pull requests before submitting this pull request.
  • Filed an issue (or an issue already existed) prior to submitting this pull request.
  • Rebased onto latest master.
  • Submitted against master branch.

Description

Adds various keyboard shortcuts to the stdlib documentation site.

Related Issues

Does this pull request have any related issues?

This pull request:

Questions

Any questions for reviewers of this pull request?

I thought keyboard shortcuts for package changelog would be too verbose. Any comments on my decision will be welcomed.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

To toggle through themes, use shift + a, as proposed b wouldn't make much sense if multiple themes were supported. Clicking shift + a cycles through the available themes, as I believed specifying modifiers each time would be overkill.


@stdlib-js/reviewers

- Implemented most of the keyboard shortcuts specified in stdlib-js#26
- Moved shortcuts prop and related methods to client.jsx
- Made sure to not to overlap with the webaim keyboard shortcuts for web accessibility
@kgryte
Copy link
Member

kgryte commented Mar 18, 2024

@lovelindhoni Thanks for submitting this PR. To help with review, can you remove built file changes? The inclusion of those changes just creates diff noise and runs the risk of out-of-date build artifacts as we iterate during PR review. Once this PR is merged, we'll rebuild the site locally to include the proposed changes and push to GitHub.

- Implemented most of the keyboard shortcuts specified in stdlib-js#26
- Moved shortcuts prop and related methods to client.jsx
- Made sure to not to overlap with the webaim keyboard shortcuts for web accessibility
@lovelindhoni
Copy link
Contributor Author

Apologies @kgryte, I have removed the built file changes and created a new commit

@lovelindhoni
Copy link
Contributor Author

@kgryte is there any other changes that needs to be done?

@kgryte
Copy link
Member

kgryte commented Mar 21, 2024

I'll need to pull down and play around. Likely won't be until this weekend that I'll get a chance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[RFC]: add support for keyboard shortcuts
2 participants