@spruceid/ssx-react v2.1.0

SSX React

SSX React provides a React Provider and Hook for using SSX in React applications. It is meant to be used in conjunction with wagmi.sh and is compatible with Next.js.

Installation

npm install @spruceid/ssx-react
# OR
yarn add @spruceid/ssx-react

Usage

ssx-react provides two key react components: a React Provider and a React Hook. The Provider is used to wrap components where SSX would be needed, and the Hook is used to access the SSX instance

Provider

The Provider is used to wrap the application. It takes a single prop, ssxConfig, which is the configuration object for the SSX instance. The Provider will create the SSX instance and make it available to the application via the Hook. An example is provided below

import { createClient, WagmiConfig } from 'wagmi';
import { SSXProvider } from '@spruceid/ssx-react';

const ssxConfig = {
  siweConfig: {
    statement: "Sign into my example dapp.",
  },
  providers: {
    backend: { host: "https://api.example.com/" },
  },
};

const wagmiClient = createClient({
  // your wagmi client configuration
  // configuration guide at https://wagmi.sh/docs/client
});

function App({ Component, pageProps }: AppProps) {
  return (
    <WagmiConfig client={wagmiClient}>
      <SSXProvider ssxConfig={ssxConfig}>
        {/* enables useSSX hook in children */}
        <Component {...pageProps} />
      </SSXProvider>
    </WagmiConfig>
  );
}

Hook

The Hook is used to access the SSX instance. It returns an object with the following properties:

• ssx: the SSX instance
• ssxLoaded: a boolean indicating whether the SSX is loaded and ready to use

import { useSSX } from '@spruceid/ssx-react';

function MyComponent() {
  const { ssx, ssxLoaded } = useSSX();

  if (!ssxLoaded) {
    return <div>Loading...</div>;
  }

  return (
    <div>
      <button onClick={() => ssx.signIn()}>Sign In</button>
    </div>
  );
}