Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 1.17 KB

README.md

File metadata and controls

52 lines (40 loc) · 1.17 KB
Raw

@scaleway/use-growthbook

Tiny adapter to easily add GrowthBook to your React Application. The idea of this package is to propose a facade pattern above GrowthBook React SDK.

Install

$ pnpm add @scaleway/use-growthbook

How to use

First add the provider to your application roots

import { AbTestProvider } from '@scaleway/use-growthbook'
import React from 'react'
import ReactDOM from 'react-dom'
import App from './App'

ReactDOM.render(
  <React.StrictMode>
    <AbTestProvider
      config={{ apiHost: 'string', clientKey: 'string', enableDevMode: true }}
      anonymousId="123456789"
      trackingCallback={(experiment, result) => console.log(experiment, result)}
      errorCallback={console.error}
    >
      <App />
    </AbTestProvider>
  </React.StrictMode>,
  document.getElementById('root'),
)

Attributes

A hook useAbTestAttributes is available to get currentAttributes and to set new ones dynamically.

API

Exported utils from GrowthBook React are listed here:

  • FeatureString
  • FeaturesReady
  • IfFeatureEnabled
  • useExperiment
  • useFeature
  • withRunExperiment
  • useFeatureIsOn
  • useFeatureValue