Skip to content

fix(vue): deprecate SignOutButton signOutOptions prop - #8148

Merged
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options
Mar 24, 2026
Merged

fix(vue): deprecate SignOutButton signOutOptions prop#8148
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options

Conversation

@jacekradko

@jacekradkojacekradko commented Mar 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Deprecates the signOutOptions prop on Vue's <SignOutButton /> in favor of the existing flat redirectUrl and sessionId props
  • Adds @deprecated JSDoc annotation and runtime deprecation warning via deprecated() helper
  • signOutOptions still works (backwards compatible) but emits a console warning in development

Companion to #8147 (React). Vue already had the flat props — this just adds the deprecation notice.

Test plan

  • Existing tests pass unchanged (52 tests)
  • npx turbo build --filter=@clerk/vue passes
  • npx turbo test --filter=@clerk/vue passes

Summary by CodeRabbit

  • Deprecations
    • Deprecated signOutOptions prop on <SignOutButton />. Use redirectUrl and sessionId props directly instead. The deprecated prop remains functional with a deprecation warning.

@changeset-bot

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 043a8f8

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

This PR includes changesets to release 2 packages
NameType
@clerk/vuePatch
@clerk/nuxtPatch

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

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

@vercel

vercelBot commented Mar 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 21, 2026 3:30am

Request Review

@pkg-pr-new

Copy link
Copy Markdown

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8148

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8148

@clerk/upgrade

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

@clerk/vue

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

commit: 043a8f8

@coderabbitai

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

This change adds deprecation handling for the signOutOptions prop on the <SignOutButton /> component in the @clerk/vue package. A changeset entry documents the deprecation as a patch release. The component now imports and invokes deprecation reporting when the signOutOptions prop is provided, with a @deprecated JSDoc annotation added to the prop declaration. The prop remains functional while directing users to use redirectUrl and sessionId as top-level props instead.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly and specifically describes the main change: deprecating the signOutOptions prop on the Vue SignOutButton component.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.

