@ttoss/react-feature-flags
React Feature Flags is a library that allows you to easily add feature flags to your React application using ttoss ecosystem.
Installation
pnpm add @ttoss/react-feature-flags
Getting started
Initialize the library by wrapping your application with FeatureFlagsProvider
and passing loadFeatures
function as a prop (loadFeatures
is not required). loadFeatures
function should return a promise that resolves to an object with feature flags.
import {
FeatureFlagsProvider,
useFeatureFlag,
} from '@ttoss/react-feature-flags';
/**
* Load features from your backend or any other source.
*/
const loadFeatures = async () => {
const response = await fetch('https://...');
const { features } = await response.json();
return features; // features is string[]
};
const App = () => {
return (
<FeatureFlagsProvider loadFeatures={loadFeatures}>
<MyComponent />
</FeatureFlagsProvider>
);
};
Use useFeatureFlag
hook to get a feature flag value.
import { useFeatureFlag } from '@ttoss/react-feature-flags';
const MyComponent = () => {
const isFeatureEnabled = useFeatureFlag('my-feature');
return <div>{isFeatureEnabled ? 'Enabled' : 'Disabled'}</div>;
};
Usage
useFeatureFlag
hook
You can use useFeatureFlag
hook to get a feature flag value. It returns true
if the feature flag is enabled, false
otherwise.
import { useFeatureFlag } from '@ttoss/react-feature-flags';
const MyComponent = () => {
const isFeatureEnabled = useFeatureFlag('my-feature');
return <div>{isFeatureEnabled ? 'Enabled' : 'Disabled'}</div>;
};
FeatureFlag
component
You can use FeatureFlag
component to render its children only if the feature flag is enabled. It has optional props for error handling and fallback content.
Props:
name
: Feature flag namechildren
: Component to render when feature is enabledfallback
: Component to render when feature is disabled (optional)errorFallback
: Component to render when feature is enabled but an error occurs (optional)
import { FeatureFlag } from '@ttoss/react-feature-flags';
const MyComponent = () => {
return (
<FeatureFlag
name="my-feature"
fallback={<div>Feature is disabled</div>}
errorFallback={<div>Something went wrong</div>}
>
<div>Feature is enabled</div>
</FeatureFlag>
);
};
Update feature flags
You can update feature flags by calling updateFeatures
function that is returned from useUpdateFeatures
hook. This is useful when you want to update feature flags after providers are initialized.
import { useUpdateFeatures } from '@ttoss/react-feature-flags';
const MyComponent = () => {
const { updateFeatures } = useUpdateFeatures();
const handleClick = async () => {
const response = await fetch('https://...');
const { features } = await response.json();
updateFeatures(features);
};
return <button onClick={handleClick}>Update features</button>;
};
Error Handling
The FeatureFlag
component includes built-in error boundary protection. When a feature is enabled but the wrapped component throws an error, it will render the errorFallback
instead of crashing the entire application.
import { FeatureFlag } from '@ttoss/react-feature-flags';
const MyComponent = () => {
return (
<FeatureFlag
name="experimental-feature"
errorFallback={<div>This feature is temporarily unavailable</div>}
>
<ExperimentalComponent />
</FeatureFlag>
);
};
This is especially useful for:
- Experimental features that might have bugs
- Gradual rollouts where you want graceful degradation
- Production safety when testing new functionality
TypeScript
If you are using TypeScript, you can define your feature flags names on feature-flags.d.ts
file.
import '@ttoss/react-feature-flags';
declare module '@ttoss/react-feature-flags' {
export type FeatureFlags = 'my-feature' | 'my-other-feature';
}
This will allow you to use useFeatureFlag
hook with type safety.
import { useFeatureFlag } from '@ttoss/react-feature-flags';
const MyComponent = () => {
const isFeatureEnabled = useFeatureFlag('my-feature');
return <div>{isFeatureEnabled ? 'Enabled' : 'Disabled'}</div>;
};
Examples
loadFeatures
function needs a hook
If loadFeatures
function needs to use data from a hook, you can create a custom Provider that uses the hook, passes the data to loadFeatures
function, and then wraps the FeatureFlagsProvider
.
For example, you need userId
from a custom hook useMe
to load features:
import * as React from 'react';
import { FeatureFlagsProvider as TtossFeatureFlagsProvider } from '@ttoss/react-feature-flags';
const FeatureFlagsProvider = ({ children }: { children: React.ReactNode }) => {
const { me } = useMe();
const loadFeatures = React.useCallback(async () => {
if (!me?.email) {
return [];
}
/**
* Specify modules that some users have access to.
*/
if (me.email === 'user@example.com') {
return ['module1', 'module2'];
}
return [];
}, [me?.email]);
return (
<TtossFeatureFlagsProvider loadFeatures={loadFeatures}>
{children}
</TtossFeatureFlagsProvider>
);
};
Best Practices
Use Unique Entrypoints
When implementing feature flags, always ensure that all dependencies for your new feature are contained within the feature flag boundary. This prevents failures when the feature is disabled.
✅ Recommended: Unique Entrypoint
import { FeatureFlag } from '@ttoss/react-feature-flags';
import { MyNewComponent } from './MyNewComponent';
const MyComponent = () => {
return (
<FeatureFlag name="my-feature" fallback={null}>
<MyNewComponent />
</FeatureFlag>
);
};
❌ Avoid: Non-Unique Entrypoint
import { FeatureFlag } from '@ttoss/react-feature-flags';
import { MyNewComponent } from './MyNewComponent';
import { useMyNewComponentHook } from './useMyNewComponentHook';
const MyComponent = () => {
const data = useMyNewComponentHook(); // This executes even when feature is disabled
return (
<FeatureFlag name="my-feature" fallback={null}>
<MyNewComponent data={data} />
</FeatureFlag>
);
};
Why this matters: In the non-unique entrypoint example, useMyNewComponentHook()
executes regardless of whether the feature flag is enabled. If this hook fails or has dependencies that don't exist when the feature is disabled, it will break the entire MyComponent
, even though the feature flag should prevent this.
Solution: Move all feature-related logic, including hooks, API calls, and dependencies, inside the component that's wrapped by the feature flag.