@withgates/react-web v1.0.0-alpha.8

@withgates/react-web

A lightweight React library for managing feature flags and toggles in your applications.

Installation

npm install @withgates/react-web

or

yarn add @withgates/react-web

Features

• 🎛️ Knobs: Basic kill-switches for quick feature toggling
• 🚪 GateGuard: Declarative way to conditionally render components based on knobs, experiments, and rollouts status
• 🔒 Type-safe hooks for accessing feature flag and rollout status

• 🔄 Automatic cache invalidation when feature flag status changes

Quick Start

First, create a Gates instance with your configuration:

import Gates from '@withgates/react-web';

const gates = new Gates('your-public-key', {});

Then wrap your application with the GateProvider:

import { GateProvider } from '@withgates/react-web';

function App() {
  return (
    <GateProvider gates={gates}>
      <YourApp />
    </GateProvider>
  );
}

Knobs

Knobs are basic kill-switches that allow you to quickly toggle features on and off. They provide a simple boolean value that can be used to control feature visibility.

import { useKnob } from '@withgates/react-web';

function FeatureComponent() {
  const isEnabled = useKnob('feature-key');

  if (!isEnabled) {
    return null;
  }

  return (
    <div>
      Your feature content here
    </div>
  );
}

You can also use the KnobGuard component for declarative control:

import { KnobGuard } from '@withgates/react-web';

function App() {
  return (
    <KnobGuard knobKey="feature-key">
      <YourFeature />
    </KnobGuard>
  );
}