thirdweb Svelte SDK

Svelte SDK for thirdweb

How to Use

1. Installation

Install both the Svelte SDK and the core thirdweb library:

pnpm i @holdex/thirdweb-svelte thirdweb @tanstack/svelte-query [email protected]

For svelte 4 projects, you can use the v0.x version of the SDK:

pnpm i @holdex/[email protected] thirdweb @tanstack/svelte-query [email protected]

2. Setup Provider

Add the ThirdwebSvelteProvider to your src/routes/+layout.svelte:

<script>
    import { ThirdwebSvelteProvider } from '@holdex/thirdweb-svelte';
    import { browser } from '$app/environment';
    import { QueryClient, QueryClientProvider } from '@tanstack/svelte-query';
    import '@holdex/thirdweb-svelte/index.css';

    const queryClient = new QueryClient({
        defaultOptions: {
            queries: {
                enabled: browser
            }
        }
    });
</script>

<QueryClientProvider client={queryClient}>
    <ThirdwebSvelteProvider clientId={YOUR_THIRDWEB_CLIENT_ID}>
        <slot />
    </ThirdwebSvelteProvider>
</QueryClientProvider>

3. Implement Wallet Connection

Import and use the ConnectWalletModal component in your pages:

<script>
    import { ConnectWalletModal } from '@holdex/thirdweb-svelte';
</script>

<ConnectWalletModal
    wallets={/* Optional: Array of `Wallet` types from thirdweb (via `createWallet`).
              If not provided, defaults to showing standard wallets */}
    chain={/* Required: `Chain` type from thirdweb (via `defineChain`) */}
    chains={/* Optional: Array of available chains for users to switch between */}
    bind:open={/* Boolean to control modal visibility */}
    onOpenChange={/* Callback function for modal open/close events */}
/>

4. Optional: Integrate Export Private Key Modal

If you would like to allow users who logged in with inApp wallet (e.g. Google, Apple, or X) to export their private key, you can use the ExportPrivateKeyModal component.

<script>
    import { ExportPrivateKeyModal } from '@holdex/thirdweb-svelte';
</script>

<ExportPrivateKeyModal
    bind:open={/* Boolean to control modal visibility */}
    onOpenChange={/* Callback function for modal open/close events */}
/>

Note that this modal is only available for inApp wallets. If you would like to check if the user is connected with an inApp wallet, you can check it by using the code below:

<script>
    import { getThirdwebSvelteContext } from '@holdex/thirdweb-svelte';

    const { wallet } = getThirdwebSvelteContext();
</script>

{#if wallet.type === 'inApp'}
    <!-- Show Export Private Key button -->
{/if}

Known Issues

1. Svelte 5 Initialization State Inconsistency

The isInitialized state from getThirdwebSvelteContext() may show inconsistent values in Svelte 5 components. To fix this, create a local state that syncs with the initialization status:

<script lang="ts">
    import { getThirdwebSvelteContext } from '@holdex/thirdweb-svelte';

    // Create local state to track initialization
    const { isInitialized } = getThirdwebSvelteContext();
    let isWalletInitialized = $state(false);

    // Keep local state in sync
    $effect(() => {
        isWalletInitialized = $isInitialized;
    });
</script>

2. Vaul-svelte Version Compatibility (only for v0.x)

You must use vaul-svelte@0.3.2 even with Svelte 5 (not vaul-svelte@next). While this version has a drawer entry animation issue in Svelte 5, you can fix it with custom animation:

If you're using the shadcn-svelte drawer component with bottom slide animation:

1. Add these animation styles to your tailwind.config.ts:

{
  extend: {
    keyframes: {
      'slide-from-bottom': {
        from: { transform: 'translate3d(0, 100%, 0)' },
        to: { transform: 'translate3d(0, 0, 0)' }
      }
    },
    animation: {
      'slide-from-bottom': 'slide-from-bottom 0.5s cubic-bezier(0.32, 0.72, 0, 1)'
    }
  }
}

2. Apply the animation class to your drawer content:

<DrawerPrimitive.Content class="animate-slide-from-bottom ...">
    <!-- Your drawer content -->
</DrawerPrimitive.Content>

Development Guidelines

Getting Started

1. Clone the repository
2. Install dependencies:

pnpm install

3. Start the development server:

pnpm dev

4. Visit http://localhost:5173 to see the test page with working wallet connection functionality

Repository Structure

• src/lib/ - Contains all the library's source code
• src/lib/index.ts - Main entry point for the library
• src/routes/ - Contains the test application code (not included in npm package)

Building

• To build the package for npm:

pnpm package

• To build the complete application:

pnpm build

Testing

You can test the library using the app code in src/routes. This directory contains a complete Svelte application that serves as a testing environment, making it easy to verify your changes to the SDK code in src/lib.

Testing with Local Projects

To test your local library changes in another project:

1. Build the package:

pnpm package

2. In your consumer project, update the dependency in package.json:

{
    "dependencies": {
        "@holdex/thirdweb-svelte": "file:../path/to/your/local/thirdweb-svelte"
    }
}

3. Reinstall dependencies in your consumer project:

pnpm install

Troubleshooting

If you encounter issues:

1. Changes not reflecting:

   • Remove node_modules/.vite directory
   • Restart the development server

2. "exports not defined" error:

   • Add the following to your consumer project's vite.config.js:

   export default defineConfig({
       resolve: {
           preserveSymlinks: true
       }
   });
   

3. Browser compatibility:

   • Use Chrome instead of Brave for development
   • Brave browser may not properly reflect changes during development