Skip to content

feat: disable shortcut-key by default#430

Merged
kagol merged 1 commit intodevfrom
kagol/disable-shortcut-key-by-default
Jan 22, 2026
Merged

feat: disable shortcut-key by default#430
kagol merged 1 commit intodevfrom
kagol/disable-shortcut-key-by-default

Conversation

@kagol
Copy link
Member

@kagol kagol commented Jan 22, 2026

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Documentation

    • Added new documentation page with detailed description of shortcut menu capabilities.
    • Included interactive demo component demonstrating configuration and usage patterns.
    • Updated navigation sidebar with link to shortcut menu documentation section.
  • New Features

    • Introduced shortcut menu feature demo showing FluentEditor initialization and module configuration.

✏️ Tip: You can customize this high-level summary in your review settings.

@github-actions github-actions bot added the enhancement New feature or request label Jan 22, 2026
@kagol kagol merged commit a26f446 into dev Jan 22, 2026
1 check passed
@coderabbitai
Copy link

coderabbitai bot commented Jan 22, 2026

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces documentation and a demo for a new shortcut menu feature in FluentEditor. It adds a navigation sidebar entry, creates a demo Vue component that initializes the editor with the shortcut-key module enabled, provides documentation explaining the feature, and disables the shortcut-key toolbar binding in the Snow theme.

Changes

Cohort / File(s) Summary
Sidebar Navigation
packages/docs/fluent-editor/.vitepress/sidebar.ts
Added new navigation entry linking to the shortcut menu documentation page in the "使用示例" section.
Demo Component
packages/docs/fluent-editor/demos/shortcut-key.vue
New Vue 3 component demonstrating SSR-safe FluentEditor initialization with the shortcut-key module enabled and Snow theme applied.
Documentation
packages/docs/fluent-editor/docs/demo/shortcut-key.md
New documentation file explaining the shortcut menu feature (triggered with / on empty lines, navigation with arrows, selection with Enter) and embedding the demo component.
Theme Configuration
packages/fluent-editor/src/themes/snow.ts
Changed shortcut-key toolbar binding from true to false in OriginSnowTheme.DEFAULTS, disabling keyboard shortcuts in the toolbar.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A rabbit hops with glee,
New shortcuts dance so free!
With / keys and arrow's flight,
The menu shows its insight—
Sweet documentation shines so bright! ✨

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch kagol/disable-shortcut-key-by-default

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant