woocommerce/plugins/woocommerce-admin/packages/explat/README.md

33 lines
927 B
Markdown

# ExPlat
This packages includes a component and utility functions that can be used to run A/B Tests in WooCommerce dashboard and reports pages.
## Installation
Install the module
```bash
npm install @woocommerce/explat --save
```
This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using core-js or @babel/polyfill will add support for these methods. Learn more about it in Babel docs.
## Usage
```js
import { Experiment } from '@woocommerce/explat';
const DefaultExperience = <div>Hello World</div>;
const TreatmentExperience = <div>Hello WooCommerce!</div>;
const LoadingExperience = <div></div>;
<Experiment
name="woocommerce_example_experiment"
defaultExperience={ DefaultExperience }
treatmentExperience={ TreatmentExperience }
loadingExperience={ LoadingExperience }
/>;
```