Add a configuration file to your project to customize how CodeRabbit runs biome.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/vue/src/components/SignOutButton.vue`:
- Around line 29-31: Add tests for the new deprecation runtime path in
SignOutButton.vue: write unit tests that mount the SignOutButton component with
props.signOutOptions provided and assert that the deprecated('SignOutButton
`signOutOptions`'...) function is called (or that the expected warning/log is
emitted), and also add a backward-compatibility test that passing signOutOptions
still results in the same redirectUrl/sessionId behavior. Use the existing test
utilities (mount/shallowMount) and spy/mocking for the deprecated helper to
observe calls, and include both the warning emission assertion and a functional
assertion that behavior is unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: b0669ab7-995c-4afe-b981-24a95bf982a3

📥 Commits

Reviewing files that changed from the base of the PR and between 35d45be and 043a8f8.

📒 Files selected for processing (2)
  • .changeset/deprecate-vue-signout-options.md
  • packages/vue/src/components/SignOutButton.vue

Comment threadpackages/vue/src/components/SignOutButton.vue
@jacekradko
jacekradko merged commit c44f106 into mainMar 24, 2026
44 checks passed
@jacekradko
jacekradko deleted the jacek/deprecate-vue-signout-options branch March 24, 2026 00:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jacekradko@wobsoriano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(vue): deprecate SignOutButton signOutOptions prop by jacekradko · Pull Request #8148 · clerk/javascript · GitHub
Skip to content

fix(vue): deprecate SignOutButton signOutOptions prop - #8148

Merged
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options
Mar 24, 2026
Merged

fix(vue): deprecate SignOutButton signOutOptions prop#8148
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options

Conversation

@jacekradko

@jacekradkojacekradko commented Mar 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Deprecates the signOutOptions prop on Vue's <SignOutButton /> in favor of the existing flat redirectUrl and sessionId props
  • Adds @deprecated JSDoc annotation and runtime deprecation warning via deprecated() helper
  • signOutOptions still works (backwards compatible) but emits a console warning in development

Companion to #8147 (React). Vue already had the flat props — this just adds the deprecation notice.

Test plan

  • Existing tests pass unchanged (52 tests)
  • npx turbo build --filter=@clerk/vue passes
  • npx turbo test --filter=@clerk/vue passes

Summary by CodeRabbit

  • Deprecations
    • Deprecated signOutOptions prop on <SignOutButton />. Use redirectUrl and sessionId props directly instead. The deprecated prop remains functional with a deprecation warning.

@changeset-bot

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 043a8f8

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

This PR includes changesets to release 2 packages
NameType
@clerk/vuePatch
@clerk/nuxtPatch

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

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

@vercel

vercelBot commented Mar 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 21, 2026 3:30am

Request Review

@pkg-pr-new

Copy link
Copy Markdown

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8148

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8148

@clerk/upgrade

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

@clerk/vue

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

commit: 043a8f8

@coderabbitai

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

This change adds deprecation handling for the signOutOptions prop on the <SignOutButton /> component in the @clerk/vue package. A changeset entry documents the deprecation as a patch release. The component now imports and invokes deprecation reporting when the signOutOptions prop is provided, with a @deprecated JSDoc annotation added to the prop declaration. The prop remains functional while directing users to use redirectUrl and sessionId as top-level props instead.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly and specifically describes the main change: deprecating the signOutOptions prop on the Vue SignOutButton component.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.

Add a configuration file to your project to customize how CodeRabbit runs biome.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/vue/src/components/SignOutButton.vue`:
- Around line 29-31: Add tests for the new deprecation runtime path in
SignOutButton.vue: write unit tests that mount the SignOutButton component with
props.signOutOptions provided and assert that the deprecated('SignOutButton
`signOutOptions`'...) function is called (or that the expected warning/log is
emitted), and also add a backward-compatibility test that passing signOutOptions
still results in the same redirectUrl/sessionId behavior. Use the existing test
utilities (mount/shallowMount) and spy/mocking for the deprecated helper to
observe calls, and include both the warning emission assertion and a functional
assertion that behavior is unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: b0669ab7-995c-4afe-b981-24a95bf982a3

📥 Commits

Reviewing files that changed from the base of the PR and between 35d45be and 043a8f8.

📒 Files selected for processing (2)
  • .changeset/deprecate-vue-signout-options.md
  • packages/vue/src/components/SignOutButton.vue

Comment threadpackages/vue/src/components/SignOutButton.vue
@jacekradko
jacekradko merged commit c44f106 into mainMar 24, 2026
44 checks passed
@jacekradko
jacekradko deleted the jacek/deprecate-vue-signout-options branch March 24, 2026 00:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jacekradko@wobsoriano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(vue): deprecate SignOutButton signOutOptions prop by jacekradko · Pull Request #8148 · clerk/javascript · GitHub
Skip to content

fix(vue): deprecate SignOutButton signOutOptions prop - #8148

Merged
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options
Mar 24, 2026
Merged

fix(vue): deprecate SignOutButton signOutOptions prop#8148
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options

Conversation

@jacekradko

@jacekradkojacekradko commented Mar 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Deprecates the signOutOptions prop on Vue's <SignOutButton /> in favor of the existing flat redirectUrl and sessionId props
  • Adds @deprecated JSDoc annotation and runtime deprecation warning via deprecated() helper
  • signOutOptions still works (backwards compatible) but emits a console warning in development

Companion to #8147 (React). Vue already had the flat props — this just adds the deprecation notice.

Test plan

  • Existing tests pass unchanged (52 tests)
  • npx turbo build --filter=@clerk/vue passes
  • npx turbo test --filter=@clerk/vue passes

Summary by CodeRabbit

  • Deprecations
    • Deprecated signOutOptions prop on <SignOutButton />. Use redirectUrl and sessionId props directly instead. The deprecated prop remains functional with a deprecation warning.

