Skip to content

feat(qr-code): Add the necessary attributes to the responsive #3456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 26, 2025

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented May 24, 2025

feat(qr-code): 将必要的属性,添加响应式

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • 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
  • 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: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features

    • Added a button to dynamically change the QR code color in the demo examples, allowing users to interactively update the QR code appearance.
  • Bug Fixes

    • Improved responsiveness of the QR code component to changes in color, style, size, icon, and border properties for a smoother user experience.

Copy link

coderabbitai bot commented May 24, 2025

Walkthrough

The changes introduce a button to dynamically change the QR code color in two Vue demo files and update the QR code rendering logic to react to additional property changes. The QR code component now responds to color and other property updates, enabling interactive customization in the demos.

Changes

File(s) Change Summary
examples/sites/demos/pc/app/qr-code/style-composition-api.vue Added a button to change QR code color; made params reactive; introduced changeColor method.
examples/sites/demos/pc/app/qr-code/style.vue Added a button to change QR code color; registered TinyButton; added changeColor method to update color.
packages/renderless/src/qr-code/vue.ts Expanded watch dependencies in renderless to include color, style, size, icon, iconSize, and bordered props.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Button ("改变颜色")
    participant VueComponent
    participant QRCode

    User->>Button: Click "改变颜色"
    Button->>VueComponent: Trigger changeColor()
    VueComponent->>QRCode: Update color property
    QRCode->>QRCode: React to color change, redraw QR code
Loading

Poem

A button appears, a color anew,
With a click, QR codes change their hue!
Reactive and bright, the demos now gleam,
Watch dependencies join the theme.
Hop, hop, hooray—
For color that changes the QR way!
🐇✨

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.

packages/renderless/src/qr-code/vue.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-dev

The 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.


📜 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 e50552f and 1d78329.

📒 Files selected for processing (1)
  • packages/renderless/src/qr-code/vue.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/renderless/src/qr-code/vue.ts
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
✨ 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.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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.

@github-actions github-actions bot added the enhancement New feature or request (功能增强) label May 24, 2025
Copy link

Walkthrough

This PR introduces responsive attributes to the QR code component, enhancing its functionality by adding a button to change the QR code color dynamically. The changes involve updates to the demo files and the core QR code rendering logic to support additional properties.

Changes

Files Summary
examples/sites/demos/pc/app/qr-code/style-composition-api.vue, examples/sites/demos/pc/app/qr-code/style.vue Added a button to change QR code color and updated the component to use TinyButton.
packages/renderless/src/qr-code/vue.ts Updated the watch function to include new properties like color, style, size, icon, iconSize, and bordered.

})

const changeColor = () => {
params.value.color = '#666'

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The line params.value.color = '#666' seems to be incorrect. It should be params.value.color instead of params.color. Please verify the correct property path.

},
methods: {
changeColor() {
this.params.color = '#666'

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The line this.params.color = '#666' seems to be incorrect. It should be this.params.color instead of this.params.color. Please verify the correct property path.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🔭 Outside diff range comments (1)
packages/renderless/src/qr-code/vue.ts (1)

23-39: ⚠️ Potential issue

Fix duplicate property in watch array.

The expanded watch dependencies correctly enable QR code responsiveness to additional properties, which aligns well with the PR objectives. However, props.level is included twice in the array (lines 25 and 31).

Apply this diff to remove the duplicate:

 watch(
   () => [
     props.level,
     props.value,
     props.color,
     props.style,
     props.size,
     props.icon,
-    props.level,
     props.iconSize,
     props.bordered
   ],
   () => {
     api.draw()
     api.change()
   }
 )
🧹 Nitpick comments (2)
examples/sites/demos/pc/app/qr-code/style.vue (1)

29-33: Consider making color changes more dynamic.

The changeColor method correctly demonstrates the responsive behavior. For enhanced demo experience, consider cycling through multiple colors instead of a single hardcoded value.

Optional enhancement to cycle through multiple colors:

+  data() {
+    return {
+      params: { /* existing params */ },
+      colorIndex: 0,
+      colors: ['#1677ff', '#666', '#ff4d4f', '#52c41a', '#faad14']
+    }
+  },
   methods: {
     changeColor() {
-      this.params.color = '#666'
+      this.colorIndex = (this.colorIndex + 1) % this.colors.length
+      this.params.color = this.colors[this.colorIndex]
     }
   }
examples/sites/demos/pc/app/qr-code/style-composition-api.vue (1)

15-24: LGTM! Correct reactive reference implementation.

The conversion of params to a ref() and accessing the color via params.value.color in the changeColor function correctly implements Vue 3 composition API patterns.

Similar to the options API version, consider making the color changes more dynamic:

+const colorIndex = ref(0)
+const colors = ['#1677ff', '#666', '#ff4d4f', '#52c41a', '#faad14']
+
 const changeColor = () => {
-  params.value.color = '#666'
+  colorIndex.value = (colorIndex.value + 1) % colors.length
+  params.value.color = colors[colorIndex.value]
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1886a5d and e50552f.

📒 Files selected for processing (3)
  • examples/sites/demos/pc/app/qr-code/style-composition-api.vue (1 hunks)
  • examples/sites/demos/pc/app/qr-code/style.vue (2 hunks)
  • packages/renderless/src/qr-code/vue.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (4)
examples/sites/demos/pc/app/qr-code/style.vue (2)

1-9: LGTM! Clean template structure for interactive demo.

The template changes effectively demonstrate the QR code responsiveness feature with a clear container structure and interactive button.


12-17: LGTM! Proper component imports and registration.

The TinyButton component is correctly imported and registered alongside TinyQrCode.

examples/sites/demos/pc/app/qr-code/style-composition-api.vue (2)

1-9: LGTM! Consistent template structure across API styles.

The template structure matches the options API version perfectly, providing consistent demo experience across different Vue API styles.


12-13: LGTM! Proper imports for composition API.

The imports correctly include TinyButton and ref from Vue for the composition API approach.

@zzcr zzcr merged commit 4915636 into dev May 26, 2025
9 of 10 checks passed
@zzcr zzcr deleted the fix-qr-code-issue-0524 branch May 26, 2025 06:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request (功能增强)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 [Bug]:【Component】【TinyQrCode】dynamic change color value does not have effect
2 participants