Installation

npm install @rivium/flags-react-native

Peer Dependencies

npm install @react-native-async-storage/async-storage @react-native-community/netinfo

For iOS, install pods:

cd ios && pod install

Quick Start

With React Hook (Recommended)

import { RiviumFlagsProvider, useRiviumFlags } from '@rivium/flags-react-native';

// Wrap your app
export default function App() {
  return (
    <RiviumFlagsProvider config={{ apiKey: 'YOUR_API_KEY', environment: 'production' }}>
      <MyScreen />
    </RiviumFlagsProvider>
  );
}

// Use in any component
function MyScreen() {
  const { isEnabled, getValue, isReady } = useRiviumFlags();

  if (!isReady) return <ActivityIndicator />;

  return (
    <View>
      {isEnabled('dark_mode') && <DarkModeToggle />}
      <Text>Checkout: {getValue('checkout_flow')}</Text>
    </View>
  );
}

Standalone Client

import { RiviumFlags } from '@rivium/flags-react-native';

const flags = new RiviumFlags({
  apiKey: 'YOUR_API_KEY',
  environment: 'production',
  enableOfflineCache: true,
});

await flags.init();
await flags.setUserId('user-123');
flags.setUserAttributes({ plan: 'pro', country: 'US' });

const darkMode = flags.isEnabled('dark_mode');
const result = flags.evaluate('checkout_flow');
console.log(result.enabled, result.value, result.variant);

Features

• React Hook & Provider — useRiviumFlags() hook with RiviumFlagsProvider context
• Boolean & Multivariate Flags — Simple on/off toggles or multi-variant flags with weighted distribution
• Targeting Rules — Target users by attributes (equals, contains, regex, in, greater_than, and more)
• Rollout Percentages — Gradual rollouts with deterministic MD5-based bucketing
• Offline Caching — Flags cached with AsyncStorage for offline access
• Environment Overrides — Separate flag values per environment (development, staging, production)
• Connectivity Aware — Automatic online/offline detection with NetInfo
• TypeScript — Full type safety with exported types and declarations

Documentation

For full documentation, visit rivium.co/docs.

License

MIT License — see LICENSE for details.