opentiny / tiny-engine

TinyEngine is a low-code engine based on which you can build or develop low-code platforms in different domains/TinyEngine是一个低代码引擎,基于这个引擎可以构建或者开发出不同领域的低代码平台
https://opentiny.design/tiny-engine
MIT License
1.96k stars 303 forks source link

feat: support building customized canvas entry #846

Closed yy-wow closed 1 month ago

yy-wow commented 1 month ago

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?

Issue Number: N/A

What is the new behavior?

  1. 工具栏-保存增加beforeSave、saveMethod、saved钩子;
  2. 工具栏-预览增加beforePreview、previewMethod、afterPreview钩子;
  3. 画布iframe支持配置src替换默认的srcdoc,支持自定义的画布页面构建入口;
  4. 导出获取组件condition值的方法

Does this PR introduce a breaking change?

Other information

Summary by CodeRabbit

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces several modifications across multiple Vue components, focusing on handling canvas source properties and enhancing rendering logic. Key changes include renaming the canvasUrl property to canvasSrc, adding a new canvasSrcDoc property, and updating the iframe rendering logic in CanvasContainer.vue. Additionally, new functions and imports related to getOptions are added across various components, improving asynchronous handling of operations like saving and previewing. The overall structure of the components remains intact while enhancing their interactivity and functionality.

Changes

File Path Change Summary
packages/canvas/DesignCanvas/src/DesignCanvas.vue - Renamed variable: canvasUrlcanvasSrc
- Added new variable: canvasSrcDoc
- Updated initialization logic for canvasSrc and canvasSrcDoc
packages/canvas/container/src/CanvasContainer.vue - Modified template to conditionally render <iframe> based on canvasSrc
- Added new prop: canvasSrcDoc
packages/canvas/index.js - Added import for createRender
- Updated exports to include createRender
packages/canvas/render/src/RenderMain.js - Added new function: getCondition
- Added new function: getConditions
- Modified setCondition to include a new parameter
packages/canvas/render/src/context.js - Added new exported function: getCondition to return visibility state
- Added new exported function: getConditions to return the entire conditions object
packages/canvas/render/src/runner.js - Updated import to exclude h from Vue
- Modified create function to exclude h from parameters passed to beforeAppCreate
packages/settings/events/src/components/BindEventsDialog.vue - Updated confirm method to be asynchronous
- Added import for getOptions
packages/toolbars/preview/src/Main.vue - Updated preview function to be asynchronous
- Added import for getOptions
packages/toolbars/save/src/Main.vue - Updated openApi function to include loading state check
- Added import for getOptions
packages/toolbars/save/src/js/index.js - Added import for getOptions
- Enhanced openCommon and saveCommon functions with pre-save and post-save logic

Possibly related PRs

Suggested labels

ospp-2024

Suggested reviewers

🐰 In the canvas where colors blend,
A new src and doc we now send.
With iframes that dance, and props that gleam,
Our code is now a vibrant dream!
So hop along, let’s celebrate,
For changes here are truly great! 🎨✨


📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between 7ba362cd6dd2bd259571081a290802fa01c7ad47 and 070e92d23807c7d8b0aaa4327d31efa0583f5cfb.
📒 Files selected for processing (1) * packages/canvas/index.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * packages/canvas/index.js
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 `@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 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.` 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 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.