Skip to content

chore(clerk-js,types): Display info tooltip for past due amounts in checkout #6097

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 3 commits into from
Jun 10, 2025

Conversation

panteliselef
Copy link
Member

@panteliselef panteliselef commented Jun 10, 2025

Description

image

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 an informational tooltip for past due amounts during checkout, providing users with additional context about overdue payments.
  • Localization
    • Introduced a new localization key and message for past due notices in the checkout process.

Copy link

changeset-bot bot commented Jun 10, 2025

🦋 Changeset detected

Latest commit: 1073464

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

This PR includes changesets to release 22 packages
Name Type
@clerk/clerk-js Patch
@clerk/localizations Patch
@clerk/types Patch
@clerk/chrome-extension Patch
@clerk/clerk-expo Patch
@clerk/clerk-react Patch
@clerk/agent-toolkit Patch
@clerk/astro Patch
@clerk/backend Patch
@clerk/elements Patch
@clerk/expo-passkeys Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/remix Patch
@clerk/shared Patch
@clerk/tanstack-react-start Patch
@clerk/testing Patch
@clerk/themes Patch
@clerk/vue 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 10, 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 10, 2025 9:39am

Copy link

coderabbitai bot commented Jun 10, 2025

📝 Walkthrough

Walkthrough

A tooltip feature was added to the checkout form to display additional information about past due amounts. This involved updating UI components to support icons and tooltips, and introducing a new localization key and string for the past due notice in both type definitions and English language resources.

Changes

Files/Groups Change Summary
.changeset/tiny-cameras-battle.md
.changeset/violet-views-sip.md
Added changeset notes describing the UI update and new localization key.
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx Wrapped the "Past Due" line item title with a tooltip containing a localized notice and an information icon.
packages/clerk-js/src/ui/elements/LineItems.tsx Refactored Title to use React.forwardRef, added optional icon prop, and rendered icon next to title if present.
packages/localizations/src/en-US.ts Added pastDueNotice string to commerce.checkout in the English localization resource.
packages/types/src/localization.ts Extended _LocalizationResource type to include commerce.checkout.pastDueNotice key.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f9edecd and 1073464.

📒 Files selected for processing (1)
  • .changeset/tiny-cameras-battle.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.changeset/tiny-cameras-battle.md

5-5: First line in a file should be a top-level heading
null

(MD041, first-line-heading, first-line-h1)

⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Integration Tests (astro, chrome)
  • GitHub Check: Integration Tests (quickstart, chrome)
  • GitHub Check: Integration Tests (generic, chrome)
  • GitHub Check: Integration Tests (sessions, chrome)
  • GitHub Check: Unit Tests (22, **)
  • GitHub Check: Static analysis
  • GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
.changeset/tiny-cameras-battle.md (1)

1-3: Frontmatter is valid.

The changeset correctly specifies a patch bump for @clerk/clerk-js. Markdownlint MD041 (first-line-heading) is a false positive here—changeset files use YAML frontmatter and don’t require a top-level heading.


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.

Copy link

pkg-pr-new bot commented Jun 10, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 1073464

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: 3

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 607d333 and f9edecd.

📒 Files selected for processing (6)
  • .changeset/tiny-cameras-battle.md (1 hunks)
  • .changeset/violet-views-sip.md (1 hunks)
  • packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx (2 hunks)
  • packages/clerk-js/src/ui/elements/LineItems.tsx (4 hunks)
  • packages/localizations/src/en-US.ts (1 hunks)
  • packages/types/src/localization.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx (3)
packages/clerk-js/src/ui/elements/Tooltip.tsx (1)
  • Tooltip (229-233)
packages/clerk-js/src/ui/elements/LineItems.tsx (1)
  • LineItems (285-290)
packages/clerk-js/src/ui/customizables/index.ts (1)
  • localizationKeys (11-11)
packages/clerk-js/src/ui/elements/LineItems.tsx (1)
packages/clerk-js/src/ui/customizables/index.ts (1)
  • Span (68-68)
🪛 LanguageTool
.changeset/tiny-cameras-battle.md

