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

react-userbase

v1.10.3

Published

React Hooks for Userbase

Downloads

7

Readme

react-userbase

React Hooks for Userbase

NPM JavaScript Style Guide

Install

You need to install Userbase separately from this package

yarn add userbase-js react-userbase

or

npm install userbase-js react-userbase --save

Usage

First, wrap your app with UserbaseProvider like this:

import { UserbaseProvider } from 'react-userbase';

<UserbaseProvider appId={YOUR APP ID FROM USERBASE}>
    <App/>
</UserbaseProvider>

Then, any component within the UserbaseProvider can use the hook.

The hook takes arguments like these:

useUserbase(action, options?)

where action is one of the Userbase functions from their SDK and options is an object of options to pass to the function.

The hook returns an array with a function and an object as shown in the example below.

The generated function will trigger its Userbase function, and the object properties will track that function's state. The generated function also returns its promise.

You can also pass options to the function when you call it, as shown below.

import * as React from "react";
import { useUserbase } from "react-userbase";

const Example = () => {
  const [signIn, { response, loading, error }] = useUserbase("signIn");
  const [signOut, { response: signOutResponse, loading: signOutLoading, error: signOutError }] = useUserbase("signOut");

  const username = "aej11a"
  const password = "Password123"

  useEffect(() => {
    console.log(response, loading, error)
  })

  if(loading) return <LoadingIndicator/>
  return (
    <button onClick={() => signIn({username, password})}>Sign In</button>
  )
};

Example Project

Clone/download the repo locally and add a .env.local file at react-userbase/example/.env.local

In that file, add REACT_APP_USERBASE_APP_ID=<YOUR USERBASE APP ID>

Start the dev server to test. You can see a few different uses of the hook in react-userbase/example/src/App.js

License

MIT © aej11a


This hook was created using create-react-hook.

Excellent explanation of the object syntax instead of using an array: https://github.com/zeit/swr/issues/9#issuecomment-547224457