Skip to main content
Docs

Add custom pages and links to the <OrganizationProfile /> component

The <OrganizationProfile /> component supports the addition of custom pages and external links to the component's sidenav. It only accepts the following components as children:

  • <OrganizationSwitcher.OrganizationProfilePage /> or <OrganizationProfile.Page /> to add a custom page.
  • <OrganizationSwitcher.OrganizationProfileLink /> or <OrganizationProfile.Link /> to add a custom link.

You can also reorder default routes.

Before you start

Before you start, it's important to understand how the <OrganizationProfile /> can be accessed:

  • As a modal: When a user selects the <OrganizationSwitcher /> component and then selects the Manage Organization option, the <OrganizationProfile /> will open as a modal by default.
  • As a dedicated page: You can embed the <OrganizationProfile /> component itself in a dedicated page.

This guide includes examples for both use cases. On the code examples, you can select one of the following two tabs to see the implementation for your preferred use case:

  • <OrganizationSwitcher /> tab: By default, the <OrganizationSwitcher /> sets organizationProfileMode='modal'. If you are using the default settings, then you should select this tab.
  • Dedicated page tab: If you do not want the <OrganizationProfile /> to open as a modal, then you should select this tab. For these examples, on the <OrganizationSwitcher /> component, you need to set organizationProfileMode='navigation' and organizationProfileUrl='/organization-profile'.

Add a custom page

To add a custom page to the <OrganizationProfile /> component, you will need to use one of the following components, depending on the use case mentioned in the Before you start section.

Use caseComponent to use
<OrganizationSwitcher /> component<OrganizationSwitcher.OrganizationProfilePage />
Dedicated page with the <OrganizationProfile /> component<OrganizationProfile.Page />

Props

<OrganizationSwitcher.OrganizationProfilePage /> and <OrganizationProfile.Page /> accept the following props, all of which are required:

  • Name
    label
    Type
    string
    Description

    The name that will be displayed in the navigation sidenav for the custom page.

  • Name
    labelIcon
    Type
    React.ReactElement
    Description

    An icon displayed next to the label in the navigation sidenav.

  • Name
    url
    Type
    string
    Description

    The path segment that will be used to navigate to the custom page. For example, if the <OrganizationProfile /> component is rendered at /organization, then the custom page will be accessed at /organization/{url} when using path routing.

  • Name
    children
    Type
    React.ReactElement
    Description

    The content to be rendered inside the custom page.

Example

App.vue
<script setup lang="ts">
import { OrganizationSwitcher } from '@clerk/vue'
</script>

<template>
  <header>
    <OrganizationSwitcher>
      <OrganizationSwitcher.OrganizationProfilePage label="Custom Page" url="custom">
        <template #labelIcon>
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" fill="currentColor">
            <path d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512z"></path>
          </svg>
        </template>
        <div>
          <h1>Custom page</h1>
          <p>This is the content of the custom page.</p>
        </div>
      </OrganizationSwitcher.OrganizationProfilePage>
    </OrganizationSwitcher>
  </header>
</template>
pages/organization-profile.vue
<script setup lang="ts">
import { OrganizationProfile } from '@clerk/vue'
</script>

<template>
  <OrganizationProfile>
    <OrganizationProfile.Page label="Custom Page" url="custom">
      <template #labelIcon>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" fill="currentColor">
          <path d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512z"></path>
        </svg>
      </template>
      <div>
        <h1>Custom page</h1>
        <p>This is the content of the custom page.</p>
      </div>
    </OrganizationProfile.Page>
  </OrganizationProfile>
</template>

To add a custom link to the <OrganizationProfile /> navigation sidenav, you will need to use one of the following components, depending on the use case mentioned in the Before you start section.

Use caseComponent to use
<OrganizationSwitcher /> component<OrganizationSwitcher.OrganizationProfileLink />
Dedicated page with the <OrganizationProfile /> component<OrganizationProfile.Link />

