Skip to content

docs(repo): Update description of isSatellite prop for satellite domains guide #8845

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
wobsoriano merged 5 commits into from
Jun 13, 2026
+6 −1
Merged

docs(repo): Update description of isSatellite prop for satellite domains guide #8845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ef25a12
Revamp descriptipn
SarahSoutoul Jun 9, 2026
83f9834
Merge branch 'main' into ss/DOCS-11525
SarahSoutoul Jun 12, 2026
1eab81e
Add changeset
SarahSoutoul Jun 12, 2026
0580610
Update packages/shared/src/types/clerk.ts
SarahSoutoul Jun 12, 2026
b5c258b
docs(shared): use absolute links and styleguide wording for isSatelli…
manovotny Jun 13, 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/silver-poems-repeat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Clarify the `isSatellite` JSDoc to note it must be set in `load()`, unlike `domain`, which is set in the `Clerk` constructor. This corrects the generated API reference for direct `@clerk/clerk-js` and `<script>` consumers, where `load()` is the only way to configure a satellite app.
2 changes: 1 addition & 1 deletion packages/shared/src/types/clerk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1357,7 +1357,7 @@ export type ClerkOptions = ClerkOptionsNavigation &
*/
allowedRedirectProtocols?: Array<string>;
/**
* Indicates whether the application is a satellite application.
* Indicates whether the current application should behave as a satellite app. Unlike `domain`, which must be set in the [`Clerk` constructor](https://clerk.com/docs/reference/objects/clerk), `isSatellite` must be set in [`load()`](https://clerk.com/docs/reference/objects/clerk#load).
*/
isSatellite?: boolean | ((url: URL) => boolean);
/**
Expand Down
Loading