Skip to content

Conversation

ymind
Copy link

@ymind ymind commented Sep 4, 2025

当 CodeLogin 和 QrcodeLogin 组件单独使用的时候会非常有用,比如有的场景下只需要短信登录。

具体修改如下:

  • 在 CodeLogin 和 QrcodeLogin 组件中添加 showBack 属性
  • 根据 showBack 属性决定是否显示返回按钮
  • 默认值为 true,即默认显示返回按钮

Description

Type of change

  • New feature (non-breaking change which adds functionality)

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features
    • Added the ability to hide the Back button on the Code Login and QR Code Login screens.
    • Back button remains visible by default; apps can opt to hide it when needed.
    • No changes required for existing implementations; default behavior is unchanged.

- 在 CodeLogin 和 QrcodeLogin 组件中添加 showBack 属性
- 根据 showBack 属性决定是否显示返回按钮
- 默认值为 true,即默认显示返回按钮
Copy link

changeset-bot bot commented Sep 4, 2025

⚠️ No Changeset found

Latest commit: 7230a54

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Sep 4, 2025

Walkthrough

Adds an optional showBack boolean prop (default true) to two authentication UI components. The back button is now conditionally rendered based on this prop; previously it was always shown. No other logic changes.

Changes

Cohort / File(s) Summary of changes
Auth login UI components
packages/effects/common-ui/src/ui/authentication/code-login.vue, packages/effects/common-ui/src/ui/authentication/qrcode-login.vue
Add optional prop showBack?: boolean with default true; update templates to render back button only when showBack is true; no changes to navigation/handler logic.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Consumer
  participant CodeLogin as CodeLogin component
  participant QRLogin as QrCodeLogin component
  Consumer->>CodeLogin: mount(showBack = true/false)
  Note over CodeLogin: If showBack === true, render Back button<br/>Else, hide Back button
  Consumer->>QRLogin: mount(showBack = true/false)
  Note over QRLogin: If showBack === true, render Back button<br/>Else, hide Back button
  Consumer->>CodeLogin: click Back (if visible)
  CodeLogin-->>Consumer: trigger existing go-to-login flow
  Consumer->>QRLogin: click Back (if visible)
  QRLogin-->>Consumer: trigger existing go-to-login flow
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A button hops back, then chooses to stay,
With showBack true, it leads the way.
When false, it hides—so calm, so sly,
Two forms aligned beneath one sky.
I twitch my ears, approve the knack—
Optional trails for hopping back. 🐰✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit 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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

Copy link
Contributor

@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

🧹 Nitpick comments (4)
packages/effects/common-ui/src/ui/authentication/code-login.vue (2)

38-41: Prop addition and default value are solid; preserves backward compatibility.

Adding showBack with a default of true mirrors previous behavior (back button always visible). Consider documenting the default in the JSDoc for consistency with other props.

Apply:

   /**
    * @zh_CN 是否显示返回按钮
+   * @default true
    */
   showBack?: boolean;

Also applies to: 50-50


118-121: Let parents intercept “back” and avoid accidental form submissions.

  • Emit a back event before routing so hosts can override or track navigation.
  • Set the button type="button" to avoid unintended form submits if rendered inside a form.
-const emit = defineEmits<{
-  submit: [Recordable<any>];
-}>();
+const emit = defineEmits<{
+  submit: [Recordable<any>];
+  back: [];
+}>();

-function goToLogin() {
-  router.push(props.loginPath);
-}
+function goToLogin() {
+  emit('back');
+  if (props.loginPath) router.push(props.loginPath);
+}
-    <VbenButton v-if="showBack" class="mt-4 w-full" variant="outline" @click="goToLogin()">
+    <VbenButton
+      v-if="showBack"
+      class="mt-4 w-full"
+      variant="outline"
+      type="button"
+      @click="goToLogin"
+    >
packages/effects/common-ui/src/ui/authentication/qrcode-login.vue (2)

38-41: Consistent API: showBack prop with a default of true looks good.

Matches code-login.vue and keeps existing UX by default. Consider documenting the default in the JSDoc.

   /**
    * @zh_CN 是否显示返回按钮
+   * @default true
    */
   showBack?: boolean;

Also applies to: 51-51


67-69: Expose a cancellable “back” hook and harden the button behavior.

  • Emit a back event before routing to allow parent interception.
  • Add type="button" and prefer @click="goToLogin" (no parens) for consistency.
+const emit = defineEmits<{
+  back: [];
+}>();
-function goToLogin() {
-  router.push(props.loginPath);
-}
+function goToLogin() {
+  emit('back');
+  if (props.loginPath) router.push(props.loginPath);
+}
-    <VbenButton v-if="showBack" class="mt-4 w-full" variant="outline" @click="goToLogin()">
+    <VbenButton
+      v-if="showBack"
+      class="mt-4 w-full"
+      variant="outline"
+      type="button"
+      @click="goToLogin"
+    >

Also applies to: 96-99

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 6a85b3a and 7230a54.

📒 Files selected for processing (2)
  • packages/effects/common-ui/src/ui/authentication/code-login.vue (3 hunks)
  • packages/effects/common-ui/src/ui/authentication/qrcode-login.vue (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: post-update (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant