Improve words in hook API docs #1050
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
renovate bot
referenced
this pull request
in simonknittel/sinister-incorporated
Jan 11, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [react-hotkeys-hook](https://johannesklauss.github.io/react-hotkeys-hook/) ([source](https://togithub.com/JohannesKlauss/react-keymap-hook)) | [`4.4.1` -> `4.4.3`](https://renovatebot.com/diffs/npm/react-hotkeys-hook/4.4.1/4.4.3) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>JohannesKlauss/react-keymap-hook (react-hotkeys-hook)</summary> ### [`v4.4.3`](https://togithub.com/JohannesKlauss/react-hotkeys-hook/releases/tag/v4.4.3) [Compare Source](https://togithub.com/JohannesKlauss/react-keymap-hook/compare/v4.4.2...v4.4.3) ##### What's Changed - Call ignoreEventWhen callback only on hotkey matches by [@​LuanScudeler](https://togithub.com/LuanScudeler) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1096](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1096) - Fix CI (update triggers, format files) by [@​kachkaev](https://togithub.com/kachkaev) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1105](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1105) - fix: focus trap did not work for shadow root by [@​artchen-db](https://togithub.com/artchen-db) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1108](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1108) - chore(deps): update dependency typescript to v5.3.3 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1106](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1106) - chore(deps): update dependency [@​testing-library/user-event](https://togithub.com/testing-library/user-event) to v14.5.2 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1097](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1097) - chore(deps): update dependency tslib to v2.6.2 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1102](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1102) - chore(deps): update dependency [@​testing-library/react](https://togithub.com/testing-library/react) to v14.1.2 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1094](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1094) - chore(deps): update react monorepo by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1093](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1093) - chore(deps): update dependency [@​types/jest](https://togithub.com/types/jest) to v29.5.11 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1092](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1092) - chore(deps): update babel monorepo by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1091](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1091) ##### New Contributors - [@​artchen-db](https://togithub.com/artchen-db) made their first contribution in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1108](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1108) **Full Changelog**: JohannesKlauss/react-hotkeys-hook@v4.4.2...v4.4.3 ### [`v4.4.2`](https://togithub.com/JohannesKlauss/react-hotkeys-hook/releases/tag/v4.4.2) [Compare Source](https://togithub.com/JohannesKlauss/react-keymap-hook/compare/v4.4.1...v4.4.2) #### What's Changed - Improve words in hook API docs by [@​jrysana](https://togithub.com/jrysana) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1050](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1050) - chore(deps): update jest monorepo by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1053](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1053) - chore(deps): update react monorepo by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1054](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1054) - Tiny fix: correct name of enableScope/disableScope in README and test description. by [@​rewbs](https://togithub.com/rewbs) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1056](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1056) - chore(deps): update dependency [@​types/react](https://togithub.com/types/react) to v18.2.17 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1059](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1059) - chore(deps): update jest monorepo to v29.6.2 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1060](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1060) - Bump word-wrap from 1.2.3 to 1.2.4 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1055](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1055) - chore(deps): update dependency [@​types/react](https://togithub.com/types/react) to v18.2.18 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1061](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1061) - fix(deps): update dependency react-hotkeys-hook to v4.4.1 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1062](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1062) - chore(deps): update dependency [@​types/react](https://togithub.com/types/react) to v18.2.20 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1065](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1065) - fix(deps): update docusaurus monorepo to v2.4.1 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1066](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1066) - chore(deps): update dependency [@​types/react](https://togithub.com/types/react) to v18.2.21 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1071](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1071) - chore(deps): update jest monorepo by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1072](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1072) - chore(deps): update babel monorepo by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1075](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1075) - chore(deps): update dependency [@​testing-library/jest-dom](https://togithub.com/testing-library/jest-dom) to v5.17.0 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1076](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1076) - chore(deps): update jest monorepo by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1078](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1078) - chore(deps): update react monorepo by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1079](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1079) - chore(deps): update react monorepo by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1082](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1082) - fix(deps): update docusaurus monorepo to v2.4.3 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1083](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1083) - chore(deps): update react monorepo by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1084](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1084) - chore(deps): update babel monorepo to v7.23.2 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1085](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1085) - chore(deps): update dependency [@​types/jest](https://togithub.com/types/jest) to v29.5.6 by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1088](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1088) - chore(deps): update react monorepo by [@​renovate](https://togithub.com/renovate) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1089](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1089) - Fix: duplicate hotkey activiation by [@​brendanlaschke](https://togithub.com/brendanlaschke) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1080](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1080) - Bump postcss from 8.4.14 to 8.4.31 in /documentation by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1081](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1081) - Bump [@​babel/traverse](https://togithub.com/babel/traverse) from 7.18.0 to 7.23.2 in /documentation by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1086](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1086) - Fix repository link by [@​kachkaev](https://togithub.com/kachkaev) in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1103](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1103) #### New Contributors - [@​jrysana](https://togithub.com/jrysana) made their first contribution in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1050](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1050) - [@​rewbs](https://togithub.com/rewbs) made their first contribution in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1056](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1056) - [@​brendanlaschke](https://togithub.com/brendanlaschke) made their first contribution in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1080](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1080) - [@​kachkaev](https://togithub.com/kachkaev) made their first contribution in [https://github.com/JohannesKlauss/react-hotkeys-hook/pull/1103](https://togithub.com/JohannesKlauss/react-hotkeys-hook/pull/1103) **Full Changelog**: JohannesKlauss/react-hotkeys-hook@v4.4.1...v4.4.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/simonknittel/sinister-incorporated). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xMjcuMCIsInVwZGF0ZWRJblZlciI6IjM3LjEyNy4wIiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCJ9-->
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the wording a bit in the
useHotkeyssection of the API docs.