@changeset-bot

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 043a8f8

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

This PR includes changesets to release 2 packages
NameType
@clerk/vuePatch
@clerk/nuxtPatch

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

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

@vercel

vercelBot commented Mar 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 21, 2026 3:30am

Request Review

@pkg-pr-new

Copy link
Copy Markdown

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8148

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8148

@clerk/upgrade

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

@clerk/vue

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

commit: 043a8f8

@coderabbitai

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

This change adds deprecation handling for the signOutOptions prop on the <SignOutButton /> component in the @clerk/vue package. A changeset entry documents the deprecation as a patch release. The component now imports and invokes deprecation reporting when the signOutOptions prop is provided, with a @deprecated JSDoc annotation added to the prop declaration. The prop remains functional while directing users to use redirectUrl and sessionId as top-level props instead.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly and specifically describes the main change: deprecating the signOutOptions prop on the Vue SignOutButton component.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.

Add a configuration file to your project to customize how CodeRabbit runs biome.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/vue/src/components/SignOutButton.vue`:
- Around line 29-31: Add tests for the new deprecation runtime path in
SignOutButton.vue: write unit tests that mount the SignOutButton component with
props.signOutOptions provided and assert that the deprecated('SignOutButton
`signOutOptions`'...) function is called (or that the expected warning/log is
emitted), and also add a backward-compatibility test that passing signOutOptions
still results in the same redirectUrl/sessionId behavior. Use the existing test
utilities (mount/shallowMount) and spy/mocking for the deprecated helper to
observe calls, and include both the warning emission assertion and a functional
assertion that behavior is unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: b0669ab7-995c-4afe-b981-24a95bf982a3

📥 Commits

Reviewing files that changed from the base of the PR and between 35d45be and 043a8f8.

📒 Files selected for processing (2)
  • .changeset/deprecate-vue-signout-options.md
  • packages/vue/src/components/SignOutButton.vue

Comment threadpackages/vue/src/components/SignOutButton.vue
@jacekradko
jacekradko merged commit c44f106 into mainMar 24, 2026
44 checks passed
@jacekradko
jacekradko deleted the jacek/deprecate-vue-signout-options branch March 24, 2026 00:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jacekradko@wobsoriano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(vue): deprecate SignOutButton signOutOptions prop by jacekradko · Pull Request #8148 · clerk/javascript · GitHub
Skip to content

fix(vue): deprecate SignOutButton signOutOptions prop - #8148

Merged
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options
Mar 24, 2026
Merged

fix(vue): deprecate SignOutButton signOutOptions prop#8148
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options

Conversation

@jacekradko

@jacekradkojacekradko commented Mar 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Deprecates the signOutOptions prop on Vue's <SignOutButton /> in favor of the existing flat redirectUrl and sessionId props
  • Adds @deprecated JSDoc annotation and runtime deprecation warning via deprecated() helper
  • signOutOptions still works (backwards compatible) but emits a console warning in development

Companion to #8147 (React). Vue already had the flat props — this just adds the deprecation notice.

Test plan

  • Existing tests pass unchanged (52 tests)
  • npx turbo build --filter=@clerk/vue passes
  • npx turbo test --filter=@clerk/vue passes

Summary by CodeRabbit

  • Deprecations
    • Deprecated signOutOptions prop on <SignOutButton />. Use redirectUrl and sessionId props directly instead. The deprecated prop remains functional with a deprecation warning.

@changeset-bot

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 043a8f8

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

This PR includes changesets to release 2 packages
NameType
@clerk/vuePatch
@clerk/nuxtPatch

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

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

@vercel

vercelBot commented Mar 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 21, 2026 3:30am

Request Review

@pkg-pr-new

Copy link
Copy Markdown

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8148

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8148

@clerk/upgrade

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

@clerk/vue

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

commit: 043a8f8

@coderabbitai

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

This change adds deprecation handling for the signOutOptions prop on the <SignOutButton /> component in the @clerk/vue package. A changeset entry documents the deprecation as a patch release. The component now imports and invokes deprecation reporting when the signOutOptions prop is provided, with a @deprecated JSDoc annotation added to the prop declaration. The prop remains functional while directing users to use redirectUrl and sessionId as top-level props instead.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly and specifically describes the main change: deprecating the signOutOptions prop on the Vue SignOutButton component.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.

Add a configuration file to your project to customize how CodeRabbit runs biome.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/vue/src/components/SignOutButton.vue`:
- Around line 29-31: Add tests for the new deprecation runtime path in
SignOutButton.vue: write unit tests that mount the SignOutButton component with
props.signOutOptions provided and assert that the deprecated('SignOutButton
`signOutOptions`'...) function is called (or that the expected warning/log is
emitted), and also add a backward-compatibility test that passing signOutOptions
still results in the same redirectUrl/sessionId behavior. Use the existing test
utilities (mount/shallowMount) and spy/mocking for the deprecated helper to
observe calls, and include both the warning emission assertion and a functional
assertion that behavior is unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: b0669ab7-995c-4afe-b981-24a95bf982a3

