1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-05-26 01:17:00 +02:00
unleash.unleash/frontend/src/component/onboarding/dialog/snippets/react.md
Tymoteusz Czech d760af321f
feat(onboarding): add comments to snippets (#8361)
Add warning about plaintext API key and increased metrics interval
2024-10-04 10:56:19 +02:00

1.3 KiB

1. Install the SDK

npm install @unleash/proxy-client-react unleash-proxy-client

2. Initialize Unleash

import { createRoot } from 'react-dom/client';
import { FlagProvider } from '@unleash/proxy-client-react';

const config = {
  url: '<YOUR_API_URL>',
  clientKey: '<YOUR_API_TOKEN>', // in production use environment variable
  metricsInterval: 1, // In production use interval of >15s
  appName: 'unleash-onboarding-react',
};

const root = createRoot(document.getElementById('root'));

root.render(
  <React.StrictMode>
    <FlagProvider config={config}>
      <App />
    </FlagProvider>
  </React.StrictMode>
);

3. Check feature flag status

import { useFlag } from '@unleash/proxy-client-react';

const TestComponent = () => {
  const enabled = useFlag('<YOUR_FLAG>');

  return enabled ? 'Flag is enabled' : 'Flag is disabled'
};

const config = {
  url: '<YOUR_API_URL>', 
  clientKey: process.env.UNLEASH_API_TOKEN,
  appName: 'unleash-onboarding-react',
};