8e6d8c829e
* Update dependency @automattic/explat-client-react-helpers to ^0.0.4 * Reverted patch for building @automattic/explat-client-react-helpers * Updated pnpm-lock.yaml Co-authored-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: rjchow <me@rjchow.com> |
||
---|---|---|
.. | ||
src | ||
.npmrc | ||
CHANGELOG.md | ||
README.md | ||
jest.config.json | ||
package.json | ||
tsconfig-cjs.json | ||
tsconfig.json |
README.md
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
pnpm 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
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 }
/>;
// Get the experiment assignment with authentication as a WPCOM user.
import { ExperimentWithAuth } from '@woocommerce/explat';
<ExperimentWithAuth
name="woocommerce_example_experiment"
defaultExperience={ DefaultExperience }
treatmentExperience={ TreatmentExperience }
loadingExperience={ LoadingExperience }
/>;