📥 Commits

Reviewing files that changed from the base of the PR and between 35d45be and 043a8f8.

📒 Files selected for processing (2)
  • .changeset/deprecate-vue-signout-options.md
  • packages/vue/src/components/SignOutButton.vue

Comment threadpackages/vue/src/components/SignOutButton.vue
@jacekradko
jacekradko merged commit c44f106 into mainMar 24, 2026
44 checks passed
@jacekradko
jacekradko deleted the jacek/deprecate-vue-signout-options branch March 24, 2026 00:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jacekradko@wobsoriano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' fix(vue): deprecate SignOutButton signOutOptions prop by jacekradko · Pull Request #8148 · clerk/javascript · GitHub
Skip to content

fix(vue): deprecate SignOutButton signOutOptions prop - #8148

Merged
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options
Mar 24, 2026
Merged

fix(vue): deprecate SignOutButton signOutOptions prop#8148
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options

Conversation

@jacekradko

@jacekradkojacekradko commented Mar 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Deprecates the signOutOptions prop on Vue's <SignOutButton /> in favor of the existing flat redirectUrl and sessionId props
  • Adds @deprecated JSDoc annotation and runtime deprecation warning via deprecated() helper
  • signOutOptions still works (backwards compatible) but emits a console warning in development

Companion to #8147 (React). Vue already had the flat props — this just adds the deprecation notice.

Test plan

  • Existing tests pass unchanged (52 tests)
  • npx turbo build --filter=@clerk/vue passes
  • npx turbo test --filter=@clerk/vue passes

Summary by CodeRabbit

  • Deprecations
    • Deprecated signOutOptions prop on <SignOutButton />. Use redirectUrl and sessionId props directly instead. The deprecated prop remains functional with a deprecation warning.

@changeset-bot

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 043a8f8

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

This PR includes changesets to release 2 packages
NameType
@clerk/vuePatch
@clerk/nuxtPatch

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

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

@vercel

vercelBot commented Mar 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 21, 2026 3:30am

Request Review

@pkg-pr-new

Copy link
Copy Markdown

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8148

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8148

@clerk/upgrade

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

@clerk/vue

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

commit: 043a8f8

@coderabbitai

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

This change adds deprecation handling for the signOutOptions prop on the <SignOutButton /> component in the @clerk/vue package. A changeset entry documents the deprecation as a patch release. The component now imports and invokes deprecation reporting when the signOutOptions prop is provided, with a @deprecated JSDoc annotation added to the prop declaration. The prop remains functional while directing users to use redirectUrl and sessionId as top-level props instead.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly and specifically describes the main change: deprecating the signOutOptions prop on the Vue SignOutButton component.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.

