npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@spruceid/ssx-react

v2.1.0

Published

SSX React Hooks

Downloads

96

Readme

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>
  );
}