@farmart-tech/brave-react-adapter

React hooks and components for Farmart Brave Ship feature flag system.

Overview

@farmart-tech/brave-react-adapter provides React hooks and components for seamless integration of Brave Ship feature flags into your React applications. Built with TypeScript for complete type safety.

Features

• React hooks for feature flags
• Provider component for global configuration
• Real-time feature flag updates
• TypeScript support
• Automatic re-rendering on flag changes
• SSR-compatible
• Minimal bundle size

Installation

npm install @farmart-tech/brave-react-adapter react react-dom

Peer Dependencies

• react >=18.0.0
• react-dom >=18.0.0
• firebase ^11.5.0
• lodash ^4.17.21

Quick Start

import { BraveProvider, useFeature } from '@farmart-tech/brave-react-adapter';
import { FirebaseAdapter } from '@farmart-tech/brave-firebase-adapter';

// Setup adapter
const adapter = new FirebaseAdapter({ /* config */ });

// Wrap your app
function App() {
  return (
    <BraveProvider workspaceId="workspace-1" adapter={adapter}>
      <YourApp />
    </BraveProvider>
  );
}

// Use in components
function MyComponent() {
  const { isEnabled, config } = useFeature('feature-dark-mode');

  return (
    <div className={isEnabled ? 'dark' : 'light'}>
      {isEnabled && <span>Dark mode is on!</span>}
    </div>
  );
}

Documentation

For complete API documentation and usage examples, visit:

https://fmt-feature-management.web.app/docs/react-adapter/index.html

Available Hooks

• useFeature(featureId) - Get feature flag state and configuration
• useFeatures() - Get all features for current workspace
• useWindow() - Get workspace window/maintenance status
• useBraveAdmin() - Admin operations (requires admin SDK)

Use Cases

• Feature toggles in React applications
• A/B testing components
• Gradual feature rollouts
• Maintenance mode UI
• Beta program features

License

MIT

Related Packages

• @farmart-tech/brave-firebase-adapter - Firebase integration
• @farmart-tech/brave-client-sdk - Client SDK
• @farmart-tech/brave-admin-sdk - Admin SDK

Repository

https://github.com/FarMart-Engineering/farmart-brave-ship