Skip to content

Commit 0bc08d4

Browse files
authored
(chore) sidebar --> sidenav (#2061)
1 parent 57cc333 commit 0bc08d4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+87
-77
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -839,7 +839,7 @@ The `<Include />` component can be used to inject the contents of another MDX fi
839839

840840
### `<If />`
841841

842-
The `<If />` component is used for conditional rendering. When the conditions are true, it displays its contents. When the conditions are false, it hides its contents. We commonly use this component to conditionally render content based on the **active SDK**. The **active SDK** is the SDK that is selected in the sidebar.
842+
The `<If />` component is used for conditional rendering. When the conditions are true, it displays its contents. When the conditions are false, it hides its contents. We commonly use this component to conditionally render content based on the **active SDK**. The **active SDK** is the SDK that is selected in the sidenav.
843843

844844
> [!IMPORTANT]
845845
> This component cannot be used within code blocks.

docs/_partials/authentication/microsoft/create-app.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
> If you already have a Microsoft Entra ID app you'd like to connect to Clerk, select your app from the [Microsoft Azure portal](https://portal.azure.com/#home) and skip to [the next step in this tutorial](#get-your-client-id-and-client-secret).
33
44
1. On the homepage of the [Microsoft Azure portal](https://portal.azure.com/#home), in the **Azure services** section, select **[Microsoft Entra ID](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview)**.
5-
1. In the sidebar, open the **Manage** dropdown and select **[App registrations](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps)**.
5+
1. In the sidenav, open the **Manage** dropdown and select **[App registrations](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps)**.
66
1. Select **New Registration**. You'll be redirected to the **Register an application** page.
77
1. Complete the form as follows:
88
1. Under **Name**, enter your app name.
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1. In the left sidebar, open the **Manage** dropdown and select **Authentication**.
1+
1. In the left sidenav, open the **Manage** dropdown and select **Authentication**.
22
1. In the **Front-channel logout URL** field, paste the **Redirect URI** you copied from the Clerk Dashboard.
33
1. Under **Implicit grant and hybrid flows**, check both **Access tokens** and **ID tokens**.
44
1. Select **Save** to save the changes.

docs/_partials/authentication/microsoft/get-client-id-secret.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
1. From your app's **Overview** page, save the **Application (client) ID** somewhere secure.
2-
1. In the sidebar, select **Certificates & secrets**.
2+
1. In the sidenav, select **Certificates & secrets**.
33
1. Select **New client secret**.
44
1. In the modal that opens, enter a description and set an expiration time for your secret.
55
> [!WARNING]

docs/_partials/authentication/microsoft/noauth.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ For further security, Microsoft offers an optional `xms_edov` [claim](https://le
44

55
To enable it, you must:
66

7-
1. In the left sidebar, in the **Manage** dropdown, select **Token configuration**.
7+
1. In the left sidenav, in the **Manage** dropdown, select **Token configuration**.
88
1. Select **Add optional claim**.
99
1. For the **Token type**, select **ID**. Then, in the table that opens, enable the `email` and `xms_pdl` claims.
1010
1. At the bottom of the modal, select **Add**. A new modal will prompt you to turn on the Microsoft Graph email permission. Enable it, then select **Add** to complete the form.
1111
1. Repeat the previous steps but for **Token type**, select **Access** instead of **ID**. The **Optional claims** list should now show two claims for `email` and two for `xms_pdl`: one each for **ID** and **Access**.
12-
1. In the left sidebar, in the **Manage** dropdown, select **Manifest**.
12+
1. In the left sidenav, in the **Manage** dropdown, select **Manifest**.
1313
1. In the text editor, search for `"acceptMappedClaims"` and set its value from `null` to `true`.
1414
1. Search for `"optionalClaims"`, where you'll find the `idToken` and `accessToken` arrays. Each array has an object with the name `xms_pdl`. Change the name to `xms_edov`.
1515
1. At the top of the page, select **Save**.
16-
1. In the left sidebar, in the **Manage** dropdown, select **Token configuration** to confirm that the **Optional claims** list includes two claims for `email` and two for `xms_edov`: one each for **ID** and **Access**.
16+
1. In the left sidenav, in the **Manage** dropdown, select **Token configuration** to confirm that the **Optional claims** list includes two claims for `email` and two for `xms_edov`: one each for **ID** and **Access**.
1717

1818
With these steps complete, Microsoft will send the `xms_edov` claim in the token, which Clerk will use to determine whether the email is verified, even when used with Microsoft Entra ID.

docs/authentication/enterprise-connections/easie/google.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
6060
1. Navigate to the [Google Cloud Console](https://console.cloud.google.com/).
6161
1. Select a project or [create a new one](https://console.cloud.google.com/projectcreate).
6262
1. If the **APIs & Services** page isn't already open, open the menu on the left and select **APIs & Services**.
63-
1. In the left sidebar, select **Credentials**.
63+
1. In the left sidenav, select **Credentials**.
6464
1. Select **Create Credentials**. Then, select **OAuth client ID.** You may need to [configure your OAuth consent screen](https://support.google.com/cloud/answer/6158849?hl=en#userconsent\&zippy=%2Cuser-consent).
6565
1. Select the appropriate application type for your project. Most likely, you will choose **Web application**.
6666
1. In the **Authorized redirect URIs** section, select **Add URI** and paste the **Redirect URI** value you saved from the Clerk Dashboard.

docs/authentication/enterprise-connections/saml/azure.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
6262

6363
After assigning the user or group to the enterprise app, you need to configure the SSO settings in Microsoft to enable SAML SSO.
6464

65-
1. In the navigation sidebar, open the **Manage** dropdown and select **Single sign-on**.
65+
1. In the navigation sidenav, open the **Manage** dropdown and select **Single sign-on**.
6666
1. In the **Select a single sign-on method** section, select **SAML**. You'll be redirected to the **Set up Single Sign-On with SAML** page.
6767
1. Find the **Basic SAML Configuration** section.
6868
1. Select **Edit**. The **Basic SAML Configuration** panel will open.

docs/authentication/enterprise-connections/saml/google.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
3838
## Create a new enterprise application in Google
3939

4040
1. Navigate to the [Google Admin Console](https://admin.google.com/) and sign in.
41-
1. In the navigation sidebar, under **Apps**, select **Web and mobile apps**.
41+
1. In the navigation sidenav, under **Apps**, select **Web and mobile apps**.
4242
1. Select the **Add app** button.
4343
1. From the dropdown, select **Add custom SAML app**.
4444
1. In the **App details** section, an **App name** is required.

docs/authentication/enterprise-connections/saml/okta.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
3939

4040
1. Navigate to [Okta](https://www.okta.com/) and sign in.
4141
1. In the Okta dashboard, select **Admin** in the top right corner.
42-
1. In the navigation sidebar, select the **Applications** dropdown and select **Applications**.
42+
1. In the navigation sidenav, select the **Applications** dropdown and select **Applications**.
4343
1. Select **Create App Integration**.
4444
1. In the **Create a new app integration** modal, select the **SAML 2.0** option and select the **Next** button.
4545
1. Once redirected to the **Create SAML Integration** page, complete the **General Settings** fields. An **App name** is required.

docs/authentication/social-connections/apple.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
9696

9797
To get your **Apple Private Key** and **Key ID**, create a new **Key** in the Apple Developer portal.
9898

99-
1. On the **Identifiers** page, in the sidebar, select **Keys**.
99+
1. On the **Identifiers** page, in the sidenav, select **Keys**.
100100
1. Next to **Keys** at the top of the page, select the plus icon (+) to register a new key. You'll be redirected to the **Register a New Key** page.
101101
1. Add a **Key Name** and ensure the **Sign In with Apple** box is enabled and select **Configure**. You'll be redirected to the **Configure Key** page.
102102
1. Under **Primary App ID**, select the **App ID** you created in the first step of this guide. Then select **Save**. You'll be redirected to the previous **Register a New Key** page.
@@ -113,7 +113,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
113113

114114
To be able to send emails properly to users with hidden addresses, you must configure an additional setting in the Apple Developer portal.
115115

116-
1. In the sidebar, select **Services**.
116+
1. In the sidenav, select **Services**.
117117
1. Under **Sign in with Apple for Email Communication**, select **Configure**. You'll be redirected to the **Configure Sign in with Apple for Email Communication** page.
118118
1. Next to **Email Sources** at the top of the page, select the plus icon (+) to add a new **Email Source**.
119119
1. In the **Register your email sources** modal that opens, under **Email Addresses**, add the **Email Source for Apple Private Email Relay** value that you saved from the Clerk Dashboard. It should look something like this: `[email protected]`.

docs/authentication/social-connections/atlassian.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,14 @@ To make the setup process easier, it's recommended to keep two browser tabs open
5656

5757
### Configure your Atlassian app
5858

59-
1. In the left sidebar of your app's **Overview** page, select **Permissions**. Configure the OAuth 2.0 scopes to request from your users when they connect with Atlassian. At a minimum, next to **User identity API**, select **Add**.
60-
1. In the left sidebar, select **Authorization**.
59+
1. In the left sidenav of your app's **Overview** page, select **Permissions**. Configure the OAuth 2.0 scopes to request from your users when they connect with Atlassian. At a minimum, next to **User identity API**, select **Add**.
60+
1. In the left sidenav, select **Authorization**.
6161
1. Next to **OAuth 2.0 (3LO)**, select **Add**.
6262
1. In the **Callback URL** field, paste the **Callback URL** you saved from the Clerk Dashboard.
6363
1. Select **Save changes**.
64-
1. In the left sidebar, select **Settings**.
64+
1. In the left sidenav, select **Settings**.
6565
1. Under **Authentication details**, save the **Client ID** and **Secret** somewhere secure.
66-
1. In the left sidebar, select **Distribution**.
66+
1. In the left sidenav, select **Distribution**.
6767
1. Select **Edit**.
6868
1. Set the **Distribution Status** to **Sharing**.
6969
1. Complete the required fields. For **Does your app store personal data?**, select **Yes**, as Clerk uses the user's personal data to authenticate them.

docs/authentication/social-connections/bitbucket.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
5050

5151
1. On a separate page, go to the [Bitbucket Workspaces](https://bitbucket.org/account/workspaces/) page and sign in.
5252
1. Under **Workspaces**, find your workspace and select **Manage**.
53-
1. In the sidebar, scroll down and select **OAuth consumers**.
53+
1. In the sidenav, scroll down and select **OAuth consumers**.
5454
1. Select **Add consumer**.
5555
1. Complete the required fields. In **Permissions** , under **Account**, select **Email** and **Read**.
5656
1. Select **Save**. You'll be redirected to the **OAuth consumers** page.

docs/authentication/social-connections/discord.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
5151
1. On a separate page, go to the [Discord Developer Portal](https://discord.com/developers/applications) and sign in.
5252
1. In the top-right, select **New Application**.
5353
1. Complete the required fields and select **Create**. You'll be redirected to the **General Information** page.
54-
1. In the left sidebar, select **OAuth2**.
54+
1. In the left sidenav, select **OAuth2**.
5555
1. Under **Redirects**, select **Add Redirect**. Paste the **Redirect URI** you saved from the Clerk Dashboard.
5656
1. Select **Save Changes**. You may need to tap anywhere on the screen for the button to show.
5757
1. Save the **Client ID** and **Client Secret** somewhere secure. If you don't see the **Copy** button under the **Client Secret**, select **Reset Secret** to generate a new one.

docs/authentication/social-connections/facebook.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,13 @@ To make the setup process easier, it's recommended to keep two browser tabs open
5454
1. In the **Use Cases** step, select **Authenticate and request data from users with Facebook Login** and then select **Next**.
5555
1. In the **Business** step, select the business portfolio to connect to your app and then select **Next**.
5656
1. In the **Finalize** step, select **Go to dashboard**. You'll be redirected to the app's **Dashboard** page.
57-
1. In the left sidebar, select **Use cases**.
57+
1. In the left sidenav, select **Use cases**.
5858
1. Next to **Authenticate and request data from users with Facebook Login**, select **Customize**. You'll be redirected to the **Permissions** tab of the **Customize use case** page.
5959
1. Next to **email**, select **Add**. This permission allows Clerk to read your user's primary email address.
60-
1. In the left sidebar, under **Facebook Login**, select **Settings**.
60+
1. In the left sidenav, under **Facebook Login**, select **Settings**.
6161
1. In the **Client OAuth settings** section, in the **Valid OAuth Redirect URIs** field, paste the **Redirect URI** value you saved from the Clerk Dashboard.
6262
1. Select **Save changes**.
63-
1. In the left sidebar, select **App settings** (hover over the settings icon to view the title or expand the menu), and then select **Basic**.
63+
1. In the left sidenav, select **App settings** (hover over the settings icon to view the title or expand the menu), and then select **Basic**.
6464
1. Save the **App ID** and **App Secret** somewhere secure.
6565

6666
### Set the App ID and App Secret in the Clerk Dashboard

docs/authentication/social-connections/github.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
4949

5050
### Create a GitHub app
5151

52-
1. In the left sidebar of your [GitHub's Developer Settings](https://github.com/settings/apps), select **OAuth Apps**.
52+
1. In the left sidenav of your [GitHub's Developer Settings](https://github.com/settings/apps), select **OAuth Apps**.
5353
1. Select **New OAuth app**. You'll be redirected to the **Register a new OAuth app** page.
5454
1. Complete the required fields. In **Authorization Callback URL**, paste the **Authorization Callback URL** you saved from the Clerk Dashboard.
5555
1. Select **Register application**. You'll be redirected to your app's **General** page.

docs/authentication/social-connections/huggingface.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ To configure your production instance, follow these steps:
5151
### Create a Hugging Face Connected App
5252

5353
1. In the top-right of [Hugging Face](https://huggingface.co/), select your avatar and select **Settings**.
54-
1. In the left sidebar, select **Connected Apps**.
54+
1. In the left sidenav, select **Connected Apps**.
5555
1. Under **Developer Applications**, select **Create App**.
5656
1. Complete the form. Under **Scopes**, select the scopes that your app requires. At minimum, select **openid**, **profile**, and **email**. Under **Redirect URLs**, paste the **Redirect URL** value you saved from the Clerk Dashboard.
5757
1. Select **Create**. The page should refresh and display the **Client ID** and **App Secret**. Save these values somewhere secure.

docs/authentication/social-connections/linear.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
5252
### Create a Linear app
5353

5454
1. In the top-left of [Linear](https://linear.app/), select your workspace, then select **Settings**.
55-
1. In the sidebar, under **Account**, select **API**. Scroll down to **OAuth Applications** and select **Create new OAuth Application**. You'll be navigated to the [**Create new application**](https://linear.app/clerk/settings/api/applications/new) page.
55+
1. In the sidenav, under **Account**, select **API**. Scroll down to **OAuth Applications** and select **Create new OAuth Application**. You'll be navigated to the [**Create new application**](https://linear.app/clerk/settings/api/applications/new) page.
5656
1. Complete the required fields. In **Callback URLs**, paste the **Redirect URI** you saved from the Clerk Dashboard.
5757
1. Select **Save**. The page will refresh and you should see the **Client ID** and **Client Secret** at the top. Save both values somewhere secure.
5858

docs/authentication/social-connections/slack.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
5151
1. In the Slack API Platform, navigate to the [**Your Apps**](https://api.slack.com/apps) page and select **Create New App**.
5252
1. The **Create an app** modal will open. Depending on your app needs, select either **From a manifest** or **From scratch**. For more information on which to choose, refer to [Slack's doc on manifests](https://api.slack.com/reference/manifests).
5353
1. After following the respective steps for either option, you'll be redirected to the **App Credentials** page. Save the **Client ID** and **Client Secret** somewhere secure. Keep this page open.
54-
1. In the sidebar, navigate to the **OAuth & Permissions** page.
54+
1. In the sidenav, navigate to the **OAuth & Permissions** page.
5555
1. Scroll down to the **Redirect URLs** section and select **Add New Redirect URL**. Paste the **Redirect URL** you saved from the Clerk Dashboard. Select **Add**, then select **Save URLs**.
5656

5757
### Set the Client ID and Client Secret in the Clerk Dashboard

docs/authentication/social-connections/twitch.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
5959

6060
### Create a Twitch Developer app
6161

62-
1. In the left sidebar of the [Twitch Developer Console](https://dev.twitch.tv/console), select **Applications**.
62+
1. In the left sidenav of the [Twitch Developer Console](https://dev.twitch.tv/console), select **Applications**.
6363
1. Select **Register Your Application**. You'll be redirected to the [**Register Your Application**](https://dev.twitch.tv/console/apps/create) page.
6464
1. Complete the required fields. Under **OAuth Redirect URLs**, paste the **OAuth Redirect URL** you saved from the Clerk Dashboard.
6565
1. Select **Create**. You'll be redirected to the **Developer Applications** page where you can see your new application listed.

docs/authentication/social-connections/xero.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
5151
1. In the top-right of the [Xero Developer](https://developer.xero.com/app/manage/) home page, select **New app**. The **Add a new app** modal will open.
5252
1. Fill out the necessary information. In the **Redirect URI** field, paste the **Redirect URI** value you saved from the Clerk Dashboard.
5353
1. Select **Create app**. You'll be redirected to the app's **App details** page.
54-
1. In the left sidebar, select **Configuration**.
54+
1. In the left sidenav, select **Configuration**.
5555
1. Select **Generate a secret**. Save the **Client ID** and **Client Secret** somewhere secure.
5656

5757
### Set the Client ID and Client Secret in the Clerk Dashboard

docs/components/organization/organization-profile.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -297,4 +297,4 @@ The `<OrganizationProfile />` component accepts the following properties, all of
297297

298298
To learn about how to customize Clerk components, see the [customization documentation](/docs/customization/overview).
299299

300-
In addition, you also can add custom pages and links to the `<OrganizationProfile />` navigation sidebar. For more information, refer to the [Custom Pages](/docs/customization/organization-profile) documentation.
300+
In addition, you also can add custom pages and links to the `<OrganizationProfile />` navigation sidenav. For more information, refer to the [Custom Pages](/docs/customization/organization-profile) documentation.

docs/components/user/user-profile.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -301,4 +301,4 @@ clerk.closeUserProfile(userProfileDiv)
301301

302302
To learn about how to customize Clerk components, see the [customization documentation](/docs/customization/overview).
303303

304-
In addition, you also can add custom pages and links to the `<UserProfile />` navigation sidebar. For more information, refer to the [Custom Pages documentation](/docs/customization/user-profile).
304+
In addition, you also can add custom pages and links to the `<UserProfile />` navigation sidenav. For more information, refer to the [Custom Pages documentation](/docs/customization/user-profile).

0 commit comments

Comments
 (0)