Add a configuration file to your project to customize how CodeRabbit runs biome.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/vue/src/components/SignOutButton.vue`:
- Around line 29-31: Add tests for the new deprecation runtime path in
SignOutButton.vue: write unit tests that mount the SignOutButton component with
props.signOutOptions provided and assert that the deprecated('SignOutButton
`signOutOptions`'...) function is called (or that the expected warning/log is
emitted), and also add a backward-compatibility test that passing signOutOptions
still results in the same redirectUrl/sessionId behavior. Use the existing test
utilities (mount/shallowMount) and spy/mocking for the deprecated helper to
observe calls, and include both the warning emission assertion and a functional
assertion that behavior is unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: b0669ab7-995c-4afe-b981-24a95bf982a3

📥 Commits

Reviewing files that changed from the base of the PR and between 35d45be and 043a8f8.

📒 Files selected for processing (2)
  • .changeset/deprecate-vue-signout-options.md
  • packages/vue/src/components/SignOutButton.vue

Comment threadpackages/vue/src/components/SignOutButton.vue
@jacekradko
jacekradko merged commit c44f106 into mainMar 24, 2026
44 checks passed
@jacekradko
jacekradko deleted the jacek/deprecate-vue-signout-options branch March 24, 2026 00:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jacekradko@wobsoriano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(vue): deprecate SignOutButton signOutOptions prop by jacekradko · Pull Request #8148 · clerk/javascript · GitHub
Skip to content

fix(vue): deprecate SignOutButton signOutOptions prop - #8148

Merged
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options
Mar 24, 2026
Merged

fix(vue): deprecate SignOutButton signOutOptions prop#8148
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options

Conversation

@jacekradko

@jacekradkojacekradko commented Mar 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Deprecates the signOutOptions prop on Vue's <SignOutButton /> in favor of the existing flat redirectUrl and sessionId props
  • Adds @deprecated JSDoc annotation and runtime deprecation warning via deprecated() helper
  • signOutOptions still works (backwards compatible) but emits a console warning in development

Companion to #8147 (React). Vue already had the flat props — this just adds the deprecation notice.

Test plan

  • Existing tests pass unchanged (52 tests)
  • npx turbo build --filter=@clerk/vue passes
  • npx turbo test --filter=@clerk/vue passes

Summary by CodeRabbit

  • Deprecations
    • Deprecated signOutOptions prop on <SignOutButton />. Use redirectUrl and sessionId props directly instead. The deprecated prop remains functional with a deprecation warning.

@changeset-bot

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 043a8f8

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

This PR includes changesets to release 2 packages
NameType
@clerk/vuePatch
@clerk/nuxtPatch

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

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

@vercel

vercelBot commented Mar 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 21, 2026 3:30am

Request Review

@pkg-pr-new

Copy link
Copy Markdown

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8148

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8148

@clerk/upgrade

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

@clerk/vue

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

commit: 043a8f8

@coderabbitai

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

This change adds deprecation handling for the signOutOptions prop on the <SignOutButton /> component in the @clerk/vue package. A changeset entry documents the deprecation as a patch release. The component now imports and invokes deprecation reporting when the signOutOptions prop is provided, with a @deprecated JSDoc annotation added to the prop declaration. The prop remains functional while directing users to use redirectUrl and sessionId as top-level props instead.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly and specifically describes the main change: deprecating the signOutOptions prop on the Vue SignOutButton component.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.

Add a configuration file to your project to customize how CodeRabbit runs biome.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/vue/src/components/SignOutButton.vue`:
- Around line 29-31: Add tests for the new deprecation runtime path in
SignOutButton.vue: write unit tests that mount the SignOutButton component with
props.signOutOptions provided and assert that the deprecated('SignOutButton
`signOutOptions`'...) function is called (or that the expected warning/log is
emitted), and also add a backward-compatibility test that passing signOutOptions
still results in the same redirectUrl/sessionId behavior. Use the existing test
utilities (mount/shallowMount) and spy/mocking for the deprecated helper to
observe calls, and include both the warning emission assertion and a functional
assertion that behavior is unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: b0669ab7-995c-4afe-b981-24a95bf982a3

📥 Commits

Reviewing files that changed from the base of the PR and between 35d45be and 043a8f8.

📒 Files selected for processing (2)
  • .changeset/deprecate-vue-signout-options.md
  • packages/vue/src/components/SignOutButton.vue

Comment threadpackages/vue/src/components/SignOutButton.vue
@jacekradko
jacekradko merged commit c44f106 into mainMar 24, 2026
44 checks passed
@jacekradko
jacekradko deleted the jacek/deprecate-vue-signout-options branch March 24, 2026 00:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jacekradko@wobsoriano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(vue): deprecate SignOutButton signOutOptions prop by jacekradko · Pull Request #8148 · clerk/javascript · GitHub
Skip to content

fix(vue): deprecate SignOutButton signOutOptions prop - #8148

Merged
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options
Mar 24, 2026
Merged

fix(vue): deprecate SignOutButton signOutOptions prop#8148
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options

Conversation

@jacekradko

@jacekradkojacekradko commented Mar 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Deprecates the signOutOptions prop on Vue's <SignOutButton /> in favor of the existing flat redirectUrl and sessionId props
  • Adds @deprecated JSDoc annotation and runtime deprecation warning via deprecated() helper
  • signOutOptions still works (backwards compatible) but emits a console warning in development

Companion to #8147 (React). Vue already had the flat props — this just adds the deprecation notice.

Test plan

  • Existing tests pass unchanged (52 tests)
  • npx turbo build --filter=@clerk/vue passes
  • npx turbo test --filter=@clerk/vue passes

Summary by CodeRabbit

  • Deprecations
    • Deprecated signOutOptions prop on <SignOutButton />. Use redirectUrl and sessionId props directly instead. The deprecated prop remains functional with a deprecation warning.

@changeset-bot

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 043a8f8

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

This PR includes changesets to release 2 packages
NameType
@clerk/vuePatch
@clerk/nuxtPatch

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

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

@vercel

vercelBot commented Mar 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 21, 2026 3:30am

Request Review

@pkg-pr-new

Copy link
Copy Markdown

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8148

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8148

@clerk/upgrade

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

@clerk/vue

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

commit: 043a8f8

@coderabbitai

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

This change adds deprecation handling for the signOutOptions prop on the <SignOutButton /> component in the @clerk/vue package. A changeset entry documents the deprecation as a patch release. The component now imports and invokes deprecation reporting when the signOutOptions prop is provided, with a @deprecated JSDoc annotation added to the prop declaration. The prop remains functional while directing users to use redirectUrl and sessionId as top-level props instead.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly and specifically describes the main change: deprecating the signOutOptions prop on the Vue SignOutButton component.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.

