Skip to content

Commit

Permalink
(chore): /app/ --> app/ for file names (#1783)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexisintech authored Dec 9, 2024
1 parent 590aeb9 commit ff1db3d
Show file tree
Hide file tree
Showing 25 changed files with 66 additions and 66 deletions.
2 changes: 1 addition & 1 deletion docs/components/organization/create-organization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The following example includes a basic implementation of the `<CreateOrganizatio

<Tabs items={["Next.js", "React", "Remix", "Astro"]}>
<Tab>
```jsx {{ filename: '/app/create-organization/[[...create-organization]]/page.tsx' }}
```jsx {{ filename: 'app/create-organization/[[...create-organization]]/page.tsx' }}
import { CreateOrganization } from '@clerk/nextjs'

export default function CreateOrganizationPage() {
Expand Down
2 changes: 1 addition & 1 deletion docs/components/organization/organization-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ All props are optional.

<Tabs items={["Next.js", "React", "Remix", "Astro"]}>
<Tab>
```jsx {{ filename: '/app/discover/page.tsx' }}
```jsx {{ filename: 'app/discover/page.tsx' }}
import { OrganizationList } from '@clerk/nextjs'

export default function OrganizationListPage() {
Expand Down
2 changes: 1 addition & 1 deletion docs/components/organization/organization-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ All props are optional.
<Tab>
You can embed the `<OrganizationProfile />` component using the [Next.js optional catch-all route](https://nextjs.org/docs/pages/building-your-application/routing/dynamic-routes#optional-catch-all-routes). This allows you to redirect the user inside your application.

```jsx {{ filename: '/app/organization-profile/[[...organization-profile]]/page.tsx' }}
```jsx {{ filename: 'app/organization-profile/[[...organization-profile]]/page.tsx' }}
import { OrganizationProfile } from '@clerk/nextjs'

export default function OrganizationProfilePage() {
Expand Down
2 changes: 1 addition & 1 deletion docs/components/organization/organization-switcher.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ All props below are optional.

<Tabs items={["Next.js", "React", "Remix", "Astro"]}>
<Tab>
```jsx {{ filename: '/app/organization-switcher/[[...organization-switcher]]/page.tsx' }}
```jsx {{ filename: 'app/organization-switcher/[[...organization-switcher]]/page.tsx' }}
import { OrganizationSwitcher } from '@clerk/nextjs'

export default function OrganizationSwitcherPage() {
Expand Down
2 changes: 1 addition & 1 deletion docs/components/protect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ The following example uses `<Protect>`'s `condition` prop to conditionally rende

<Tabs items={["Next.js", "Astro"]}>
<Tab>
```tsx {{ filename: '/app/dashboard/settings/layout.tsx' }}
```tsx {{ filename: 'app/dashboard/settings/layout.tsx' }}
import type { PropsWithChildren } from 'react'
import { Protect } from '@clerk/nextjs'

Expand Down
2 changes: 1 addition & 1 deletion docs/components/user/user-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ All props are optional.
You can embed the `<UserProfile />` component using the [Next.js optional catch-all route](https://nextjs.org/docs/pages/building-your-application/routing/dynamic-routes#optional-catch-all-routes). This allows you to redirect the user inside your application.

<CodeBlockTabs options={["App Router", "Pages Router"]}>
```jsx {{ filename: '/app/user-profile/[[...user-profile]]/page.tsx' }}
```jsx {{ filename: 'app/user-profile/[[...user-profile]]/page.tsx' }}
import { UserProfile } from '@clerk/nextjs'

const UserProfilePage = () => <UserProfile path="/user-profile" />
Expand Down
2 changes: 1 addition & 1 deletion docs/components/waitlist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The following example includes a basic implementation of the `<Waitlist />` comp

<Tabs items={["Next.js", "React"]}>
<Tab>
```jsx {{ filename: '/app/waitlist/[[...waitlist]]/page.tsx' }}
```jsx {{ filename: 'app/waitlist/[[...waitlist]]/page.tsx' }}
import { Waitlist } from '@clerk/nextjs'

export default function WaitlistPage() {
Expand Down
4 changes: 2 additions & 2 deletions docs/custom-flows/email-password.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This guide will walk you through how to build a custom email/password sign-up an
<Tab>
This example is written for Next.js App Router but it can be adapted for any React meta framework, such as Remix.

```tsx {{ filename: '/app/sign-up/[[...sign-up]]/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/sign-up/[[...sign-up]]/page.tsx', collapsible: true }}
'use client'

import * as React from 'react'
Expand Down Expand Up @@ -478,7 +478,7 @@ This guide will walk you through how to build a custom email/password sign-up an
<Tab>
This example is written for Next.js App Router but it can be adapted for any React meta framework, such as Remix.

```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx', collapsible: true }}
'use client'

import * as React from 'react'
Expand Down
4 changes: 2 additions & 2 deletions docs/custom-flows/manage-sms-based-mfa.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ One of the options that Clerk supports for MFA is **SMS verification codes**. Th

<Tabs items={["Manage MFA page", "Add phone number page"]}>
<Tab>
```tsx {{ filename: '/app/account/manage-mfa/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/account/manage-mfa/page.tsx', collapsible: true }}
'use client'

import * as React from 'react'
Expand Down Expand Up @@ -222,7 +222,7 @@ One of the options that Clerk supports for MFA is **SMS verification codes**. Th
</Tab>

<Tab>
```tsx {{ filename: '/app/account/add-phone/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/account/add-phone/page.tsx', collapsible: true }}
'use client'

import * as React from 'react'
Expand Down
4 changes: 2 additions & 2 deletions docs/custom-flows/manage-totp-based-mfa.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ One of the options that Clerk supports for MFA is **Authenticator applications (

<Tabs items={["Manage MFA page", "Add TOTP page"]}>
<Tab>
```tsx {{ filename: '/app/account/manage-mfa/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/account/manage-mfa/page.tsx', collapsible: true }}
'use client'

import * as React from 'react'
Expand Down Expand Up @@ -158,7 +158,7 @@ One of the options that Clerk supports for MFA is **Authenticator applications (
</Tab>

<Tab>
```tsx {{ filename: '/app/account/manage-mfa/add/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/account/manage-mfa/add/page.tsx', collapsible: true }}
'use client'

import { useUser } from '@clerk/nextjs'
Expand Down
2 changes: 1 addition & 1 deletion docs/custom-flows/sign-out.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The `signOut()` function signs a user out of all sessions in a [multi-session ap

This example is written for Next.js App Router but can be adapted for any React meta framework, such as Remix.

```jsx {{ filename: '/app/components/SignOutButton.tsx' }}
```jsx {{ filename: 'app/components/SignOutButton.tsx' }}
'use client'

import { useClerk } from '@clerk/nextjs'
Expand Down
4 changes: 2 additions & 2 deletions docs/customization/elements/examples/shadcn-ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ You must also configure the appropriate settings in Clerk:
},
]}
>
```tsx {{ filename: '/app/sign-up/[[...sign-up]]/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/sign-up/[[...sign-up]]/page.tsx', collapsible: true }}
'use client'
import * as Clerk from '@clerk/elements/common'
import * as SignUp from '@clerk/elements/sign-up'
Expand Down Expand Up @@ -321,7 +321,7 @@ You must also configure the appropriate settings in Clerk:
},
]}
>
```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx', collapsible: true }}
'use client'
import * as Clerk from '@clerk/elements/common'
import * as SignIn from '@clerk/elements/sign-in'
Expand Down
8 changes: 4 additions & 4 deletions docs/customization/elements/examples/sign-in.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Before you build your sign-in flow, you need to configure the appropriate settin
}
]}
>
```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx', collapsible: true }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down Expand Up @@ -127,7 +127,7 @@ Before you build your sign-in flow, you need to configure the appropriate settin
}
]}
>
```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx', collapsible: true }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down Expand Up @@ -222,7 +222,7 @@ Before you build your sign-in flow, you need to configure the appropriate settin
}
]}
>
```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx', collapsible: true }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down Expand Up @@ -382,7 +382,7 @@ Before you build your sign-in flow, you need to configure the appropriate settin
}
]}
>
```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx', collapsible: true }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down
4 changes: 2 additions & 2 deletions docs/customization/elements/examples/sign-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Before you build your sign-up flow, you need to configure the appropriate settin
}
]}
>
```tsx {{ filename: '/app/sign-up/[[...sign-up]]/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/sign-up/[[...sign-up]]/page.tsx', collapsible: true }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down Expand Up @@ -175,7 +175,7 @@ Before you build your sign-up flow, you need to configure the appropriate settin
}
]}
>
```tsx {{ filename: '/app/sign-up/[[...sign-up]]/page.tsx', collapsible: true }}
```tsx {{ filename: 'app/sign-up/[[...sign-up]]/page.tsx', collapsible: true }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down
10 changes: 5 additions & 5 deletions docs/customization/elements/guides/sign-in.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ description: Learn how to build a complete sign-in form with Clerk Elements.

Create a new route in your Next.js application. The route needs to be an [optional catch-all route](https://nextjs.org/docs/pages/building-your-application/routing/dynamic-routes#optional-catch-all-segments) so the sign-in flow can handled nested paths, as shown in the following example:

```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx' }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx' }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand All @@ -58,7 +58,7 @@ description: Learn how to build a complete sign-in form with Clerk Elements.

The Clerk authentication flows are made up of **steps**. Steps handle rendering the UI for each part of the flow. To allow users to create a sign-in attempt, the `start` step needs to be rendered. The following example does so with the `<SignIn.Step>` component:

```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx', mark: [[9, 11]] }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx', mark: [[9, 11]] }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand All @@ -79,7 +79,7 @@ description: Learn how to build a complete sign-in form with Clerk Elements.

Make it functional by adding input fields. The following example uses the `<Clerk.Field>` component to render an `identifier` field, as well as the `<Connection>` component to allow users to sign in with a social connection, like Google:

```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx', mark: [[12, 20]] }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx', mark: [[12, 20]] }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down Expand Up @@ -117,7 +117,7 @@ description: Learn how to build a complete sign-in form with Clerk Elements.

The following example demonstrates how to conditionally render a form for the `email_code` strategy:

```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx', mark: [[23, 38]] }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx', mark: [[23, 38]] }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down Expand Up @@ -167,7 +167,7 @@ description: Learn how to build a complete sign-in form with Clerk Elements.

