Skip to content

docs(shared): correct the hidePersonal docs on OrganizationSwitcherProps and OrganizationListProps #9707

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

Open
alexcarpenter wants to merge 2 commits into
base: main
Choose a base branch
from
+9 −4
Open

docs(shared): correct the hidePersonal docs on OrganizationSwitcherProps and OrganizationListProps #9707

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
10fc9e8
docs(shared): correct the hidePersonal default on OrganizationSwitche…
alexcarpenter Sep 10, 2026
be84d51
docs(shared): correct the hidePersonal default on OrganizationListPro…
alexcarpenter Sep 10, 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/organization-switcher-hide-personal-doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Correct the `hidePersonal` documentation on `OrganizationSwitcherProps` and `OrganizationListProps`: setting it to `true` hides the personal account entry, and it defaults to `false`.
8 changes: 4 additions & 4 deletions packages/shared/src/types/clerk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2340,10 +2340,10 @@ export type OrganizationSwitcherProps = CreateOrganizationMode &
/**
* By default, users can switch between Organization and their personal account.
* This option controls whether OrganizationSwitcher will include the user's personal account
* in the Organization list. Setting this to `false` will hide the personal account entry,
* in the Organization list. Setting this to `true` will hide the personal account entry,
* and users will only be able to switch between Organizations.
*
* @default true
* @default false
Comment thread
coderabbitai[bot] marked this conversation as resolved.
*/
hidePersonal?: boolean;
/**
Expand Down Expand Up @@ -2427,10 +2427,10 @@ export type OrganizationListProps = {
/**
* By default, users can switch between Organization and their personal account.
* This option controls whether OrganizationList will include the user's personal account
* in the Organization list. Setting this to `false` will hide the personal account entry,
* in the Organization list. Setting this to `true` will hide the personal account entry,
* and users will only be able to switch between Organizations.
*
* @default true
* @default false
*/
hidePersonal?: boolean;
/**
Expand Down
Loading