<OrganizationProfile />
component
The <OrganizationProfile />
component is used to render a beautiful, full-featured organization management UI that allows users to manage their organization profile and security settings.
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
afterLeaveOrganizationUrl
- Type
string
- Description
Full URL or path to navigate to after leaving an organization.
- Name
routing
- Type
'hash' | 'path' | 'virtual'
- Description
The routing strategy for your pages.
- Name
path
- Type
string
- Description
The path where the component is mounted when path-based routing is used.
For example:/organization-profile
This prop is ignored in hash- and virtual-based routing.
You can embed the <OrganizationProfile />
component using the Next.js optional catch-all route. This allows you to redirect the user inside your application.
Usage with JavaScript
The following methods available on an instance of the Clerk
class are used to render and control the <OrganizationProfile />
component:
mountOrganizationProfile()
unmountOrganizationProfile()
openOrganizationProfile()
closeOrganizationProfile()
The following examples assume that you have followed the quickstart in order to add Clerk to your JavaScript application.
mountOrganizationProfile()
Render the <OrganizationProfile />
component to an HTML <div>
element.
- Name
node
- Type
HTMLDivElement
- Description
The
<div>
element used to render in the<OrganizationProfile />
component
- Name
props?
- Type
OrganizationProfileProps
- Description
The properties to pass to the
<OrganizationProfile />
component
unmountOrganizationProfile()
Unmount and run cleanup on an existing <OrganizationProfile />
component instance.
- Name
node
- Type
HTMLDivElement
- Description
The container
<div>
element with a rendered<OrganizationProfile />
component instance.
openOrganizationProfile()
Opens the <OrganizationProfile />
component as an overlay at the root of your HTML body
element.
- Name
props?
- Type
OrganizationProfileProps
- Description
The properties to pass to the
<OrganizationProfile />
component
closeOrganizationProfile()
Closes the organization profile overlay.
Customization
To learn about how to customize Clerk components, see the customization documentation.
In addition, you also can add custom pages and links to the <OrganizationProfile />
(/docs/components/customization/organization-profile).
Feedback
Last updated on