Props

<OrganizationSwitcher.OrganizationProfileLink /> and <OrganizationProfile.Link /> accept the following props, all of which are required:

  • Name
    label
    Type
    string
    Description

    The name that will be displayed in the navigation sidenav for the link.

  • Name
    labelIcon
    Type
    React.ReactElement
    Description

    An icon displayed next to the label in the navigation sidenav.

  • Name
    url
    Type
    string
    Description

    The full URL or path that will be used to navigate to the external link. For path segments, if the <OrganizationProfile /> component is rendered at /organization, then the external link will be accessed at /organization/{url} when using path routing.

Example

The following example adds a custom link to the <OrganizationProfile /> sidenav that navigates to the homepage.

App.vue
<script setup lang="ts">
import { OrganizationSwitcher } from '@clerk/vue'
</script>

<template>
  <header>
    <OrganizationSwitcher>
      <OrganizationSwitcher.OrganizationProfileLink label="Homepage" url="/">
        <template #labelIcon>
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" fill="currentColor">
            <path d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512z"></path>
          </svg>
        </template>
      </OrganizationSwitcher.OrganizationProfileLink>
    </OrganizationSwitcher>
  </header>
</template>
pages/organization-profile.vue
<script setup lang="ts">
import { OrganizationProfile } from '@clerk/vue'
</script>

<template>
  <OrganizationProfile>
    <OrganizationProfile.Link label="Homepage" url="/">
      <template #labelIcon>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" fill="currentColor">
          <path d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512z"></path>
        </svg>
      </template>
    </OrganizationProfile.Link>
  </OrganizationProfile>
</template>

Reorder default routes

The <OrganizationProfile /> component includes two default menu items: Members and General, in that order. You can reorder these default items by setting the label prop to 'members' or 'general'. This will target the existing default item and allow you to rearrange it.

Note that when reordering default routes, the first item in the navigation sidenav cannot be a custom link.

Example

The following example adds a custom page as the first item in the sidenav, followed by a custom link to the homepage, and then the default Members and General pages.

App.vue
<script setup lang="ts">
import { OrganizationSwitcher } from '@clerk/vue'
</script>

<template>
  <header>
    <OrganizationSwitcher>
      <OrganizationSwitcher.OrganizationProfilePage label="Custom Page" url="custom">
        <template #labelIcon>
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" fill="currentColor">
            <path d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512z"></path>
          </svg>
        </template>
        <div>
          <h1>Custom page</h1>
          <p>This is the content of the custom page.</p>
        </div>
      </OrganizationSwitcher.OrganizationProfilePage>
      <OrganizationSwitcher.OrganizationProfileLink label="Homepage" url="/">
        <template #labelIcon>
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" fill="currentColor">
            <path d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512z"></path>
          </svg>
        </template>
      </OrganizationSwitcher.OrganizationProfileLink>
      <OrganizationSwitcher.OrganizationProfilePage label="members" />
      <OrganizationSwitcher.OrganizationProfilePage label="general" />
    </OrganizationSwitcher>
  </header>
</template>
pages/organization-profile.vue
<script setup lang="ts">
import { OrganizationProfile } from '@clerk/vue'
</script>

<template>
  <OrganizationProfile>
    <OrganizationProfile.Page label="Custom Page" url="custom">
      <template #labelIcon>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" fill="currentColor">
          <path d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512z"></path>
        </svg>
      </template>
      <div>
        <h1>Custom page</h1>
        <p>This is the content of the custom page.</p>
      </div>
    </OrganizationProfile.Page>
    <OrganizationProfile.Link label="Homepage" url="/">
      <template #labelIcon>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" fill="currentColor">
          <path d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512z"></path>
        </svg>
      </template>
    </OrganizationProfile.Link>
    <OrganizationProfile.Page label="members" />
    <OrganizationProfile.Page label="general" />
  </OrganizationProfile>
</template>

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on