@clerk/chrome-extension

@clerk/chrome-extension

Changelog · Report a Bug · Request a Feature · Get help

Getting Started

Clerk is the easiest way to add authentication and user management to your Chrome Extension. Add sign up, sign in, and profile management to your application in minutes.

Prerequisites

• Node.js >=18.17.0 or later
• An existing Clerk application. Create your account for free.
• An existing React app (using Vite for example)

Installation

1. Add @clerk/chrome-extension to your project:

   npm install @clerk/chrome-extension
   

2. Retrieve the Publishable key from your Clerk dashboard and set it as an environment variable. For example, if you used Vite:

   VITE_CLERK_PUBLISHABLE_KEY=pk_test_xxx
   

3. Add <ClerkProvider> to your app and define the routerPush & routerReplace properties. For example, with using react-router-dom:

   // App.tsx
   import { SignedIn, SignedOut, SignIn, SignUp, ClerkProvider } from '@clerk/chrome-extension';
   import { useNavigate, Routes, Route, MemoryRouter } from 'react-router-dom';
   
   function HelloUser() {
     return <p>Hello user</p>;
   }
   
   const publishableKey = process.env.VITE_CLERK_PUBLISHABLE_KEY || '';
   
   function ClerkProviderWithRoutes() {
     const navigate = useNavigate();
   
     return (
       <ClerkProvider
         publishableKey={publishableKey}
         routerPush={to => navigate(to)}
         routerReplace={to => navigate(to, { replace: true })}
       >
         <Routes>
           <Route
             path='/sign-up/*'
             element={<SignUp signInUrl='/' />}
           />
           <Route
             path='/'
             element={
               <>
                 <SignedIn>
                   <HelloUser />
                 </SignedIn>
                 <SignedOut>
                   <SignIn
                     afterSignInUrl='/'
                     signUpUrl='/sign-up'
                   />
                 </SignedOut>
               </>
             }
           />
         </Routes>
       </ClerkProvider>
     );
   }
   
   function App() {
     return (
       <MemoryRouter>
         <ClerkProviderWithRoutes />
       </MemoryRouter>
     );
   }
   
   export default App;
   

Usage

Example repositories:

• Standalone: The extension is using its own authentication
• WebSSO: The extensions shares authentication with a website in the same browser

WebSSO

If you want to use WebSSO (extension shares authentication state with a website in same browser) you'll need to add the syncSessionWithTab prop to <ClerkProvider>.

Extension Manifest (manifest.json)

You must enable the following permissions in your manifest.json file:

{
  "permissions": ["cookies", "storage"]
}

More info on the "cookies" permission: Google Developer Cookies Reference. More info on the "storage" permission: Google Developer Storage Reference.

Host Permissions

You must enable the following host permissions in your manifest.json file:

• Development: "host_permissions": ["http://localhost"]
  • If you're using a domain other than localhost, you'll want replace that entry with your domain: http://<DOMAIN>
• Production: "host_permissions": ["https://<YOUR_CLERK_FRONTEND_API_GOES_HERE>/"]
  • Your Frontend API URL can be found in Clerk Dashboard under the Show API URLs option.

For more info on host permissions visit Google's developer host_permissions reference.

Clerk Settings

Add your Chrome extension origin to your instance's allowed_origins using the Backend API:

curl  -X PATCH https://api.clerk.com/v1/instance \
      -H "Authorization: Bearer sk_secret_key" \
      -H "Content-type: application/json" \
      -d '{"allowed_origins": ["chrome-extension://extension_id_goes_here"]}'

Setting the allowed_origins is required for both Development and Production instances.

Support

You can get in touch with us in any of the following ways:

• Join our official community Discord server
• On our support page

Contributing

We're open to all community contributions! If you'd like to contribute in any way, please read our contribution guidelines and code of conduct.

Security

@clerk/chrome-extension follows good practices of security, but 100% security cannot be assured.

@clerk/chrome-extension is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.