thibaud-lclr/api-client
1
0
Fork 0
Code Packages Activity Actions

docs(common): clarify desktop organization switching behavior

Browse source
This commit is contained in:
James George 2025-12-19 12:48:48 +05:30
parent 3d8810ec74
commit a0bc22968d
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
packages/hoppscotch-common/src/platform/organization.ts
View file

@ -11,20 +11,23 @@ export type OrganizationPlatformDef = {
} | null>
getRootDomain: () => string
initiateOnboarding: () => void
/**
* Whether organization switching is enabled for this platform
* If true, an organization switcher will be shown
*/
organizationSwitchingEnabled?: boolean
/**
* Custom component for the organization sidebar
* If provided, will be shown as a sidebar in the layout
*/
customOrganizationSidebarComponent?: Component
/**
* Switch to a specific organization instance or default cloud instance
* For web: redirects to the target URL
* For desktop: downloads the organization bundle and connects
* For desktop: loads the organization bundle and connects
* @param orgDomain - The organization domain (null for default cloud instance)
*/
switchToInstance?: (orgDomain: string | null) => void | Promise<void>