@flaglayer/react
v0.1.1
Published
React hooks and provider for Flaglayer feature flags.
Readme
@flaglayer/react
React hooks and provider for Flaglayer feature flags.
Install
npm install @flaglayer/reactUsage
import { FlagProvider, useFlag, useBooleanFlag } from '@flaglayer/react';
function App() {
return (
<FlagProvider apiKey="your-api-key" context={{ userId: 'user-123' }}>
<MyComponent />
</FlagProvider>
);
}
function MyComponent() {
const showFeature = useBooleanFlag('new-feature', false);
if (showFeature) return <NewFeature />;
return <OldFeature />;
}Hooks
useFlag(key)— Get the full flag evaluation result.useBooleanFlag(key, fallback)— Get a boolean flag value.useStringFlag(key, fallback)— Get a string flag value.useNumberFlag(key, fallback)— Get a number flag value.useFlagValue(key, fallback)— Get a flag value of any type.useFlags()— Get all evaluated flags.useFlagLayer()— Access the underlying FlagLayer client instance.
Configuration
The API base URL defaults to the Flaglayer cloud API and can be overridden via the provider.
<FlagProvider apiKey="your-api-key" baseUrl="https://your-instance.com" context={{ userId: 'user-123' }}>
{children}
</FlagProvider>