[uncategorized] ~5-~5: The preposition “at” seems more likely in this position than the preposition “in”.
Context: ...splay info tooltip for past due amounts in checkout.

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_AT)

🪛 markdownlint-cli2 (0.17.2)
.changeset/violet-views-sip.md

6-6: First line in a file should be a top-level heading
null

(MD041, first-line-heading, first-line-h1)

⏰ Context from checks skipped due to timeout of 90000ms (24)
  • GitHub Check: Integration Tests (react-router, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 15)
  • GitHub Check: Integration Tests (tanstack-react-router, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 14)
  • GitHub Check: Integration Tests (nextjs, chrome, 13)
  • GitHub Check: Integration Tests (vue, chrome)
  • GitHub Check: Integration Tests (expo-web, chrome)
  • GitHub Check: Integration Tests (tanstack-react-start, chrome)
  • GitHub Check: Integration Tests (billing, chrome)
  • GitHub Check: Integration Tests (ap-flows, chrome)
  • GitHub Check: Integration Tests (nuxt, chrome)
  • GitHub Check: Integration Tests (quickstart, chrome)
  • GitHub Check: Integration Tests (sessions, chrome)
  • GitHub Check: Integration Tests (localhost, chrome)
  • GitHub Check: Integration Tests (elements, chrome)
  • GitHub Check: Integration Tests (astro, chrome)
  • GitHub Check: Integration Tests (generic, chrome)
  • GitHub Check: Integration Tests (express, chrome)
  • GitHub Check: Publish with pkg-pr-new
  • GitHub Check: Unit Tests (22, **)
  • GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
  • GitHub Check: Static analysis
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (5)
packages/localizations/src/en-US.ts (1)

41-41: New localization key added correctly.

The pastDueNotice string aligns with the new tooltip feature and is placed correctly under commerce.checkout. The value clearly explains the past due status.

packages/types/src/localization.ts (1)

181-181: Type definition for pastDueNotice looks good.

The new pastDueNotice: LocalizationValue key aligns with the localization resource and matches the addition in en-US.ts.

packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx (1)

83-91: Verify Tooltip API usage.

Please confirm that Tooltip.Content accepts a text prop rather than children, and that Tooltip.Trigger correctly forwards refs through the LineItems.Title component.

packages/clerk-js/src/ui/elements/LineItems.tsx (2)

86-86: LGTM: Clean addition of optional icon prop.

The optional icon prop is well-typed and follows React component patterns.


107-122: Well-implemented icon integration with proper accessibility.

The flex layout implementation is clean and follows good practices:

  • Proper spacing with gap: t.space.$1
  • Correct alignment with alignItems: 'center'
  • Conditional icon rendering with null safety
  • Appropriate icon size ('md') and accessibility (aria-hidden)
  • Clean separation of title text in its own Span component

'@clerk/types': patch
---

Introduce `commerce.checkout.pastDueNotice` localization key.
Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

Add a top-level heading per Markdown lint rules.

The file should begin with an H1 heading to satisfy MD041 (first-line-heading). Please add a leading # violet-views-sip above the patch summary.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

6-6: First line in a file should be a top-level heading
null

(MD041, first-line-heading, first-line-h1)

🤖 Prompt for AI Agents
In the file .changeset/violet-views-sip.md at line 6, add a top-level heading by
inserting "# violet-views-sip" as the first line of the file above the existing
content to comply with Markdown lint rule MD041 requiring a first-line heading.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Comment on lines +107 to +122
<Span
sx={t => ({
display: 'inline-flex',
alignItems: 'center',
gap: t.space.$1,
})}
>
{icon ? (
<Icon
size='md'
icon={icon}
aria-hidden
/>
) : null}
<Span localizationKey={title} />
</Span>
Copy link
Member Author

Choose a reason for hiding this comment

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

Technically breaking, but given the fact that we still use span and that there were no child elements it should be fine.

@panteliselef panteliselef merged commit 97749d5 into main Jun 10, 2025
39 checks passed
@panteliselef panteliselef deleted the elef/add-icon-in-checkout-credits branch June 10, 2025 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants