Skip to content

docs(nextjs): add @deprecated tag to removed control-component stubs #9627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
manovotny merged 2 commits into from
Sep 1, 2026
Merged

docs(nextjs): add @deprecated tag to removed control-component stubs #9627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9047c1f
docs(nextjs): Add @deprecated tag to removed control-component stubs
manovotny Aug 31, 2026
4de35ca
docs(nextjs): Name the removal version in @deprecated tags
manovotny Aug 31, 2026
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/deprecated-tag-removed-control-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/nextjs': patch
---

Add `@deprecated` tags to the removed `<SignedIn>`, `<SignedOut>`, and `<Protect>` control-component stubs so editors and lint rules flag them at authoring time (with the `<Show>` migration guidance) instead of only failing when rendered.
6 changes: 6 additions & 0 deletions packages/nextjs/src/removedControlComponents.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ function throwRemovedControlComponentError(
* - Core 3 changelog: https://clerk.com/changelog/2026-03-03-core-3
* - Core 3 upgrade guide: https://clerk.com/docs/guides/development/upgrading/upgrade-guides/core-3
* - `<Show>` component docs: https://clerk.com/docs/reference/components/control/show
*
* @deprecated Removed in Clerk Core 3 (`@clerk/nextjs@7.0.0`). Rendering `<SignedIn>` throws an error. Use `<Show when="signed-in">` instead — see https://clerk.com/docs/guides/development/upgrading/upgrade-guides/core-3.
*/
export function SignedIn(_props: RemovedControlComponentProps): never {
return throwRemovedControlComponentError(
Expand Down Expand Up @@ -58,6 +60,8 @@ export function SignedIn(_props: RemovedControlComponentProps): never {
* - Core 3 changelog: https://clerk.com/changelog/2026-03-03-core-3
* - Core 3 upgrade guide: https://clerk.com/docs/guides/development/upgrading/upgrade-guides/core-3
* - `<Show>` component docs: https://clerk.com/docs/reference/components/control/show
*
* @deprecated Removed in Clerk Core 3 (`@clerk/nextjs@7.0.0`). Rendering `<SignedOut>` throws an error. Use `<Show when="signed-out">` instead — see https://clerk.com/docs/guides/development/upgrading/upgrade-guides/core-3.
*/
export function SignedOut(_props: RemovedControlComponentProps): never {
return throwRemovedControlComponentError(
Expand Down Expand Up @@ -90,6 +94,8 @@ export function SignedOut(_props: RemovedControlComponentProps): never {
* - Core 3 changelog: https://clerk.com/changelog/2026-03-03-core-3
* - Core 3 upgrade guide: https://clerk.com/docs/guides/development/upgrading/upgrade-guides/core-3
* - `<Show>` component docs: https://clerk.com/docs/reference/components/control/show
*
* @deprecated Removed in Clerk Core 3 (`@clerk/nextjs@7.0.0`). Rendering `<Protect>` throws an error. Use `<Show when={...}>` instead — see https://clerk.com/docs/guides/development/upgrading/upgrade-guides/core-3.
*/
export function Protect(_props: RemovedControlComponentProps): never {
return throwRemovedControlComponentError('Protect', 'https://clerk.com/err/protect-is-not-available-in-clerk-nextjs');
Expand Down
Loading