feat(config-provider): [config-provider] 支持合并主题配置
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)
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:
What is the current behavior?
Issue Number: #3086
What is the new behavior?
Does this PR introduce a breaking change?
- [ ] Yes
- [x] No
Other information
Summary by CodeRabbit
- New Features
- Introduced an interactive configuration interface that supports nested theme customization with dynamic form validation and enhanced design merging for a seamless user experience.
- Tests
- Added comprehensive UI tests to ensure reliable event handling, proper form interactions, and responsive button behavior.
- Chores
- Updated package metadata and dependency management for better module compatibility and streamlined integration.
Walkthrough
The changes add new Vue components in the demos for a configuration provider that supports nested theme configurations using Tiny UI components. Both Composition API and classic export styles are introduced with reactive form handling and validation. A new Playwright test verifies custom events and UI behavior. The documentation is updated with a new demo entry, the utilities module now includes a deep merge function, and the Vue config-provider package metadata and design configuration logic are updated to merge parent and child design settings.
Changes
| File(s) | Change Summary |
|---|---|
examples/sites/demos/pc/app/config-provider/merge-composition-api.vue, examples/sites/demos/pc/app/config-provider/merge.vue |
New Vue component(s) added for theme configuration. Both files implement nested tiny-config-provider usage with forms, reactive variables, and validation methods (handleSubmitPromise in the Composition API version and a similar method in the default export version). |
examples/sites/demos/pc/app/config-provider/merge.spec.ts |
New Playwright test file added to verify custom events, modal content, form visibility, and button state management. |
examples/sites/demos/pc/app/config-provider/webdoc/config-provider.js |
New demo entry added with demoId: 'merge' along with localized names and descriptions; references merge.vue in the codeFiles array. |
packages/utils/src/index.ts, packages/utils/src/object/index.ts |
Updated the object module to export a new deepMerge function which performs recursive merging of objects, while preserving the existing shallow merge functionality. |
packages/vue/src/config-provider/package.json |
Updated package metadata by adding "type": "module", "license": "MIT", and "sideEffects": false; added dependency on "@opentiny/utils" and reintroduced devDependencies. |
packages/vue/src/config-provider/src/index.vue |
Modified design configuration handling: now injects a parent design using design as designSymbol and merges it with the component’s own design using deepMerge, then provides the merged design via provideDesignConfig. |
Sequence Diagram(s)
sequenceDiagram
participant U as User
participant C as ConfigProviderComponent
participant H as handleSubmitPromise
participant V as Validator
participant A as Alert Component
U->>C: Fill in form fields (name, age)
U->>C: Click Submit
C->>H: Trigger form submission
H->>V: Validate form data
V-->>H: Return validation result
H->>A: Trigger alert feedback
A-->>U: Display notification
sequenceDiagram
participant C as ConfigProvider Component
participant I as Injector (hooks.inject)
participant D as deepMerge Function
participant P as provideDesignConfig
C->>I: Inject parent design via designSymbol
I-->>C: Return parentDesign (or empty object)
C->>D: Merge parentDesign with child design prop
D-->>C: Return merged currentDesign
C->>P: Provide merged design configuration
Suggested labels
enhancement
Suggested reviewers
- zzcr
Poem
I'm just a hopping rabbit, coding with delight,
Nesting themes and forms to keep the design bright.
I merge and validate with a twitch of my ear,
Deep merging objects, making intentions clear.
Hoppity-code, I celebrate these changes with cheer!
[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.
🔧 ESLint
If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.
examples/sites/demos/pc/app/config-provider/merge.spec.ts
Oops! Something went wrong! :(
ESLint: 8.57.1
ESLint couldn't find the plugin "eslint-plugin-vue".
(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)
It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:
npm install eslint-plugin-vue@latest --save-devThe plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".
If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.
examples/sites/demos/pc/app/config-provider/merge-composition-api.vue
Oops! Something went wrong! :(
ESLint: 8.57.1
ESLint couldn't find the plugin "eslint-plugin-vue".
(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)
It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:
npm install eslint-plugin-vue@latest --save-devThe plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".
If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.
examples/sites/demos/pc/app/config-provider/merge.vue
Oops! Something went wrong! :(
ESLint: 8.57.1
ESLint couldn't find the plugin "eslint-plugin-vue".
(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)
It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:
npm install eslint-plugin-vue@latest --save-devThe plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".
If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.
- 4 others
✨ 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.
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 resolveresolve all the CodeRabbit review comments.@coderabbitai planto trigger planning for file edits and PR creation.@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.
[e2e-test-warn] The component to be tested is missing.
The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".
Please make sure you've read our contributing guide
@hashiqi12138 代码有冲突哈
Bot detected the issue body's language is not English, translate it automatically.
@hashiqi12138 There is a conflict in the code