Add a configuration file to your project to customize how CodeRabbit runs biome.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/vue/src/components/SignOutButton.vue`:
- Around line 29-31: Add tests for the new deprecation runtime path in
SignOutButton.vue: write unit tests that mount the SignOutButton component with
props.signOutOptions provided and assert that the deprecated('SignOutButton
`signOutOptions`'...) function is called (or that the expected warning/log is
emitted), and also add a backward-compatibility test that passing signOutOptions
still results in the same redirectUrl/sessionId behavior. Use the existing test
utilities (mount/shallowMount) and spy/mocking for the deprecated helper to
observe calls, and include both the warning emission assertion and a functional
assertion that behavior is unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: b0669ab7-995c-4afe-b981-24a95bf982a3

📥 Commits

Reviewing files that changed from the base of the PR and between 35d45be and 043a8f8.

📒 Files selected for processing (2)
  • .changeset/deprecate-vue-signout-options.md
  • packages/vue/src/components/SignOutButton.vue

Comment threadpackages/vue/src/components/SignOutButton.vue
@jacekradko
jacekradko merged commit c44f106 into mainMar 24, 2026
44 checks passed
@jacekradko
jacekradko deleted the jacek/deprecate-vue-signout-options branch March 24, 2026 00:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jacekradko@wobsoriano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); fix(vue): deprecate SignOutButton signOutOptions prop by jacekradko · Pull Request #8148 · clerk/javascript · GitHub
Skip to content

fix(vue): deprecate SignOutButton signOutOptions prop - #8148

Merged
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options
Mar 24, 2026
Merged

fix(vue): deprecate SignOutButton signOutOptions prop#8148
jacekradko merged 1 commit into
mainfrom
jacek/deprecate-vue-signout-options

Conversation

@jacekradko

@jacekradkojacekradko commented Mar 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Deprecates the signOutOptions prop on Vue's <SignOutButton /> in favor of the existing flat redirectUrl and sessionId props
  • Adds @deprecated JSDoc annotation and runtime deprecation warning via deprecated() helper
  • signOutOptions still works (backwards compatible) but emits a console warning in development

Companion to #8147 (React). Vue already had the flat props — this just adds the deprecation notice.

Test plan

  • Existing tests pass unchanged (52 tests)
  • npx turbo build --filter=@clerk/vue passes
  • npx turbo test --filter=@clerk/vue passes

Summary by CodeRabbit

  • Deprecations
    • Deprecated signOutOptions prop on <SignOutButton />. Use redirectUrl and sessionId props directly instead. The deprecated prop remains functional with a deprecation warning.

@changeset-bot

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 043a8f8

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

This PR includes changesets to release 2 packages
NameType
@clerk/vuePatch
@clerk/nuxtPatch

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

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

@vercel

vercelBot commented Mar 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 21, 2026 3:30am

Request Review

@pkg-pr-new

Copy link
Copy Markdown

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8148

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8148

@clerk/upgrade

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

@clerk/vue

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

commit: 043a8f8

@coderabbitai

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

This change adds deprecation handling for the signOutOptions prop on the <SignOutButton /> component in the @clerk/vue package. A changeset entry documents the deprecation as a patch release. The component now imports and invokes deprecation reporting when the signOutOptions prop is provided, with a @deprecated JSDoc annotation added to the prop declaration. The prop remains functional while directing users to use redirectUrl and sessionId as top-level props instead.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly and specifically describes the main change: deprecating the signOutOptions prop on the Vue SignOutButton component.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.

Add a configuration file to your project to customize how CodeRabbit runs biome.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/vue/src/components/SignOutButton.vue`:
- Around line 29-31: Add tests for the new deprecation runtime path in
SignOutButton.vue: write unit tests that mount the SignOutButton component with
props.signOutOptions provided and assert that the deprecated('SignOutButton
`signOutOptions`'...) function is called (or that the expected warning/log is
emitted), and also add a backward-compatibility test that passing signOutOptions
still results in the same redirectUrl/sessionId behavior. Use the existing test
utilities (mount/shallowMount) and spy/mocking for the deprecated helper to
observe calls, and include both the warning emission assertion and a functional
assertion that behavior is unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: b0669ab7-995c-4afe-b981-24a95bf982a3

📥 Commits

Reviewing files that changed from the base of the PR and between 35d45be and 043a8f8.

📒 Files selected for processing (2)
  • .changeset/deprecate-vue-signout-options.md
  • packages/vue/src/components/SignOutButton.vue

Comment threadpackages/vue/src/components/SignOutButton.vue
@jacekradko
jacekradko merged commit c44f106 into mainMar 24, 2026
44 checks passed
@jacekradko
jacekradko deleted the jacek/deprecate-vue-signout-options branch March 24, 2026 00:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jacekradko@wobsoriano