From fd11de9c01339502a6e2f4ea672ce7dbb185deac Mon Sep 17 00:00:00 2001 From: Mark Jaquith Date: Sun, 5 Nov 2023 18:32:37 -0500 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 13e9e43..15a903f 100644 --- a/README.md +++ b/README.md @@ -111,17 +111,17 @@ Then, where you want to show the signed in user's photo and sign out button (pro All components can be imported from `clerk-sveltekit/client/ComponentName.svelte` -- `<ClerkLoading />` — Wrapper that shows its contents when Clerk is still loading. -- `<ClerkLoaded let:clerk />` — Wrapper that shows its contents (and exposes the `clerk` object) when Clerk is done loading. -- `<SignIn />` — Renders a sign-in form. -- `<SignUp />` — Renders a sign-up form. -- `<SignedIn let:user />` — Wrapper that shows its contents (and exposes the Clerk `user` object) when the user is signed in. -- `<SignedOut />` — Wrapper that shows its contents when the user is not signed in. -- `<UserButton />` — Button that shows the user’s profile photo with log out link when they are signed in. -- `<UserProfile />` — Renders the current user’s profile. -- `<SignInButton />` — Unstyled sign-in button (can do `mode="modal"` too). -- `<SignUpButton />` — Unstyled sign-up button (can do `mode="modal"` too). -- `<SignOutButton />` — Unstyled sign-out button. +- `` — Wrapper that shows its contents when Clerk is still loading. +- `` — Wrapper that shows its contents (and exposes the `clerk` object) when Clerk is done loading. +- `` — Renders a sign-in form. +- `` — Renders a sign-up form. +- `` — Wrapper that shows its contents (and exposes the Clerk `user` object) when the user is signed in. +- `` — Wrapper that shows its contents when the user is not signed in. +- `` — Button that shows the user’s profile photo with log out link when they are signed in. +- `` — Renders the current user’s profile. +- `` — Unstyled sign-in button (can do `mode="modal"` too). +- `` — Unstyled sign-up button (can do `mode="modal"` too). +- `` — Unstyled sign-out button. Note that components should be used for displaying UI, but are not sufficient for protecting routes. To protect a route, use the `protectedRoutes` option passed to `handleClerk()` in your `hooks.server.ts` file.