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

@unrevealed/react

v0.3.2

Published

Unrevealed SDK for React

Downloads

397

Readme

React SDK

Integrate Unrevealed in your front-end applications

Getting Started

npm install @unrevealed/react
yarn add @unrevealed/react
pnpm install @unrevealed/react

Usage

Provider

The first thing you need to do is add the Unrevealed provider at the root of your app. To generate a client key, go to the Api Keys menu in the app and create one. Select Client as the target SDK.

You should use different API keys for different environments.

import { UnrevealedProvider } from '@unrevealed/react';

function App() {
  return (
    <UnrevealedProvider clientKey={yourApiKey}>
      <MainApp />
    </UnrevealedProvider>
  );
}

Props

| Provider Prop | Type | Note | | ------------- | ------ | -------------------------------------------------- | | clientKey* | string | Generate an API key of type Client on Unrevealed |

Identify

You can use the identify function returned from the useIdentify hook to set the current user and team. Both are optional, but if your logged in user is part of an organization, or is currently in the context of a specific workspace of your app, we highly recommend you pass both.

import { useIdentify } from '@unrevealed/react';

function Login() {
  const { identify } = useIdentify();
  // ...

  const login = () => {
    // ...
    identify({
      user: {
        id: user.id,
        traits: {
          email: user.email,
          name: user.name,
          // ...
        },
      },
      team: {
        id: team.id,
        traits: {
          name: team.name,
          plan: team.plan,
          // ...
        },
      },
    });
  };
}

Checking if a feature is enabled

import { useFeature } from '@unrevealed/react';

function Component() {
  const { enabled, loading } = useFeature('user-access');

  if (loading) {
    // sdk is loading features
    // you don't have to check this every time, but it can be useful if your users experience unwanted flickering in your app
  }

  if (enabled) {
    // feature is enabled for the current user
  } else {
    // feature is disabled
  }
}

Type safety

You can make the identify function and useFeature hooks type safe by using the code generator, and defining the traits of your users and teams in the app.

Feature Toggler Widget

When using Unrevealed in development, you might need to check how the UI responds when a feature is disabled. You can do this without changing the feature's stage in the webapp, or changing your code, by using the Feature Toggler.

import { UnrevealedProvider, FeatureToggler } from '@unrevealed/react';

function App() {
  return (
    <UnrevealedProvider clientKey={yourClientKey}>
      {process.env.NODE_ENV === 'development' && <FeatureToggler />}
      <MainApp />
    </UnrevealedProvider>
  );
}