Skip to content

ErickRuano/clerk-svelte

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Warning This repo is no longer under maintenance. I suggest checking these alternatives instead:

https://github.com/wobsoriano/svelte-clerk https://github.com/markjaquith/clerk-sveltekit

clerk-svelte

An unofficial implementation of Clerk components inspired by the official react implementation

Because of how the Clerk.js library is loaded a REPL example is not possible.

Installation

npm i -D @erickruano/clerk-svelte

Usage

<script>
import { 
    /* Stores */
    Clerk,  // Svelte writable store that exposes Clerk for you instead of using window
    /* Components */
    ClerkProvider,  // This component must exist once in your App.svelte or equivalent.  This is the one that loads Clerk.js
    SignIn, // Place wherever you need. It will mount the SignIn flow UI
    SignUp, // Place wherever you need. It will mount the SignUp flow UI
    UserButton, // Place wherever you need. It will mount the User Button UI
    UserProfile, // Place wherever you need.  It will mount the User Profile UI
    SignedIn,  // Whatever you wrap inside this component will show only if a session exists in Clerk
    SignedOut  // Whatever you wrap inside this component will show only if no session exists in Clerk
} from '@erickruano/clerk-svelte'
</script>

<!-- src/App.js -->

<ClerkProvider frontendApi="your-api"/>

<!-- Anywhere in your project -->

Hello, {$Clerk.user.fullName}!

<SignIn/>

<SignUp/>

<UserButton/>

<UserProfile/>

<SignedIn>
    <!-- User is signed in, show dashboard  -->
</SignedIn>

<SignedOut>
    <!-- User is signed out, show sign-in flow  -->
    <SignIn />
</SignedOut>

To-do

  • Test components
  • Add useClerk and useUser methods to mimic official React implementation
  • Create demo site
  • Edge case: Update Clerk store when session changes and custom navigate handler was provided

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published