diff --git a/.changeset/organization-switcher-hide-personal-doc.md b/.changeset/organization-switcher-hide-personal-doc.md new file mode 100644 index 00000000000..837e897b942 --- /dev/null +++ b/.changeset/organization-switcher-hide-personal-doc.md @@ -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`. diff --git a/packages/shared/src/types/clerk.ts b/packages/shared/src/types/clerk.ts index 49f7875870c..f8fde1d122d 100644 --- a/packages/shared/src/types/clerk.ts +++ b/packages/shared/src/types/clerk.ts @@ -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 */ hidePersonal?: boolean; /** @@ -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; /**