Skip to content

feat(clerk-js): Add signInMode to PricingTable #6154

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 1 commit into from
Jun 18, 2025

Conversation

aeliox
Copy link
Contributor

@aeliox aeliox commented Jun 18, 2025

Description

Adds signInMode prop ('redirect' or 'modal', defaults to 'redirect') to <PricingTable /> to allow configuring the sign in UX for unauthenticated end-users.

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Summary by CodeRabbit

  • New Features
    • Added a new option to the PricingTable component allowing you to configure the sign-in experience as either a modal or a redirect.
  • Chores
    • Updated internal types to support the new sign-in mode configuration.

@aeliox aeliox requested review from wobsoriano and a team as code owners June 18, 2025 17:59
Copy link

changeset-bot bot commented Jun 18, 2025

🦋 Changeset detected

Latest commit: ef90095

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@clerk/clerk-js Patch
@clerk/chrome-extension Patch
@clerk/clerk-expo Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link

vercel bot commented Jun 18, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
clerk-js-sandbox ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 18, 2025 6:00pm

Copy link
Contributor

coderabbitai bot commented Jun 18, 2025

📝 Walkthrough

Walkthrough

This change adds a new property called signInMode to the PricingTable component in the @clerk/clerk-js package. The signInMode prop allows configuration of the sign-in behavior, enabling either a modal sign-in flow or a redirect-based flow. Internally, the PricingTableRoot component now uses this property to determine whether to open a sign-in modal or redirect the user when signing in is required. Supporting type definitions were updated to include a SignInMode type and extend the pricing table context with the new property. No other components or APIs were modified.


📜 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 68ed585 and ef90095.

📒 Files selected for processing (3)
  • .changeset/little-lizards-hammer.md (1 hunks)
  • packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx (2 hunks)
  • packages/clerk-js/src/ui/types.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Build Packages
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (6)
packages/clerk-js/src/ui/types.ts (2)

57-57: LGTM! Well-defined type for sign-in mode configuration.

The SignInMode type properly defines the two expected values for the sign-in behavior configuration.


120-120: LGTM! Consistent integration with existing context pattern.

The signInMode property is properly added to the PricingTableCtx type, following the established pattern of optional properties in context types.

.changeset/little-lizards-hammer.md (1)

1-6: LGTM! Properly formatted changeset.

The changeset correctly documents the addition of the signInMode prop as a patch-level change with a clear description.

packages/clerk-js/src/ui/components/PricingTable/PricingTable.tsx (3)

12-12: LGTM! Proper integration with context and sensible default.

The destructuring correctly extracts the signInMode from context with a backward-compatible default value of 'redirect'.


45-48: LGTM! Clean conditional logic for sign-in mode handling.

The implementation correctly checks the user's authentication status first, then applies the appropriate sign-in method based on the configured mode. The logic flow is sound and maintains backward compatibility.


10-59: Verify test coverage for the new signInMode functionality.

The PR objectives mention that tests should be added, but no test files are included in this changeset. Please ensure that unit tests cover both sign-in modes ('modal' and 'redirect') to verify the correct behavior.

#!/bin/bash
# Description: Search for existing tests for the PricingTable component and verify coverage of signInMode

# Find test files related to PricingTable
fd -e test.ts -e test.tsx -e spec.ts -e spec.tsx | xargs rg -l "PricingTable"

# Search for existing tests that might need updates
rg -A 10 -B 5 "selectPlan|signIn" packages/clerk-js/src/ui/components/PricingTable/ || echo "No existing selectPlan tests found"

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

Copy link

pkg-pr-new bot commented Jun 18, 2025

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@6154

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@6154

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@6154

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@6154

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@6154

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@6154

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@6154

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@6154

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@6154

@clerk/express

npm i https://pkg.pr.new/@clerk/express@6154

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@6154

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@6154

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@6154

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@6154

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@6154

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@6154

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@6154

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@6154

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@6154

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@6154

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@6154

@clerk/types

npm i https://pkg.pr.new/@clerk/types@6154

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@6154

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@6154

commit: ef90095

@aeliox aeliox merged commit 0c9d8b3 into main Jun 18, 2025
66 of 67 checks passed
@aeliox aeliox deleted the keiran/com-952-pricing-table-signin-mode branch June 18, 2025 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants