tiny-engine icon indicating copy to clipboard operation
tiny-engine copied to clipboard

refactor:The plugin width is persisted using vueuse.

Open STATICHIT opened this issue 1 year ago • 1 comments

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
  • [ ] Feature
  • [ ] Code style update (formatting, local variables)
  • [x] Refactoring (no functional changes, no api changes)
  • [ ] Build related changes
  • [ ] CI related changes
  • [ ] Documentation content changes
  • [ ] Other... Please describe:

Background and solution

The plugin width is persisted using vueuse.

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

    • Enhanced management of plugin widths with a more streamlined approach using function calls for better performance.
    • Introduced storage persistence for plugin widths across sessions.
  • Bug Fixes

    • Improved clarity and maintainability in the layout management process.
  • Documentation

    • Updated comments and documentation to reflect changes in the width retrieval methods and their impact on the UI.
  • Style

    • Consolidated attributes in the plugin-panel component for improved readability and cleaner code structure.

STATICHIT avatar Aug 11 '24 17:08 STATICHIT

Walkthrough

The recent updates streamline plugin width management across various components, shifting from a reactive property approach to a more functional style. This transition enhances performance, clarity, and maintainability by introducing new functions for width retrieval and modification. Overall, these changes refine layout handling, leading to a more efficient and cohesive user interface experience.

Changes

Files Change Summary
.../common/component/PluginPanel.vue Updated to use getPluginWidth for direct width retrieval, removing the watch on pluginWidth. Simplified panelWidth logic.
.../controller/src/useLayout.js Introduced useStorage for persistent pluginWidth. Added getPluginWidth and changePluginWidth for structured width management.
.../plugins/bridge/src/BridgeSetting.vue Replaced destructured pluginWidth with getPluginWidth, simplifying width retrieval for the 'Bridge' plugin.
.../plugins/data/src/Main.vue Shifted from pluginWidth to getPluginWidth for improved width handling.
.../plugins/datasource/src/DataSourceForm.vue Updated to use getPluginWidth for calculating leftMargin, enhancing width retrieval method.
.../plugins/datasource/src/DataSourceGlobalDataHandler.vue Replaced pluginWidth with getPluginWidth for improved clarity in width access.
.../plugins/datasource/src/DataSourceRecordList.vue Transitioned to getPluginWidth for width retrieval, maintaining existing functionality.
.../plugins/datasource/src/DataSourceRemotePanel.vue Updated leftMargin calculation to utilize getPluginWidth, changing the width access mechanism.
.../plugins/page/src/PageFolderSetting.vue Replaced pluginWidth with getPluginWidth for dynamic width retrieval in the AppManage plugin.
.../plugins/page/src/PageSetting.vue Shifted to getPluginWidth for width access, improving the method of calculating leftMargin.
.../settings/events/src/Main.vue Consolidated plugin-panel attributes for readability, changed :fixed-name from PLUGIN_NAME.Event to SETTING_NAME.Event.
package.json Added a new dependency @vueuse/core with version ^9.6.0 to enhance project capabilities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MainComponent
    participant LayoutManager

    User->>MainComponent: Interacts with plugin
    MainComponent->>LayoutManager: Calls getPluginWidth()
    LayoutManager-->>MainComponent: Returns width
    MainComponent->>User: Updates UI based on width

🐇 In the meadow, a rabbit did say,
"With widths so neat, I hop and I play!
Oh, plugins so spry, with margins so wide,
Thanks to the change, there’s joy in my stride!
Let's leap for the code, so tidy and bright,
A hop and a skip in the soft moonlight!" 🌙✨


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?

Share
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>.
    • 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 @coderabbitai in 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 @coderabbitai in 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.

coderabbitai[bot] avatar Aug 11 '24 17:08 coderabbitai[bot]