<OrganizationList /> component
The <OrganizationList /> component displays Organization-related memberships and automatic invitations and suggestions for the user.
Example
The following example includes a basic implementation of the <OrganizationList /> component. You can use this as a starting point for your own implementation.
import { OrganizationList } from '@clerk/clerk-expo/web'
export default function OrganizationListPage() {
return (
<OrganizationList
afterCreateOrganizationUrl={(org) => `/organization/${org.slug}`}
afterSelectPersonalUrl={(user) => `/user/${user.id}`}
afterSelectOrganizationUrl={(org) => `/organization/${org.slug}`}
/>
)
}Properties
The <OrganizationList /> component accepts the following properties, all of which are optional:
- Name
afterCreateOrganizationUrl- Type
((org: Organization) => string) | string- Description
The full URL or path to navigate to after creating a new Organization.
- Name
afterSelectOrganizationUrl- Type
((org: Organization) => string) | string- Description
The full URL or path to navigate to after selecting an Organization. Defaults to
undefined.
- Name
afterSelectPersonalUrl- Type
((org: Organization) => string) | string- Description
The full URL or path to navigate to after selecting the . Defaults to
undefined.
- Name
appearance- Type
Appearance | undefined- Description
Optional object to style your components. Will only affect Clerk components and not Account Portal pages.
- Name
fallback?- Type
ReactNode- Description
An optional element to be rendered while the component is mounting.
- Name
hidePersonal- Type
boolean- Description
A boolean that controls whether
<OrganizationList />will include the user's in the Organization list. Setting this totruewill hide the Personal Account option, and users will only be able to switch between Organizations. Defaults tofalse.
- Name
hideSlug- Type
boolean- Description
A boolean that controls whether the optional slug field in the Organization creation screen is hidden. Defaults to
false.
- Name
skipInvitationScreen- Type
boolean | undefined- Description
A boolean that controls whether the screen for sending invitations after an Organization is created is hidden. When
undefined, Clerk will automatically hide the screen if the number of max allowed members is equal to 1. Defaults tofalse.
Customization
To learn about how to customize Clerk components, see the customization documentation.
Feedback
Last updated on
Edit on GitHub