If your instance is configured to support authenticating with passwords, you must add a few additional steps and verification strategies. You can choose if you want to support providing a password in the `start` step with an additional field, or as an additional verification strategy. For this guide, add it as a standalone verification strategy.

```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx', mark: [[39, 65], [68, 94]] }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx', mark: [[39, 65], [68, 94]] }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down
10 changes: 5 additions & 5 deletions docs/customization/elements/guides/sign-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ description: Learn how to build a complete sign-up form with Clerk Elements.

Create a new route in your Next.js application. The route needs to be an [optional catch-all route](https://nextjs.org/docs/pages/building-your-application/routing/dynamic-routes#optional-catch-all-segments) so the sign-up flow can handled nested paths, as shown in the following example:

```tsx {{ filename: '/app/sign-up/[[...sign-up]]/page.tsx' }}
```tsx {{ filename: 'app/sign-up/[[...sign-up]]/page.tsx' }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand All @@ -58,7 +58,7 @@ description: Learn how to build a complete sign-up form with Clerk Elements.

The Clerk authentication flows are made up of **steps**. Steps handle rendering the UI for each part of the flow. To allow users to create a sign-up attempt, the `start` step needs to be rendered. The following example does so with the `<SignUp.Step>` component:

```tsx {{ filename: '/app/sign-up/[[...sign-up]]/page.tsx', mark: [[9, 11]] }}
```tsx {{ filename: 'app/sign-up/[[...sign-up]]/page.tsx', mark: [[9, 11]] }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand All @@ -79,7 +79,7 @@ description: Learn how to build a complete sign-up form with Clerk Elements.

Make it functional by adding input fields. The following example uses the `<Clerk.Field>` component to render the `emailAddress` and `username` fields, as well as the `<Connection>` component to allow users to sign up with a social connection, like Google:

```tsx {{ filename: '/app/sign-up/[[...sign-up]]/page.tsx', mark: [[12, 34]] }}
```tsx {{ filename: 'app/sign-up/[[...sign-up]]/page.tsx', mark: [[12, 34]] }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down Expand Up @@ -128,7 +128,7 @@ description: Learn how to build a complete sign-up form with Clerk Elements.

The following example demonstrates how to conditionally render a form for the `phone_code` and `email_code` strategies:

```tsx {{ filename: '/app/sign-up/[[...sign-up]]/page.tsx', mark: [[35, 59]] }}
```tsx {{ filename: 'app/sign-up/[[...sign-up]]/page.tsx', mark: [[35, 59]] }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down Expand Up @@ -199,7 +199,7 @@ description: Learn how to build a complete sign-up form with Clerk Elements.

Should a user attempt to sign up via Google while a username is a required field, the `continue` step will be necessary to accept the username. The `<SignUp.Step>` component will display any additional required fields.

```tsx {{ filename: '/app/sign-up/[[...sign-up]]/page.tsx', mark: [[35, 45]] }}
```tsx {{ filename: 'app/sign-up/[[...sign-up]]/page.tsx', mark: [[35, 45]] }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down
10 changes: 5 additions & 5 deletions docs/customization/elements/guides/styling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can style Clerk Elements components with the following props:

This guide will demonstrate multiple different styling approaches using the following basic sign-in flow as a starting point:

```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx' }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx' }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down Expand Up @@ -50,7 +50,7 @@ export default function SignInPage() {

If you are already using [Tailwind CSS](https://tailwindcss.com/), no additional setup is required. Classes from Tailwind can be applied to most Clerk Elements components. Use your editor's IntelliSense to see if `className` is a valid prop on a component you want to style.

```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx' }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx' }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down Expand Up @@ -97,7 +97,7 @@ export default function SignInPage() {

Many of the Clerk Elements components accept an `asChild` prop that allows you to swap out the rendered element. This is useful if you have an existing design system or component library that you wish to use with Clerk Elements.

```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx' }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx' }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down Expand Up @@ -161,7 +161,7 @@ const CustomInput = forwardRef(function CustomInput(props, forwardedRef) {

Classes from an imported CSS module can be applied to most Clerk Elements components with `className`.

```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx' }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx' }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down Expand Up @@ -205,7 +205,7 @@ export default function SignInPage() {

You can also use inline styles with Clerk Elements. This is useful when you need to apply styles conditionally or avoid creating a separate CSS file.

```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx' }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx' }}
'use client'

import * as Clerk from '@clerk/elements/common'
Expand Down
12 changes: 6 additions & 6 deletions docs/customization/organization-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ To add a custom page to the `<OrganizationProfile />` component, use the `<Organ
The following example demonstrates two ways that you can render content in the `<OrganizationSwitcher.OrganizationProfilePage />` or `<OrganizationProfile.Page />` component: as a component or as a direct child.

<CodeBlockTabs options={["<OrganizationSwitcher />", "Dedicated page"]}>
```tsx {{ filename: '/app/components/Header.tsx' }}
```tsx {{ filename: 'app/components/Header.tsx' }}
'use client'

import { OrganizationSwitcher } from '@clerk/nextjs'
Expand Down Expand Up @@ -117,7 +117,7 @@ The following example demonstrates two ways that you can render content in the `
export default Header
```

```tsx {{ filename: '/app/organization-profile/[[...organization-profile]]/page.tsx' }}
```tsx {{ filename: 'app/organization-profile/[[...organization-profile]]/page.tsx' }}
'use client'

import { OrganizationProfile } from '@clerk/nextjs'
Expand Down Expand Up @@ -247,7 +247,7 @@ You can add external links to the `<OrganizationProfile />` navigation sidebar u
The following example adds a link to the homepage in the navigation sidebar of the `<OrganizationProfile />` component.

<CodeBlockTabs options={["<OrganizationSwitcher />", "Dedicated page"]}>
```tsx {{ filename: '/app/components/Header.tsx' }}
```tsx {{ filename: 'app/components/Header.tsx' }}
'use client'

import { OrganizationSwitcher } from '@clerk/nextjs'
Expand Down Expand Up @@ -275,7 +275,7 @@ The following example adds a link to the homepage in the navigation sidebar of t
export default Header
```

```tsx {{ filename: '/app/organization-profile/[[...organization-profile]]/page.tsx' }}
```tsx {{ filename: 'app/organization-profile/[[...organization-profile]]/page.tsx' }}
'use client'

import { OrganizationProfile } from '@clerk/nextjs'
Expand Down Expand Up @@ -306,7 +306,7 @@ Note that when reordering default routes, the first item in the navigation sideb

<Tabs items={["<OrganizationSwitcher />", "Dedicated Page"]}>
<Tab>
```tsx {{ filename: '/app/components/Header.tsx' }}
```tsx {{ filename: 'app/components/Header.tsx' }}
'use client'

import { OrganizationSwitcher } from '@clerk/nextjs'
Expand Down Expand Up @@ -358,7 +358,7 @@ Note that when reordering default routes, the first item in the navigation sideb

In the following example, `path` is set to `/organization-profile`, so the `<CustomPage />` is rendered under the `/organization-profile` path.

```tsx {{ filename: '/app/organization-profile/[[...organization-profile]]/page.tsx' }}
```tsx {{ filename: 'app/organization-profile/[[...organization-profile]]/page.tsx' }}
'use client'

import { OrganizationProfile } from '@clerk/nextjs'
Expand Down
2 changes: 1 addition & 1 deletion docs/customization/themes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@ To apply a theme to a single Clerk component, pass the `appearance` prop to the
<Tabs items={["Next.js", "React", "Remix", "Astro"]}>
<Tab>
<CodeBlockTabs options={["App Router", "Pages Router"]}>
```tsx {{ filename: '/app/sign-in/[[...sign-in]]/page.tsx', mark: [2, [7, 9]] }}
```tsx {{ filename: 'app/sign-in/[[...sign-in]]/page.tsx', mark: [2, [7, 9]] }}
import { SignIn } from '@clerk/nextjs'
import { dark } from '@clerk/themes'

Expand Down
Loading

0 comments on commit ff1db3d

Please sign in to comment.