Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cold-parks-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': minor
---

Expose billing buttons as experimental
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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>
3 changes: 3 additions & 0 deletions packages/astro/src/astro-components/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export { default as AuthenticateWithRedirectCallback } from './control/Authentic
export { default as SignInButton } from './unstyled/SignInButton.astro';
export { default as SignUpButton } from './unstyled/SignUpButton.astro';
export { default as SignOutButton } from './unstyled/SignOutButton.astro';
export { default as __experimental_SubscriptionDetailsButton } from './unstyled/SubscriptionDetailsButton.astro';
export { default as __experimental_CheckoutButton } from './unstyled/CheckoutButton.astro';
export { default as PlanDetailsButton } from './unstyled/PlanDetailsButton.astro';

/**
* UI Components
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
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>> &
Omit<__experimental_CheckoutButtonProps, 'onSubscriptionComplete'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const {
as: Tag = 'button',
asChild,
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
checkoutProps,
clickIdentifier,
...props
} = Astro.props;

const checkoutOptions = {
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
clickIdentifier,
...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>
Comment thread
panteliselef marked this conversation as 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.');
}

console.log('checkoutOptions', checkoutOptions);

if (checkoutOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-complete', { detail: checkoutOptions.clickIdentifier });
checkoutOptions.onSubscriptionComplete = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openCheckout(checkoutOptions);
});
</script>
Original file line numberDiff line numberDiff 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>
Comment thread
panteliselef marked this conversation as 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);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ditto with the onSubscriptionComplete event https://github.com/clerk/javascript/pull/6583/files#r2333981663

});
</script>
Comment thread
panteliselef marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
---
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>> &
Omit<__experimental_SubscriptionDetailsButtonProps, 'onSubscriptionCancel'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const { as: Tag = 'button', asChild, for: _for, clickIdentifier, subscriptionDetailsProps, ...props } = Astro.props;

const subscriptionDetailsOptions = {
for: _for,
clickIdentifier,
...subscriptionDetailsProps,
};

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.',
);
}
if (subscriptionDetailsOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-cancel', {
detail: subscriptionDetailsOptions.clickIdentifier,
});
subscriptionDetailsOptions.onSubscriptionCancel = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openSubscriptionDetails(subscriptionDetailsOptions);

@wobsorianowobsorianoSep 9, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since we can't pass a function as prop here, the onSubscriptionCancel prop is unusable, but we can use a custom event like this

constcustomEvent=newCustomEvent('clerk:subscription-cancel');clerk.__internal_openSubscriptionDetails({
...subscriptionDetailsOptions,onSubscriptionCancel: ()=>document.dispatchEvent(customEvent),});

and in the parent component, they can listen to it

<script>document.addEventListener('clerk:subscription-cancel',(e)=>{//...})</script>

We do this pattern in our <UserButton>custom menu items in Astro

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Handled here

});
</script>
53 changes: 53 additions & 0 deletions packages/astro/src/react/CheckoutButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
import type { __experimental_CheckoutButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_CheckoutButtonProps as CheckoutButtonProps };

export const CheckoutButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_CheckoutButtonProps>>) => {
const {
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
checkoutProps,
...rest
} = props;

// Note: Auth checks are moved to runtime since Astro React components
// don't have access to auth context at render time like Vue/React apps do

children = normalizeWithDefaultValue(children, 'Checkout');
const child = assertSingleChild(children)('CheckoutButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openCheckout({
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
...checkoutProps,
});
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'CheckoutButton',
);
40 changes: 40 additions & 0 deletions packages/astro/src/react/PlanDetailsButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { __experimental_PlanDetailsButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_PlanDetailsButtonProps as PlanDetailsButtonProps };

export const PlanDetailsButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_PlanDetailsButtonProps>>) => {
const { plan, planId, initialPlanPeriod, planDetailsProps, ...rest } = props;

children = normalizeWithDefaultValue(children, 'Plan details');
const child = assertSingleChild(children)('PlanDetailsButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openPlanDetails({
plan,
planId,
initialPlanPeriod,
...planDetailsProps,
} as __experimental_PlanDetailsButtonProps);
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'PlanDetailsButton',
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cold-parks-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': minor
---

Expose billing buttons as experimental
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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>
3 changes: 3 additions & 0 deletions packages/astro/src/astro-components/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export { default as AuthenticateWithRedirectCallback } from './control/Authentic
export { default as SignInButton } from './unstyled/SignInButton.astro';
export { default as SignUpButton } from './unstyled/SignUpButton.astro';
export { default as SignOutButton } from './unstyled/SignOutButton.astro';
export { default as __experimental_SubscriptionDetailsButton } from './unstyled/SubscriptionDetailsButton.astro';
export { default as __experimental_CheckoutButton } from './unstyled/CheckoutButton.astro';
export { default as PlanDetailsButton } from './unstyled/PlanDetailsButton.astro';

/**
* UI Components
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
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>> &
Omit<__experimental_CheckoutButtonProps, 'onSubscriptionComplete'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const {
as: Tag = 'button',
asChild,
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
checkoutProps,
clickIdentifier,
...props
} = Astro.props;

const checkoutOptions = {
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
clickIdentifier,
...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>
Comment thread
panteliselef marked this conversation as 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.');
}

console.log('checkoutOptions', checkoutOptions);

if (checkoutOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-complete', { detail: checkoutOptions.clickIdentifier });
checkoutOptions.onSubscriptionComplete = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openCheckout(checkoutOptions);
});
</script>
Original file line numberDiff line numberDiff 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>
Comment thread
panteliselef marked this conversation as 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);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ditto with the onSubscriptionComplete event https://github.com/clerk/javascript/pull/6583/files#r2333981663

});
</script>
Comment thread
panteliselef marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
---
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>> &
Omit<__experimental_SubscriptionDetailsButtonProps, 'onSubscriptionCancel'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const { as: Tag = 'button', asChild, for: _for, clickIdentifier, subscriptionDetailsProps, ...props } = Astro.props;

const subscriptionDetailsOptions = {
for: _for,
clickIdentifier,
...subscriptionDetailsProps,
};

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.',
);
}
if (subscriptionDetailsOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-cancel', {
detail: subscriptionDetailsOptions.clickIdentifier,
});
subscriptionDetailsOptions.onSubscriptionCancel = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openSubscriptionDetails(subscriptionDetailsOptions);

@wobsorianowobsorianoSep 9, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since we can't pass a function as prop here, the onSubscriptionCancel prop is unusable, but we can use a custom event like this

constcustomEvent=newCustomEvent('clerk:subscription-cancel');clerk.__internal_openSubscriptionDetails({
...subscriptionDetailsOptions,onSubscriptionCancel: ()=>document.dispatchEvent(customEvent),});

and in the parent component, they can listen to it

<script>document.addEventListener('clerk:subscription-cancel',(e)=>{//...})</script>

We do this pattern in our <UserButton>custom menu items in Astro

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Handled here

});
</script>
53 changes: 53 additions & 0 deletions packages/astro/src/react/CheckoutButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
import type { __experimental_CheckoutButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_CheckoutButtonProps as CheckoutButtonProps };

export const CheckoutButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_CheckoutButtonProps>>) => {
const {
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
checkoutProps,
...rest
} = props;

// Note: Auth checks are moved to runtime since Astro React components
// don't have access to auth context at render time like Vue/React apps do

children = normalizeWithDefaultValue(children, 'Checkout');
const child = assertSingleChild(children)('CheckoutButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openCheckout({
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
...checkoutProps,
});
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'CheckoutButton',
);
40 changes: 40 additions & 0 deletions packages/astro/src/react/PlanDetailsButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { __experimental_PlanDetailsButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_PlanDetailsButtonProps as PlanDetailsButtonProps };

export const PlanDetailsButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_PlanDetailsButtonProps>>) => {
const { plan, planId, initialPlanPeriod, planDetailsProps, ...rest } = props;

children = normalizeWithDefaultValue(children, 'Plan details');
const child = assertSingleChild(children)('PlanDetailsButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openPlanDetails({
plan,
planId,
initialPlanPeriod,
...planDetailsProps,
} as __experimental_PlanDetailsButtonProps);
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'PlanDetailsButton',
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cold-parks-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': minor
---

Expose billing buttons as experimental
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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>
3 changes: 3 additions & 0 deletions packages/astro/src/astro-components/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export { default as AuthenticateWithRedirectCallback } from './control/Authentic
export { default as SignInButton } from './unstyled/SignInButton.astro';
export { default as SignUpButton } from './unstyled/SignUpButton.astro';
export { default as SignOutButton } from './unstyled/SignOutButton.astro';
export { default as __experimental_SubscriptionDetailsButton } from './unstyled/SubscriptionDetailsButton.astro';
export { default as __experimental_CheckoutButton } from './unstyled/CheckoutButton.astro';
export { default as PlanDetailsButton } from './unstyled/PlanDetailsButton.astro';

/**
* UI Components
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
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>> &
Omit<__experimental_CheckoutButtonProps, 'onSubscriptionComplete'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const {
as: Tag = 'button',
asChild,
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
checkoutProps,
clickIdentifier,
...props
} = Astro.props;

const checkoutOptions = {
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
clickIdentifier,
...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>
Comment thread
panteliselef marked this conversation as 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.');
}

console.log('checkoutOptions', checkoutOptions);

if (checkoutOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-complete', { detail: checkoutOptions.clickIdentifier });
checkoutOptions.onSubscriptionComplete = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openCheckout(checkoutOptions);
});
</script>
Original file line numberDiff line numberDiff 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>
Comment thread
panteliselef marked this conversation as 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);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ditto with the onSubscriptionComplete event https://github.com/clerk/javascript/pull/6583/files#r2333981663

});
</script>
Comment thread
panteliselef marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
---
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>> &
Omit<__experimental_SubscriptionDetailsButtonProps, 'onSubscriptionCancel'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const { as: Tag = 'button', asChild, for: _for, clickIdentifier, subscriptionDetailsProps, ...props } = Astro.props;

const subscriptionDetailsOptions = {
for: _for,
clickIdentifier,
...subscriptionDetailsProps,
};

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.',
);
}
if (subscriptionDetailsOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-cancel', {
detail: subscriptionDetailsOptions.clickIdentifier,
});
subscriptionDetailsOptions.onSubscriptionCancel = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openSubscriptionDetails(subscriptionDetailsOptions);

@wobsorianowobsorianoSep 9, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since we can't pass a function as prop here, the onSubscriptionCancel prop is unusable, but we can use a custom event like this

constcustomEvent=newCustomEvent('clerk:subscription-cancel');clerk.__internal_openSubscriptionDetails({
...subscriptionDetailsOptions,onSubscriptionCancel: ()=>document.dispatchEvent(customEvent),});

and in the parent component, they can listen to it

<script>document.addEventListener('clerk:subscription-cancel',(e)=>{//...})</script>

We do this pattern in our <UserButton>custom menu items in Astro

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Handled here

});
</script>
53 changes: 53 additions & 0 deletions packages/astro/src/react/CheckoutButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
import type { __experimental_CheckoutButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_CheckoutButtonProps as CheckoutButtonProps };

export const CheckoutButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_CheckoutButtonProps>>) => {
const {
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
checkoutProps,
...rest
} = props;

// Note: Auth checks are moved to runtime since Astro React components
// don't have access to auth context at render time like Vue/React apps do

children = normalizeWithDefaultValue(children, 'Checkout');
const child = assertSingleChild(children)('CheckoutButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openCheckout({
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
...checkoutProps,
});
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'CheckoutButton',
);
40 changes: 40 additions & 0 deletions packages/astro/src/react/PlanDetailsButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { __experimental_PlanDetailsButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_PlanDetailsButtonProps as PlanDetailsButtonProps };

export const PlanDetailsButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_PlanDetailsButtonProps>>) => {
const { plan, planId, initialPlanPeriod, planDetailsProps, ...rest } = props;

children = normalizeWithDefaultValue(children, 'Plan details');
const child = assertSingleChild(children)('PlanDetailsButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openPlanDetails({
plan,
planId,
initialPlanPeriod,
...planDetailsProps,
} as __experimental_PlanDetailsButtonProps);
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'PlanDetailsButton',
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cold-parks-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': minor
---

Expose billing buttons as experimental
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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>
3 changes: 3 additions & 0 deletions packages/astro/src/astro-components/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export { default as AuthenticateWithRedirectCallback } from './control/Authentic
export { default as SignInButton } from './unstyled/SignInButton.astro';
export { default as SignUpButton } from './unstyled/SignUpButton.astro';
export { default as SignOutButton } from './unstyled/SignOutButton.astro';
export { default as __experimental_SubscriptionDetailsButton } from './unstyled/SubscriptionDetailsButton.astro';
export { default as __experimental_CheckoutButton } from './unstyled/CheckoutButton.astro';
export { default as PlanDetailsButton } from './unstyled/PlanDetailsButton.astro';

/**
* UI Components
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
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>> &
Omit<__experimental_CheckoutButtonProps, 'onSubscriptionComplete'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const {
as: Tag = 'button',
asChild,
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
checkoutProps,
clickIdentifier,
...props
} = Astro.props;

const checkoutOptions = {
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
clickIdentifier,
...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>
Comment thread
panteliselef marked this conversation as 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.');
}

console.log('checkoutOptions', checkoutOptions);

if (checkoutOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-complete', { detail: checkoutOptions.clickIdentifier });
checkoutOptions.onSubscriptionComplete = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openCheckout(checkoutOptions);
});
</script>
Original file line numberDiff line numberDiff 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>
Comment thread
panteliselef marked this conversation as 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);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ditto with the onSubscriptionComplete event https://github.com/clerk/javascript/pull/6583/files#r2333981663

});
</script>
Comment thread
panteliselef marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
---
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>> &
Omit<__experimental_SubscriptionDetailsButtonProps, 'onSubscriptionCancel'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const { as: Tag = 'button', asChild, for: _for, clickIdentifier, subscriptionDetailsProps, ...props } = Astro.props;

const subscriptionDetailsOptions = {
for: _for,
clickIdentifier,
...subscriptionDetailsProps,
};

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.',
);
}
if (subscriptionDetailsOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-cancel', {
detail: subscriptionDetailsOptions.clickIdentifier,
});
subscriptionDetailsOptions.onSubscriptionCancel = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openSubscriptionDetails(subscriptionDetailsOptions);

@wobsorianowobsorianoSep 9, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since we can't pass a function as prop here, the onSubscriptionCancel prop is unusable, but we can use a custom event like this

constcustomEvent=newCustomEvent('clerk:subscription-cancel');clerk.__internal_openSubscriptionDetails({
...subscriptionDetailsOptions,onSubscriptionCancel: ()=>document.dispatchEvent(customEvent),});

and in the parent component, they can listen to it

<script>document.addEventListener('clerk:subscription-cancel',(e)=>{//...})</script>

We do this pattern in our <UserButton>custom menu items in Astro

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Handled here

});
</script>
53 changes: 53 additions & 0 deletions packages/astro/src/react/CheckoutButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
import type { __experimental_CheckoutButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_CheckoutButtonProps as CheckoutButtonProps };

export const CheckoutButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_CheckoutButtonProps>>) => {
const {
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
checkoutProps,
...rest
} = props;

// Note: Auth checks are moved to runtime since Astro React components
// don't have access to auth context at render time like Vue/React apps do

children = normalizeWithDefaultValue(children, 'Checkout');
const child = assertSingleChild(children)('CheckoutButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openCheckout({
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
...checkoutProps,
});
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'CheckoutButton',
);
40 changes: 40 additions & 0 deletions packages/astro/src/react/PlanDetailsButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { __experimental_PlanDetailsButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_PlanDetailsButtonProps as PlanDetailsButtonProps };

export const PlanDetailsButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_PlanDetailsButtonProps>>) => {
const { plan, planId, initialPlanPeriod, planDetailsProps, ...rest } = props;

children = normalizeWithDefaultValue(children, 'Plan details');
const child = assertSingleChild(children)('PlanDetailsButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openPlanDetails({
plan,
planId,
initialPlanPeriod,
...planDetailsProps,
} as __experimental_PlanDetailsButtonProps);
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'PlanDetailsButton',
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cold-parks-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': minor
---

Expose billing buttons as experimental
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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>
3 changes: 3 additions & 0 deletions packages/astro/src/astro-components/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export { default as AuthenticateWithRedirectCallback } from './control/Authentic
export { default as SignInButton } from './unstyled/SignInButton.astro';
export { default as SignUpButton } from './unstyled/SignUpButton.astro';
export { default as SignOutButton } from './unstyled/SignOutButton.astro';
export { default as __experimental_SubscriptionDetailsButton } from './unstyled/SubscriptionDetailsButton.astro';
export { default as __experimental_CheckoutButton } from './unstyled/CheckoutButton.astro';
export { default as PlanDetailsButton } from './unstyled/PlanDetailsButton.astro';

/**
* UI Components
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
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>> &
Omit<__experimental_CheckoutButtonProps, 'onSubscriptionComplete'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const {
as: Tag = 'button',
asChild,
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
checkoutProps,
clickIdentifier,
...props
} = Astro.props;

const checkoutOptions = {
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
clickIdentifier,
...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>
Comment thread
panteliselef marked this conversation as 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.');
}

console.log('checkoutOptions', checkoutOptions);

if (checkoutOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-complete', { detail: checkoutOptions.clickIdentifier });
checkoutOptions.onSubscriptionComplete = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openCheckout(checkoutOptions);
});
</script>
Original file line numberDiff line numberDiff 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>
Comment thread
panteliselef marked this conversation as 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);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ditto with the onSubscriptionComplete event https://github.com/clerk/javascript/pull/6583/files#r2333981663

});
</script>
Comment thread
panteliselef marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
---
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>> &
Omit<__experimental_SubscriptionDetailsButtonProps, 'onSubscriptionCancel'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const { as: Tag = 'button', asChild, for: _for, clickIdentifier, subscriptionDetailsProps, ...props } = Astro.props;

const subscriptionDetailsOptions = {
for: _for,
clickIdentifier,
...subscriptionDetailsProps,
};

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.',
);
}
if (subscriptionDetailsOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-cancel', {
detail: subscriptionDetailsOptions.clickIdentifier,
});
subscriptionDetailsOptions.onSubscriptionCancel = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openSubscriptionDetails(subscriptionDetailsOptions);

@wobsorianowobsorianoSep 9, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since we can't pass a function as prop here, the onSubscriptionCancel prop is unusable, but we can use a custom event like this

constcustomEvent=newCustomEvent('clerk:subscription-cancel');clerk.__internal_openSubscriptionDetails({
...subscriptionDetailsOptions,onSubscriptionCancel: ()=>document.dispatchEvent(customEvent),});

and in the parent component, they can listen to it

<script>document.addEventListener('clerk:subscription-cancel',(e)=>{//...})</script>

We do this pattern in our <UserButton>custom menu items in Astro

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Handled here

});
</script>
53 changes: 53 additions & 0 deletions packages/astro/src/react/CheckoutButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
import type { __experimental_CheckoutButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_CheckoutButtonProps as CheckoutButtonProps };

export const CheckoutButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_CheckoutButtonProps>>) => {
const {
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
checkoutProps,
...rest
} = props;

// Note: Auth checks are moved to runtime since Astro React components
// don't have access to auth context at render time like Vue/React apps do

children = normalizeWithDefaultValue(children, 'Checkout');
const child = assertSingleChild(children)('CheckoutButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openCheckout({
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
...checkoutProps,
});
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'CheckoutButton',
);
40 changes: 40 additions & 0 deletions packages/astro/src/react/PlanDetailsButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { __experimental_PlanDetailsButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_PlanDetailsButtonProps as PlanDetailsButtonProps };

export const PlanDetailsButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_PlanDetailsButtonProps>>) => {
const { plan, planId, initialPlanPeriod, planDetailsProps, ...rest } = props;

children = normalizeWithDefaultValue(children, 'Plan details');
const child = assertSingleChild(children)('PlanDetailsButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openPlanDetails({
plan,
planId,
initialPlanPeriod,
...planDetailsProps,
} as __experimental_PlanDetailsButtonProps);
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'PlanDetailsButton',
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cold-parks-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': minor
---

Expose billing buttons as experimental
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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>
3 changes: 3 additions & 0 deletions packages/astro/src/astro-components/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export { default as AuthenticateWithRedirectCallback } from './control/Authentic
export { default as SignInButton } from './unstyled/SignInButton.astro';
export { default as SignUpButton } from './unstyled/SignUpButton.astro';
export { default as SignOutButton } from './unstyled/SignOutButton.astro';
export { default as __experimental_SubscriptionDetailsButton } from './unstyled/SubscriptionDetailsButton.astro';
export { default as __experimental_CheckoutButton } from './unstyled/CheckoutButton.astro';
export { default as PlanDetailsButton } from './unstyled/PlanDetailsButton.astro';

/**
* UI Components
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
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>> &
Omit<__experimental_CheckoutButtonProps, 'onSubscriptionComplete'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const {
as: Tag = 'button',
asChild,
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
checkoutProps,
clickIdentifier,
...props
} = Astro.props;

const checkoutOptions = {
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
clickIdentifier,
...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>
Comment thread
panteliselef marked this conversation as 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.');
}

console.log('checkoutOptions', checkoutOptions);

if (checkoutOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-complete', { detail: checkoutOptions.clickIdentifier });
checkoutOptions.onSubscriptionComplete = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openCheckout(checkoutOptions);
});
</script>
Original file line numberDiff line numberDiff 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>
Comment thread
panteliselef marked this conversation as 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);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ditto with the onSubscriptionComplete event https://github.com/clerk/javascript/pull/6583/files#r2333981663

});
</script>
Comment thread
panteliselef marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
---
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>> &
Omit<__experimental_SubscriptionDetailsButtonProps, 'onSubscriptionCancel'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const { as: Tag = 'button', asChild, for: _for, clickIdentifier, subscriptionDetailsProps, ...props } = Astro.props;

const subscriptionDetailsOptions = {
for: _for,
clickIdentifier,
...subscriptionDetailsProps,
};

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.',
);
}
if (subscriptionDetailsOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-cancel', {
detail: subscriptionDetailsOptions.clickIdentifier,
});
subscriptionDetailsOptions.onSubscriptionCancel = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openSubscriptionDetails(subscriptionDetailsOptions);

@wobsorianowobsorianoSep 9, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since we can't pass a function as prop here, the onSubscriptionCancel prop is unusable, but we can use a custom event like this

constcustomEvent=newCustomEvent('clerk:subscription-cancel');clerk.__internal_openSubscriptionDetails({
...subscriptionDetailsOptions,onSubscriptionCancel: ()=>document.dispatchEvent(customEvent),});

and in the parent component, they can listen to it

<script>document.addEventListener('clerk:subscription-cancel',(e)=>{//...})</script>

We do this pattern in our <UserButton>custom menu items in Astro

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Handled here

});
</script>
53 changes: 53 additions & 0 deletions packages/astro/src/react/CheckoutButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
import type { __experimental_CheckoutButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_CheckoutButtonProps as CheckoutButtonProps };

export const CheckoutButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_CheckoutButtonProps>>) => {
const {
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
checkoutProps,
...rest
} = props;

// Note: Auth checks are moved to runtime since Astro React components
// don't have access to auth context at render time like Vue/React apps do

children = normalizeWithDefaultValue(children, 'Checkout');
const child = assertSingleChild(children)('CheckoutButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openCheckout({
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
...checkoutProps,
});
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'CheckoutButton',
);
40 changes: 40 additions & 0 deletions packages/astro/src/react/PlanDetailsButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { __experimental_PlanDetailsButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_PlanDetailsButtonProps as PlanDetailsButtonProps };

export const PlanDetailsButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_PlanDetailsButtonProps>>) => {
const { plan, planId, initialPlanPeriod, planDetailsProps, ...rest } = props;

children = normalizeWithDefaultValue(children, 'Plan details');
const child = assertSingleChild(children)('PlanDetailsButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openPlanDetails({
plan,
planId,
initialPlanPeriod,
...planDetailsProps,
} as __experimental_PlanDetailsButtonProps);
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'PlanDetailsButton',
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cold-parks-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': minor
---

Expose billing buttons as experimental
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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>
3 changes: 3 additions & 0 deletions packages/astro/src/astro-components/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export { default as AuthenticateWithRedirectCallback } from './control/Authentic
export { default as SignInButton } from './unstyled/SignInButton.astro';
export { default as SignUpButton } from './unstyled/SignUpButton.astro';
export { default as SignOutButton } from './unstyled/SignOutButton.astro';
export { default as __experimental_SubscriptionDetailsButton } from './unstyled/SubscriptionDetailsButton.astro';
export { default as __experimental_CheckoutButton } from './unstyled/CheckoutButton.astro';
export { default as PlanDetailsButton } from './unstyled/PlanDetailsButton.astro';

/**
* UI Components
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
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>> &
Omit<__experimental_CheckoutButtonProps, 'onSubscriptionComplete'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const {
as: Tag = 'button',
asChild,
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
checkoutProps,
clickIdentifier,
...props
} = Astro.props;

const checkoutOptions = {
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
clickIdentifier,
...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>
Comment thread
panteliselef marked this conversation as 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.');
}

console.log('checkoutOptions', checkoutOptions);

if (checkoutOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-complete', { detail: checkoutOptions.clickIdentifier });
checkoutOptions.onSubscriptionComplete = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openCheckout(checkoutOptions);
});
</script>
Original file line numberDiff line numberDiff 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>
Comment thread
panteliselef marked this conversation as 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);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ditto with the onSubscriptionComplete event https://github.com/clerk/javascript/pull/6583/files#r2333981663

});
</script>
Comment thread
panteliselef marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
---
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>> &
Omit<__experimental_SubscriptionDetailsButtonProps, 'onSubscriptionCancel'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const { as: Tag = 'button', asChild, for: _for, clickIdentifier, subscriptionDetailsProps, ...props } = Astro.props;

const subscriptionDetailsOptions = {
for: _for,
clickIdentifier,
...subscriptionDetailsProps,
};

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.',
);
}
if (subscriptionDetailsOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-cancel', {
detail: subscriptionDetailsOptions.clickIdentifier,
});
subscriptionDetailsOptions.onSubscriptionCancel = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openSubscriptionDetails(subscriptionDetailsOptions);

@wobsorianowobsorianoSep 9, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since we can't pass a function as prop here, the onSubscriptionCancel prop is unusable, but we can use a custom event like this

constcustomEvent=newCustomEvent('clerk:subscription-cancel');clerk.__internal_openSubscriptionDetails({
...subscriptionDetailsOptions,onSubscriptionCancel: ()=>document.dispatchEvent(customEvent),});

and in the parent component, they can listen to it

<script>document.addEventListener('clerk:subscription-cancel',(e)=>{//...})</script>

We do this pattern in our <UserButton>custom menu items in Astro

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Handled here

});
</script>
53 changes: 53 additions & 0 deletions packages/astro/src/react/CheckoutButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
import type { __experimental_CheckoutButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_CheckoutButtonProps as CheckoutButtonProps };

export const CheckoutButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_CheckoutButtonProps>>) => {
const {
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
checkoutProps,
...rest
} = props;

// Note: Auth checks are moved to runtime since Astro React components
// don't have access to auth context at render time like Vue/React apps do

children = normalizeWithDefaultValue(children, 'Checkout');
const child = assertSingleChild(children)('CheckoutButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openCheckout({
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
...checkoutProps,
});
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'CheckoutButton',
);
40 changes: 40 additions & 0 deletions packages/astro/src/react/PlanDetailsButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { __experimental_PlanDetailsButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_PlanDetailsButtonProps as PlanDetailsButtonProps };

export const PlanDetailsButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_PlanDetailsButtonProps>>) => {
const { plan, planId, initialPlanPeriod, planDetailsProps, ...rest } = props;

children = normalizeWithDefaultValue(children, 'Plan details');
const child = assertSingleChild(children)('PlanDetailsButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openPlanDetails({
plan,
planId,
initialPlanPeriod,
...planDetailsProps,
} as __experimental_PlanDetailsButtonProps);
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'PlanDetailsButton',
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cold-parks-push.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/astro': minor
---

Expose billing buttons as experimental
Original file line numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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>
3 changes: 3 additions & 0 deletions packages/astro/src/astro-components/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export { default as AuthenticateWithRedirectCallback } from './control/Authentic
export { default as SignInButton } from './unstyled/SignInButton.astro';
export { default as SignUpButton } from './unstyled/SignUpButton.astro';
export { default as SignOutButton } from './unstyled/SignOutButton.astro';
export { default as __experimental_SubscriptionDetailsButton } from './unstyled/SubscriptionDetailsButton.astro';
export { default as __experimental_CheckoutButton } from './unstyled/CheckoutButton.astro';
export { default as PlanDetailsButton } from './unstyled/PlanDetailsButton.astro';

/**
* UI Components
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
---
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>> &
Omit<__experimental_CheckoutButtonProps, 'onSubscriptionComplete'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const {
as: Tag = 'button',
asChild,
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
checkoutProps,
clickIdentifier,
...props
} = Astro.props;

const checkoutOptions = {
planId,
planPeriod,
for: _for,
newSubscriptionRedirectUrl,
clickIdentifier,
...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>
Comment thread
panteliselef marked this conversation as 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.');
}

console.log('checkoutOptions', checkoutOptions);

if (checkoutOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-complete', { detail: checkoutOptions.clickIdentifier });
checkoutOptions.onSubscriptionComplete = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openCheckout(checkoutOptions);
});
</script>
Original file line numberDiff line numberDiff 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>
Comment thread
panteliselef marked this conversation as 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);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ditto with the onSubscriptionComplete event https://github.com/clerk/javascript/pull/6583/files#r2333981663

});
</script>
Comment thread
panteliselef marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
---
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>> &
Omit<__experimental_SubscriptionDetailsButtonProps, 'onSubscriptionCancel'> & { clickIdentifier?: string };

import { generateSafeId } from '@clerk/astro/internal';

const safeId = generateSafeId();

if ('as' in Astro.props) {
logAsPropUsageDeprecation();
}

const { as: Tag = 'button', asChild, for: _for, clickIdentifier, subscriptionDetailsProps, ...props } = Astro.props;

const subscriptionDetailsOptions = {
for: _for,
clickIdentifier,
...subscriptionDetailsProps,
};

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.',
);
}
if (subscriptionDetailsOptions.clickIdentifier) {
const clickEvent = new CustomEvent('clerk:subscription-cancel', {
detail: subscriptionDetailsOptions.clickIdentifier,
});
subscriptionDetailsOptions.onSubscriptionCancel = () => {
document.dispatchEvent(clickEvent);
};
}

return clerk.__internal_openSubscriptionDetails(subscriptionDetailsOptions);

@wobsorianowobsorianoSep 9, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since we can't pass a function as prop here, the onSubscriptionCancel prop is unusable, but we can use a custom event like this

constcustomEvent=newCustomEvent('clerk:subscription-cancel');clerk.__internal_openSubscriptionDetails({
...subscriptionDetailsOptions,onSubscriptionCancel: ()=>document.dispatchEvent(customEvent),});

and in the parent component, they can listen to it

<script>document.addEventListener('clerk:subscription-cancel',(e)=>{//...})</script>

We do this pattern in our <UserButton>custom menu items in Astro

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Handled here

});
</script>
53 changes: 53 additions & 0 deletions packages/astro/src/react/CheckoutButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
import type { __experimental_CheckoutButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_CheckoutButtonProps as CheckoutButtonProps };

export const CheckoutButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_CheckoutButtonProps>>) => {
const {
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
checkoutProps,
...rest
} = props;

// Note: Auth checks are moved to runtime since Astro React components
// don't have access to auth context at render time like Vue/React apps do

children = normalizeWithDefaultValue(children, 'Checkout');
const child = assertSingleChild(children)('CheckoutButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openCheckout({
planId,
planPeriod,
for: _for,
onSubscriptionComplete,
newSubscriptionRedirectUrl,
...checkoutProps,
});
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'CheckoutButton',
);
40 changes: 40 additions & 0 deletions packages/astro/src/react/PlanDetailsButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { __experimental_PlanDetailsButtonProps } from '@clerk/types';
import React from 'react';

import type { WithClerkProp } from './utils';
import { assertSingleChild, normalizeWithDefaultValue, safeExecute, withClerk } from './utils';

export type { __experimental_PlanDetailsButtonProps as PlanDetailsButtonProps };

export const PlanDetailsButton = withClerk(
({ clerk, children, ...props }: WithClerkProp<React.PropsWithChildren<__experimental_PlanDetailsButtonProps>>) => {
const { plan, planId, initialPlanPeriod, planDetailsProps, ...rest } = props;

children = normalizeWithDefaultValue(children, 'Plan details');
const child = assertSingleChild(children)('PlanDetailsButton');

const clickHandler = () => {
if (!clerk) {
return;
}

return clerk.__internal_openPlanDetails({
plan,
planId,
initialPlanPeriod,
...planDetailsProps,
} as __experimental_PlanDetailsButtonProps);
};

const wrappedChildClickHandler: React.MouseEventHandler = e => {
if (child && typeof child === 'object' && 'props' in child) {
void safeExecute(child.props.onClick)(e);
}
return clickHandler();
};

const childProps = { ...rest, onClick: wrappedChildClickHandler };
return React.cloneElement(child as React.ReactElement<unknown>, childProps);
},
'PlanDetailsButton',
);
Loading