-
Notifications
You must be signed in to change notification settings - Fork 381
feat(vue,astro): Add Billing buttons #6583
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
base: main
Are you sure you want to change the base?
Changes from all commits
62c50de
1563197
86b0d3b
faa409c
5224ca1
070e816
183001f
2fdb49b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
'@clerk/astro': minor | ||
'@clerk/vue': minor | ||
--- | ||
|
||
Expose billing buttons as experimental |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
import { SignedIn, __experimental_CheckoutButton as CheckoutButton } from '@clerk/astro/components'; | ||
import Layout from '../../layouts/Layout.astro'; | ||
--- | ||
|
||
<Layout title="Checkout Button"> | ||
<main> | ||
<SignedIn> | ||
<CheckoutButton | ||
planId='cplan_2wMjqdlza0hTJc4HLCoBwAiExhF' | ||
planPeriod='month' | ||
> | ||
Checkout Now | ||
</CheckoutButton> | ||
</SignedIn> | ||
</main> | ||
</Layout> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
import { PlanDetailsButton } from '@clerk/astro/components'; | ||
import Layout from '../../layouts/Layout.astro'; | ||
--- | ||
|
||
<Layout title="Plan Details Button"> | ||
<main> | ||
<PlanDetailsButton planId='cplan_2wMjqdlza0hTJc4HLCoBwAiExhF'> | ||
Plan details | ||
</PlanDetailsButton> | ||
</main> | ||
</Layout> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
import { __experimental_SubscriptionDetailsButton as SubscriptionDetailsButton } from '@clerk/astro/components'; | ||
import Layout from '../../layouts/Layout.astro'; | ||
--- | ||
|
||
<Layout title="Subscription Details Button"> | ||
<main> | ||
<SubscriptionDetailsButton> | ||
Subscription details | ||
</SubscriptionDetailsButton> | ||
</main> | ||
</Layout> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<template> | ||
<main> | ||
<SignedIn> | ||
<CheckoutButton | ||
planId="cplan_2wMjqdlza0hTJc4HLCoBwAiExhF" | ||
planPeriod="month" | ||
> | ||
Checkout Now | ||
</CheckoutButton> | ||
</SignedIn> | ||
</main> | ||
</template> | ||
|
||
<script setup lang="ts"> | ||
import { SignedIn } from '@clerk/vue'; | ||
import { CheckoutButton } from '@clerk/vue/experimental'; | ||
</script> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
<template> | ||
<main> | ||
<PlanDetailsButton planId="cplan_2wMjqdlza0hTJc4HLCoBwAiExhF"> Plan details </PlanDetailsButton> | ||
</main> | ||
</template> | ||
|
||
<script setup lang="ts"> | ||
import { PlanDetailsButton } from '@clerk/vue/experimental'; | ||
</script> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
<template> | ||
<main> | ||
<SubscriptionDetailsButton> Subscription details </SubscriptionDetailsButton> | ||
</main> | ||
</template> | ||
|
||
<script setup lang="ts"> | ||
import { SubscriptionDetailsButton } from '@clerk/vue/experimental'; | ||
</script> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
--- | ||
import type { HTMLTag, Polymorphic } from 'astro/types'; | ||
import type { __experimental_CheckoutButtonProps } from '@clerk/types'; | ||
import type { ButtonProps } from '../../types'; | ||
import { addUnstyledAttributeToFirstTag, logAsPropUsageDeprecation } from './utils'; | ||
|
||
type Props<Tag extends HTMLTag = 'button'> = Polymorphic<ButtonProps<Tag>> & __experimental_CheckoutButtonProps; | ||
|
||
import { generateSafeId } from '@clerk/astro/internal'; | ||
|
||
const safeId = generateSafeId(); | ||
|
||
if ('as' in Astro.props) { | ||
logAsPropUsageDeprecation(); | ||
} | ||
|
||
const { | ||
as: Tag = 'button', | ||
asChild, | ||
planId, | ||
planPeriod, | ||
for: _for, | ||
onSubscriptionComplete, | ||
newSubscriptionRedirectUrl, | ||
checkoutProps, | ||
...props | ||
} = Astro.props; | ||
|
||
const checkoutOptions = { | ||
planId, | ||
planPeriod, | ||
for: _for, | ||
onSubscriptionComplete, | ||
newSubscriptionRedirectUrl, | ||
...checkoutProps, | ||
}; | ||
|
||
let htmlElement = ''; | ||
|
||
if (asChild) { | ||
htmlElement = await Astro.slots.render('default'); | ||
htmlElement = addUnstyledAttributeToFirstTag(htmlElement, safeId); | ||
} | ||
--- | ||
|
||
{ | ||
asChild ? ( | ||
<Fragment set:html={htmlElement} /> | ||
) : ( | ||
<Tag | ||
{...props} | ||
data-clerk-unstyled-id={safeId} | ||
> | ||
<slot>Checkout</slot> | ||
</Tag> | ||
panteliselef marked this conversation as resolved.
Show resolved
Hide resolved
|
||
) | ||
} | ||
|
||
<script is:inline define:vars={{ props, checkoutOptions, safeId }}> | ||
const btn = document.querySelector(`[data-clerk-unstyled-id="${safeId}"]`); | ||
|
||
btn.addEventListener('click', () => { | ||
const clerk = window.Clerk; | ||
|
||
// Authentication checks | ||
if (!clerk.user) { | ||
throw new Error('Ensure that `<CheckoutButton />` is rendered inside a `<SignedIn />` component.'); | ||
} | ||
|
||
if (!clerk.organization && checkoutOptions.for === 'organization') { | ||
throw new Error('Wrap `<CheckoutButton for="organization" />` with a check for an active organization.'); | ||
} | ||
|
||
return clerk.__internal_openCheckout(checkoutOptions); | ||
}); | ||
</script> | ||
panteliselef marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
import type { HTMLTag, Polymorphic } from 'astro/types'; | ||
import type { __experimental_PlanDetailsButtonProps } from '@clerk/types'; | ||
import type { ButtonProps } from '../../types'; | ||
import { addUnstyledAttributeToFirstTag, logAsPropUsageDeprecation } from './utils'; | ||
|
||
type Props<Tag extends HTMLTag = 'button'> = Polymorphic<ButtonProps<Tag>> & __experimental_PlanDetailsButtonProps; | ||
|
||
import { generateSafeId } from '@clerk/astro/internal'; | ||
|
||
const safeId = generateSafeId(); | ||
|
||
if ('as' in Astro.props) { | ||
logAsPropUsageDeprecation(); | ||
} | ||
|
||
const { as: Tag = 'button', asChild, plan, planId, initialPlanPeriod, planDetailsProps, ...props } = Astro.props; | ||
|
||
const planDetailsOptions = { | ||
plan, | ||
planId, | ||
initialPlanPeriod, | ||
...planDetailsProps, | ||
}; | ||
|
||
let htmlElement = ''; | ||
|
||
if (asChild) { | ||
htmlElement = await Astro.slots.render('default'); | ||
htmlElement = addUnstyledAttributeToFirstTag(htmlElement, safeId); | ||
} | ||
--- | ||
|
||
{ | ||
asChild ? ( | ||
<Fragment set:html={htmlElement} /> | ||
) : ( | ||
<Tag | ||
{...props} | ||
data-clerk-unstyled-id={safeId} | ||
> | ||
<slot>Plan details</slot> | ||
</Tag> | ||
panteliselef marked this conversation as resolved.
Show resolved
Hide resolved
|
||
) | ||
} | ||
|
||
<script is:inline define:vars={{ props, planDetailsOptions, safeId }}> | ||
const btn = document.querySelector(`[data-clerk-unstyled-id="${safeId}"]`); | ||
|
||
btn.addEventListener('click', () => { | ||
const clerk = window.Clerk; | ||
|
||
return clerk.__internal_openPlanDetails(planDetailsOptions); | ||
}); | ||
</script> | ||
panteliselef marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,74 @@ | ||||||||||||||||||||||
--- | ||||||||||||||||||||||
import type { __experimental_SubscriptionDetailsButtonProps } from '@clerk/types'; | ||||||||||||||||||||||
|
||||||||||||||||||||||
import type { HTMLTag, Polymorphic } from 'astro/types'; | ||||||||||||||||||||||
import type { ButtonProps } from '../../types'; | ||||||||||||||||||||||
import { addUnstyledAttributeToFirstTag, logAsPropUsageDeprecation } from './utils'; | ||||||||||||||||||||||
|
||||||||||||||||||||||
type Props<Tag extends HTMLTag = 'button'> = Polymorphic<ButtonProps<Tag>> & | ||||||||||||||||||||||
__experimental_SubscriptionDetailsButtonProps; | ||||||||||||||||||||||
|
||||||||||||||||||||||
import { generateSafeId } from '@clerk/astro/internal'; | ||||||||||||||||||||||
|
||||||||||||||||||||||
const safeId = generateSafeId(); | ||||||||||||||||||||||
|
||||||||||||||||||||||
if ('as' in Astro.props) { | ||||||||||||||||||||||
logAsPropUsageDeprecation(); | ||||||||||||||||||||||
} | ||||||||||||||||||||||
|
||||||||||||||||||||||
const { | ||||||||||||||||||||||
as: Tag = 'button', | ||||||||||||||||||||||
asChild, | ||||||||||||||||||||||
for: _for, | ||||||||||||||||||||||
subscriptionDetailsProps, | ||||||||||||||||||||||
onSubscriptionCancel, | ||||||||||||||||||||||
...props | ||||||||||||||||||||||
} = Astro.props; | ||||||||||||||||||||||
|
||||||||||||||||||||||
const subscriptionDetailsOptions = { | ||||||||||||||||||||||
for: _for, | ||||||||||||||||||||||
onSubscriptionCancel, | ||||||||||||||||||||||
...subscriptionDetailsProps, | ||||||||||||||||||||||
}; | ||||||||||||||||||||||
Comment on lines
+28
to
+32
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 💡 Verification agent 🧩 Analysis chainMake top-level props take precedence over nested subscriptionDetailsProps Currently subscriptionDetailsProps can override for/onSubscriptionCancel, which is surprising. Prefer explicit top-level props to win. Apply: -const subscriptionDetailsOptions = {
- for: _for,
- onSubscriptionCancel,
- ...subscriptionDetailsProps,
-};
+const subscriptionDetailsOptions = {
+ ...subscriptionDetailsProps,
+ for: _for,
+ onSubscriptionCancel,
+}; Verification (consistency with sibling Astro buttons): 🏁 Script executed: #!/bin/bash
# Inspect options precedence across related unstyled Astro buttons
rg -n -C2 --type=astro 'checkoutOptions|planDetailsOptions|subscriptionDetailsOptions' packages/astro/src/astro-components/unstyled Length of output: 163 🏁 Script executed: #!/bin/bash
# Inspect options precedence across related unstyled Astro buttons
rg -n -C2 'checkoutOptions' packages/astro/src/astro-components/unstyled -g '*.astro'
rg -n -C2 'planDetailsOptions' packages/astro/src/astro-components/unstyled -g '*.astro'
rg -n -C2 'subscriptionDetailsOptions' packages/astro/src/astro-components/unstyled -g '*.astro' Length of output: 5783 🏁 Script executed: #!/bin/bash
sed -n '1,60p' packages/astro/src/astro-components/unstyled/CheckoutButton.astro
echo '---'
sed -n '1,60p' packages/astro/src/astro-components/unstyled/PlanDetailsButton.astro Length of output: 2932 Align prop precedence across all unstyled Astro buttons To ensure top-level props always override nested ones, we need to reverse the spread order in all three buttons—currently each one spreads nested props after the explicit fields, allowing nested props to win. Update as follows: • packages/astro/src/astro-components/unstyled/CheckoutButton.astro const checkoutOptions = {
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
- ...checkoutProps,
};
+ ...checkoutProps,
+ planId,
+ planPeriod,
+ for: _for,
+ onSubscriptionComplete,
+ newSubscriptionRedirectUrl,
}; • packages/astro/src/astro-components/unstyled/PlanDetailsButton.astro const planDetailsOptions = {
plan,
planId,
initialPlanPeriod,
- ...planDetailsProps,
};
+ ...planDetailsProps,
+ plan,
+ planId,
+ initialPlanPeriod,
}; • packages/astro/src/astro-components/unstyled/SubscriptionDetailsButton.astro const subscriptionDetailsOptions = {
for: _for,
onSubscriptionCancel,
- ...subscriptionDetailsProps,
};
+ ...subscriptionDetailsProps,
+ for: _for,
+ onSubscriptionCancel,
}; This guarantees explicit 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents
|
||||||||||||||||||||||
|
||||||||||||||||||||||
let htmlElement = ''; | ||||||||||||||||||||||
|
||||||||||||||||||||||
if (asChild) { | ||||||||||||||||||||||
htmlElement = await Astro.slots.render('default'); | ||||||||||||||||||||||
htmlElement = addUnstyledAttributeToFirstTag(htmlElement, safeId); | ||||||||||||||||||||||
} | ||||||||||||||||||||||
--- | ||||||||||||||||||||||
|
||||||||||||||||||||||
{ | ||||||||||||||||||||||
asChild ? ( | ||||||||||||||||||||||
<Fragment set:html={htmlElement} /> | ||||||||||||||||||||||
) : ( | ||||||||||||||||||||||
<Tag | ||||||||||||||||||||||
{...props} | ||||||||||||||||||||||
data-clerk-unstyled-id={safeId} | ||||||||||||||||||||||
> | ||||||||||||||||||||||
<slot>Subscription details</slot> | ||||||||||||||||||||||
</Tag> | ||||||||||||||||||||||
) | ||||||||||||||||||||||
} | ||||||||||||||||||||||
|
||||||||||||||||||||||
<script is:inline define:vars={{ props, subscriptionDetailsOptions, safeId }}> | ||||||||||||||||||||||
const btn = document.querySelector(`[data-clerk-unstyled-id="${safeId}"]`); | ||||||||||||||||||||||
|
||||||||||||||||||||||
btn.addEventListener('click', () => { | ||||||||||||||||||||||
const clerk = window.Clerk; | ||||||||||||||||||||||
|
||||||||||||||||||||||
// Authentication checks | ||||||||||||||||||||||
if (!clerk.user) { | ||||||||||||||||||||||
throw new Error('Ensure that `<SubscriptionDetailsButton />` is rendered inside a `<SignedIn />` component.'); | ||||||||||||||||||||||
} | ||||||||||||||||||||||
|
||||||||||||||||||||||
if (!clerk.organization && subscriptionDetailsOptions.for === 'organization') { | ||||||||||||||||||||||
throw new Error( | ||||||||||||||||||||||
'Wrap `<SubscriptionDetailsButton for="organization" />` with a check for an active organization.', | ||||||||||||||||||||||
); | ||||||||||||||||||||||
} | ||||||||||||||||||||||
|
||||||||||||||||||||||
return clerk.__internal_openSubscriptionDetails(subscriptionDetailsOptions); | ||||||||||||||||||||||
}); | ||||||||||||||||||||||
panteliselef marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||
</script> |
Uh oh!
There was an error while loading. Please reload this page.