Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
alexisintech committed Oct 21, 2024
1 parent 93d2913 commit a5a9537
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions docs/quickstarts/remix.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,11 @@ Learn how to use Clerk to quickly and easily add secure authentication and user
<Steps>
### Install `@clerk/remix`

Once you have a Remix application ready, you need to install Clerk's Remix SDK. This gives you access to our prebuilt components and hooks for Remix applications.
Clerk's Remix SDK gives you access to prebuilt components, hooks, and helpers to make user authentication easier.

<CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
Add the SDK to your project by running the following command:

<CodeBlockTabs options={["npm", "yarn", "pnpm"]}>
```bash {{ filename: 'terminal' }}
npm install @clerk/remix
```
Expand Down Expand Up @@ -189,15 +191,14 @@ Learn how to use Clerk to quickly and easily add secure authentication and user

#### Client-side

To protect your pages on the client-side, you can use Clerk's [prebuilt control components](/docs/components/overview) that control the visibility of content based on the user's authentication state.
To protect your pages on the client-side, Clerk's [prebuilt control components](/docs/components/overview) control the visibility of content based on the user's authentication state.

The following example uses the following components:

- [`<SignedIn>`](/docs/components/control/signed-in): Children of this component can only be seen while **signed in**.
- [`<SignedOut>`](/docs/components/control/signed-out): Children of this component can only be seen while **signed out**.
- [`<UserButton />`](/docs/components/user/user-button): Shows the avatar from the account the user is signed in with. When selected, it opens a dropdown menu with account management options.
- [`<SignInButton />`](/docs/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. For this example, because you have not specified any props or [environment variables](/docs/deployments/clerk-environment-variables) for the sign-in URL, the component will link to [Clerk's Account Portal sign-in page.](/docs/customization/account-portal/overview#sign-in)
- [`<SignUpButton />`](/docs/components/unstyled/sign-up-button): An unstyled component that links to the sign-up page. For this example, because you have not specified any props or [environment variables](/docs/deployments/clerk-environment-variables) for the sign-in URL, the component will link to [Clerk's Account Portal sign-up page.](/docs/customization/account-portal/overview#sign-up)

```tsx {{ filename: 'routes/_index.tsx' }}
import {
Expand All @@ -215,16 +216,13 @@ Learn how to use Clerk to quickly and easily add secure authentication and user
<h1>Index Route</h1>
<SignedIn>
<p>You are signed in!</p>
<UserButton />

<SignOutButton />
<UserButton />
</SignedIn>
<SignedOut>
<p>You are signed out</p>

<SignInButton />

<SignUpButton />
</SignedOut>
</div>
)
Expand Down

0 comments on commit a5a9537

Please sign in to comment.