<CreateOrganization /> component
The <CreateOrganization /> component is used to render an organization creation UI that allows users to create brand new organizations in your application.
Properties
All props are optional.
- Name
appearance- Type
Appearance | undefined- Description
Optional object to style your components. Will only affect Clerk components and not Account Portal pages.
- Name
afterCreateOrganizationUrl- Type
string- Description
Full URL or path to navigate to after creating a new organization.
- Name
routing- Type
'hash' | 'path'- Description
The routing strategy for your pages. Defaults to
'path'for frameworks that handle routing, such as Next.js and Remix. Defaults tohashfor all other SDK's, such as React.
- Name
path- Type
string- Description
The path where the component is mounted on when
routingis set topath. It is ignored in hash-based routing. For example:/create-organization.
- Name
skipInvitationScreen- Type
boolean- Description
Hides the screen for sending invitations after an organization is created. When left undefined, Clerk will automatically hide the screen if the number of max allowed members is equal to 1
- Name
hideSlug- Type
boolean- Description
Hides the optional slug field in the organization creation screen.
- Name
fallback?- Type
ReactNode- Description
An optional element to be rendered while the component is mounting.
Usage with frameworks
The following example includes a basic implementation of the <CreateOrganization /> component. You can use this as a starting point for your own implementation.
---
import { CreateOrganization } from '@clerk/astro/components'
---
<CreateOrganization />Customization
To learn about how to customize Clerk components, see the customization documentation.
Feedback
Last updated on