Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(chore) fix format for component references #1796

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -575,7 +575,7 @@ The `<TutorialHero />` component is used at the beginning of a tutorial-type con

- Install `@clerk/nextjs`
- Set up your environment keys to test your app locally
- Add `<ClerkProvider />` to your application
- Add `<ClerkProvider>` to your application
- Use Clerk middleware to implement route-specific authentication
- Create a header with Clerk components for users to sign in and out

Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-usage/satellite-domains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ To access authentication state from a satellite domain, users will be transparen
# CLERK_SIGN_UP_URL=http://localhost:3000/sign-up
```
</CodeBlockTabs>
- You will also need to add the `allowedRedirectOrigins` property to `<ClerkProvider />` on your _primary domain app_ to ensure that the redirect back from primary to satellite domain works correctly. For example:
- You will also need to add the `allowedRedirectOrigins` property to `<ClerkProvider>` on your _primary domain app_ to ensure that the redirect back from primary to satellite domain works correctly. For example:

<CodeBlockTabs options={["Development", "Production"]}>
```tsx {{ filename: 'app/layout.tsx' }}
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/architecture-scenarios.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Clerk offers a number of building blocks to help integrate organizations into yo

- The [`<OrganizationSwitcher />` component](/docs/components/organization/organization-switcher) provides a way for your users to select which organization is active. The [`useOrganizationList()` hook](/docs/organizations/custom-organization-switcher) can be used for more control.
- The [`useOrganization()` hook](/docs/references/react/use-organization) can be used to fetch the current, active organization.
- The [`<Protect />` component](/docs/components/protect) enables you to limit who can view certain pages based on their role. Additionally, Clerk exposes a number of helper functions, such as [`auth()`](/docs/references/nextjs/auth), and hooks, such as [`useAuth()`](/docs/references/react/use-auth#how-to-use-the-use-auth-hook), to check the user's authorization throughout your app and API endpoints.
- The [`<Protect>` component](/docs/components/protect) enables you to limit who can view certain pages based on their role. Additionally, Clerk exposes a number of helper functions, such as [`auth()`](/docs/references/nextjs/auth), and hooks, such as [`useAuth()`](/docs/references/react/use-auth#how-to-use-the-use-auth-hook), to check the user's authorization throughout your app and API endpoints.

The organization's ID should be stored in your database alongside each resource so that it can be used to filter and query the resources that should be rendered or returned according to the active organization.

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/authjs-migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ description: Learn how to migrate an application using Auth.js to use Clerk for
>
- Install `@clerk/nextjs`
- Set environment variables
- Wrap your Next.js app in `<ClerkProvider />`
- Wrap your Next.js app in `<ClerkProvider>`
- Set up sign-up and sign-in UI
- Protect your app
- Read user and session data
Expand Down Expand Up @@ -67,9 +67,9 @@ This guide shows how to migrate an application using Auth.js (formerly NextAuth.
CLERK_SECRET_KEY={{secret}}
```

### Wrap your Next.js app in `<ClerkProvider />`
### Wrap your Next.js app in `<ClerkProvider>`

Remove the `<SessionProvider session={session}>` provider from Auth.js and replace it with `<ClerkProvider />`.
Remove the `<SessionProvider session={session}>` provider from Auth.js and replace it with `<ClerkProvider>`.

<Include src="_partials/clerk-provider" />

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstarts/chrome-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ description: Add authentication and user management to your Chrome Extension wit
- Create a new app with Plasmo
- Install `@clerk/chrome-extension`
- Set your Clerk API keys
- Add `<ClerkProvider />` and Clerk components to your app
- Add `<ClerkProvider>` and Clerk components to your app
- Configure your app to use a consistent CRX ID
- Build, load, and test your Chrome Extension
</TutorialHero>
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstarts/expo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ description: Add authentication and user management to your Expo app with Clerk.
>
- Install `@clerk/expo`
- Set your Clerk API keys
- Add `<ClerkProvider />`
- Add `<ClerkProvider>`
- Protect specific pages with authentication
- Use Clerk hooks to enable users to sign in and out
</TutorialHero>
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstarts/nextjs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ description: Add authentication and user management to your Next.js app with Cle
- Install `@clerk/nextjs`
- Set your Clerk API keys
- Add `clerkMiddleware()`
- Add `<ClerkProvider />` and Clerk components
- Add `<ClerkProvider>` and Clerk components
</TutorialHero>

<Steps>
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstarts/react.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ description: Add authentication and user management to your React app with Clerk
- Create a new React app using Vite
- Install `@clerk/clerk-react`
- Set your Clerk API keys
- Add `<ClerkProvider />`
- Add `<ClerkProvider>`
- Create a header with Clerk components for users to sign in and out
</TutorialHero>

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstarts/tanstack-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ description: Learn how to use Clerk to quickly and easily add secure authenticat
- Install `@clerk/tanstack-start`
- Set your Clerk API keys
- Add `createClerkHandler()`
- Add `<ClerkProvider />`
- Add `<ClerkProvider>`
- Protect your pages
</TutorialHero>

Expand Down
2 changes: 1 addition & 1 deletion docs/telemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ CLERK_TELEMETRY_DISABLED=1

### `telemetry` prop

If you are using `@clerk/clerk-react` directly, or using an SDK that doesn't have environment variable support, you can opt out by passing the `telemetry` prop to `<ClerkProvider />`:
If you are using `@clerk/clerk-react` directly, or using an SDK that doesn't have environment variable support, you can opt out by passing the `telemetry` prop to `<ClerkProvider>`:

```tsx
<ClerkProvider telemetry={false} />
Expand Down
2 changes: 1 addition & 1 deletion styleguides/STYLEGUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ Component references should be wrapped in `< />` if they are self closing. Other

The last case is incorrect because the `<SignIn />` component will never wrap children, and therefore, should have a self-closing tag.

> Use the `<ClerkProvider />` component.
> Use the `<ClerkProvider>` component.

The last case is incorrect because the `<ClerkProvider>` component will always wrap children and will never be self-closing.

Expand Down
Loading