feat: add plugin panel displays or hides plugin
English | 简体中文
PR
PR Checklist
Please check if your PR fulfills the following requirements:
- [x] 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)
- [ ] Built its own designer, fully self-validated
PR Type
What kind of change does this PR introduce?
- [ ] Bugfix
- [x] 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:
Background and solution
What is the current behavior?
目前不支持插件面板的显示与隐藏
Issue Number: N/A
What is the new behavior?
支持插件面板的显示与隐藏
入口:点击右上角 ... 按钮
步骤:点击按钮,展示左侧面板和右侧面板,悬浮对应的面板,展示对应侧的面板列表
Does this PR introduce a breaking change?
- [ ] Yes
- [x] No
Other information
Summary by CodeRabbit
- New Features
- Introduced a toolbar toggle feature enabling users to show or hide plugins via a dedicated button.
- Added a dropdown menu for managing visibility of left and right side panel plugins with individual toggles.
- Enhancements
- Enhanced toolbar with a plugin toggle button for streamlined plugin management.
- Improved UI with visual indicators reflecting active plugin states.
Walkthrough
This update introduces a new toolbar plugin called PluginToggle to the project. The plugin is implemented as a Vue component with supporting composable logic, metadata, and styles, and is packaged as @opentiny/tiny-engine-toolbar-plugin-toggle. Integration occurs across the codebase: the plugin is registered in the toolbar configuration, exported via the design core package, and made available through aliasing in both development and TypeScript configurations. The plugin provides a UI for toggling the visibility of left and right panel plugins, with dropdown menus and submenu interactions.
Changes
| File(s) | Change Summary |
|---|---|
designer-demo/registry.js |
Added PluginToggle to imports, toolbar configuration, and exports. |
packages/design-core/index.js |
Re-exported PluginToggle from the new toolbar plugin package. |
packages/design-core/package.json |
Added @opentiny/tiny-engine-toolbar-plugin-toggle as a dependency. |
packages/build/vite-config/src/vite-plugins/devAliasPlugin.jstsconfig.app.json |
Added alias for @opentiny/tiny-engine-toolbar-plugin-toggle for dev and TypeScript. |
packages/layout/src/Main.vue |
Added title property to plugin objects in setup function. |
packages/toolbars/plugin-toggle/index.tsmeta.jssrc/Main.vuesrc/composable/index.tsvite.config.ts |
Introduced new toolbar plugin: entry file, metadata, Vue component, composable, and Vite config. |
packages/toolbars/plugin-toggle/package.json |
New package declaration for the toolbar plugin. |
Sequence Diagram(s)
sequenceDiagram
participant User as User
participant Toolbar as PluginToggle Toolbar
participant PluginMenu as Plugin Menu
participant Layout as Layout API
User->>Toolbar: Clicks PluginToggle button
Toolbar->>PluginMenu: Show dropdown menu
User->>PluginMenu: Hover left/right panel item
PluginMenu->>PluginMenu: Show submenu with plugins
User->>PluginMenu: Clicks a plugin item
PluginMenu->>Layout: Toggle plugin visibility
Layout-->>PluginMenu: Update state
PluginMenu-->>Toolbar: Update menu/checkmark
Poem
🐇
A toggle appears in the toolbar bright,
With menus that open, left and right.
Plugins now dance at a rabbit’s command,
Hide or reveal them with a gentle hand.
In dropdowns and submenus, features abound—
Hopping with joy, new toggles are found!
🥕
📜 Recent review details
Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro
📥 Commits
Reviewing files that changed from the base of the PR and between 6dc460a522522255a783e66c49b4766ad287aea6 and 16527b31fbc32e24ff0384e0ed0b754f8bf68d7c.
📒 Files selected for processing (1)
packages/toolbars/plugin-toggle/vite.config.ts(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/toolbars/plugin-toggle/vite.config.ts
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: push-check
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
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.
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
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)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.