tiny-vue
tiny-vue copied to clipboard
feat(components): [drawer] enable open event
PR
PR Checklist
Please check if your PR fulfills the following requirements:
- [x] The commit message follows our Commit Message Guidelines
- [x] Tests for the changes have been added (for bug fixes / features)
- [x] 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: #1387
What is the new behavior?
Does this PR introduce a breaking change?
- [ ] Yes
- [x] No
Other information
[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
Walkthrough
The recent updates introduce an open event to the drawer component, ensuring consistent event type definitions and enhancing the Vue components and test cases to support this new functionality. This includes updating multiple files to handle the open event, adding new Vue components and tests, and ensuring descriptions are available in multiple languages.
Changes
| File Path | Change Summary |
|---|---|
examples/sites/demos/apis/drawer.js |
Added open event with multi-language descriptions and device modes, updated close and confirm event type definitions. |
examples/sites/demos/pc/app/drawer/open-event-composition-api.vue |
Introduced Vue component with a button to trigger the open event in a drawer. |
examples/sites/demos/pc/app/drawer/open-event.spec.ts |
Added a Playwright test case for the open event in a drawer. |
examples/sites/demos/pc/app/drawer/open-event.vue |
Added Vue component with button to trigger the open event in a drawer. |
examples/sites/demos/pc/app/drawer/webdoc/drawer.js |
Added demo object for open-event with descriptions in Chinese and English. |
packages/renderless/src/drawer/index.ts |
Modified watchToggle function to emit open event when bool is true. |
packages/vue/src/drawer/src/pc.vue |
Added emits property with 'update:visible', 'open', 'close', and 'confirm' events. |
Sequence Diagram(s) (Beta)
sequenceDiagram
participant User
participant Button
participant Drawer
participant Modal
User ->> Button: Click 'Open Drawer'
Button ->> Drawer: Set visible to true
Drawer ->> Drawer: Emit 'update:visible'
Drawer ->> Drawer: Emit 'open'
Drawer ->> Modal: Show message 'Drawer Opened'
In code, the changes flow,
New events make the drawer glow.
Buttons click, drawers swing wide,
Messages displayed with pride.
In Vue, the tests align,
Code and docs in perfect line.
🐇✨
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?
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
@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 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.
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 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 full the review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai helpto get help.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configration 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.