feat: shortcut key for saving #951
Conversation
WalkthroughThis pull request introduces a new Changes
Sequence DiagramsequenceDiagram
participant User
participant Editor
participant Component
User->>Editor: Press Ctrl/Cmd + S
Editor->>Component: Emit shortcutSave event
Component->>Component: Trigger save method
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
added
enhancement
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/common/component/VueMonaco.vue (1)
98-102: Keybinding approach is correct
Providing the Ctrl/Command + S command for saving is a clean, straightforward approach. Consider adding a brief comment noting that it overrides the default browser behavior, ensuring future maintainers understand why it’s implemented this way.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
packages/common/component/MonacoEditor.vue(2 hunks)packages/common/component/VueMonaco.vue(2 hunks)packages/plugins/schema/src/Main.vue(1 hunks)packages/plugins/script/src/Main.vue(1 hunks)
🔇 Additional comments (5)
packages/plugins/script/src/Main.vue (1)
23-23: Shortcut event binding looks good!
The added @shortcutSave="saveMethods" correctly hooks up the keyboard shortcut to the existing save logic, improving the user experience by providing a more intuitive save flow.
packages/common/component/MonacoEditor.vue (2)
31-31: Clean event emission for shortcutSave
Emitting "shortcutSave" in this context ensures that the parent components can easily hook into the saving functionality. The syntax is concise and aligned with the Vue event emission pattern.
64-64: Updated emits array is correct
Including "shortcutSave" in the emits array clarifies the component's contract and prevents warnings about undeclared events.
packages/common/component/VueMonaco.vue (1)
46-46: Emits declaration updated to include shortcutSave
Properly adding "shortcutSave" to emits helps comply with Vue’s best practices for custom events.
packages/plugins/schema/src/Main.vue (1)
29-29: Shortcut event binding for schema saving
Binding @shortcutSave to saveSchema is consistent with the newly introduced shortcut save functionality across the editor components. This improves consistency and user convenience.
English | 简体中文
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
Background and solution
What is the current behavior?
按下快捷键 ctrl + s，调出了浏览器的默认保存。
Issue Number: N/A
What is the new behavior?
按下快捷键 ctrl + s，执行保存按钮的逻辑。
其他需要快捷键保存的地方也可以通过监听事件执行。
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit
New Features
shortcutSaveevent for the Monaco Editor, allowing users to save their work using keyboard shortcuts (Ctrl+S or Command+S).shortcutSaveevent with thesaveSchemamethod.shortcutSaveevent in the editor's main component.Bug Fixes
Documentation
shortcutSave.