feat: keyboard short cut #2418
Merged
feat: keyboard short cut #2418
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
added 7 commits
August 14, 2024 16:07
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 025e50b:
|
|
changelog 填填 |
| return { | ||
| ...super.adapter, | ||
| notifyClick: () => { | ||
| this.props.onClick(); |
| this.props.onClick(); | ||
| }, | ||
| getListenerTarget: () => { | ||
| return this.props.getListenerTarget(); |
|
|
||
| ### 不可用 | ||
|
|
||
| 设定 `disabled` 属性为 `true` |
There was a problem hiding this comment.
Suggested change
| 设定 `disabled` 属性为 `true` | |
| 设定 `disabled` 属性为 `true` 时，不监听 hotKeys。 |
| ``` | ||
| ### 基本 | ||
|
|
||
| 基本使用，通过`hotKeys`传入快捷键组合 |
There was a problem hiding this comment.
基本使用，通过hotKeys传入快捷键组合，通过 onClick 绑定快捷键处理函数，作出响应动作。
按下 Ctrl + Shift + A，使得 count + 1。默认在 body 监听，全局生效。
| | content | 设置显示内容 | string[] | - | | ||
| | onClick | 快捷键触发函数 | () => void | - | | ||
| | clickable | 设置函数是否可以点击触发 | boolean | false | | ||
| | render | 覆盖组件渲染 | () => ReactNode | | |
| ``` | ||
|
|
||
| ### 修改监听挂载DOM | ||
| 通过`getListenerTarget`修改快捷键监听挂载的DOM |
There was a problem hiding this comment.
快捷键默认在 body 监听，通过 getListenerTarget 修改快捷键监听挂载的 DOM。
| return; | ||
| } | ||
| if (keysPressed.every(Boolean)) { | ||
| event.preventDefault(); |
There was a problem hiding this comment.
preventDefault 的效果是怎么样的？
会导致其他同名快捷键（比如，ctrl+c）失效吗？如果是这样的话，建议在文档里说明。
如果与全局快捷键冲突，会导致全局快捷键不可用。建议不要占用全局的快捷键。
| const { hotKeys, content, onClick, clickable, disabled, render, getListenerTarget, className, style, ...rest } = this.props; | ||
|
|
||
| if (render !== null) { | ||
| return render(); |
There was a problem hiding this comment.
如果传入了一个 render，用户的 clickable 传入了 true 不生效是符合预期的吗？
…emi-design into feat/KeyboardShortCut
…emi-design into feat/KeyboardShortCut
semi-design
|
||||||||||||||||||||||||||||||
| Project |
semi-design
|
| Branch Review |
release
|
| Run status |
|
| Run duration | 09m 30s |
| Commit |
|
| Committer | 代强 |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
11
|
Skipped
|
0
|
Passing
|
272
|
Upgrade your plan to view test results. | |
| View all changes introduced in this branch ↗︎ | |
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.
中文模板 / Chinese Template
What kind of change does this PR introduce? (check at least one)
PR description
Changelog
🇨🇳 Chinese
🇺🇸 English
Checklist
Other
Additional information