<CreateOrganization />
The <CreateOrganization />
component is used to render an organization creation UI that allows users to create brand new organizations within your application.
<CreateOrganization />
properties
All props below are optional.
Name | Type | Description |
---|---|---|
afterCreateOrganizationUrl | string | Full URL or path to navigate after creating a new organization. |
routing | 'hash' | 'path' | 'virtual' | The routing strategy for your pages. Defaults to 'path' . |
path | string | The path where the component is mounted when path-based routing is used. For example, /create-org This prop is ignored in hash- and virtual-based routing. |
appearance | Appearance | undefined | Optional object to style your components. Will only affect Clerk Components and not Account Portal pages. |
How to use the <CreateOrganization />
component
/app/create-organization/[[...create-organization]]/page.tsximport { CreateOrganization } from "@clerk/nextjs"; export default function CreateOrganizationPage() { return <CreateOrganization />; }
/pages/create-organization/[[...index]].tsximport { CreateOrganization } from "@clerk/nextjs"; export default function CreateOrganizationPage() { return ( <CreateOrganization routing="path" path="/create-organization" /> ) }
/create-organization.tsximport { CreateOrganization } from "@clerk/clerk-react"; export default function CreateOrganizationPage() { return <CreateOrganization />; }
/route/create-organization/$.tsximport { CreateOrganization } from "@clerk/remix"; export default function CreateOrganizationPage() { return <CreateOrganization />; }
How to customize the <CreateOrganization />
component
To learn about how to customize Clerk components, see the customization documentation.