woocommerce/plugins/woocommerce-admin/packages/explat
renovate[bot] 8e6d8c829e Update dependency @automattic/explat-client-react-helpers to ^0.0.4 (https://github.com/woocommerce/woocommerce-admin/pull/8471)
* 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>
2022-03-17 11:15:12 +08:00
..
src Add capability for ExPlat integration to authenticate WPCOM users (https://github.com/woocommerce/woocommerce-admin/pull/8428) 2022-03-16 11:03:10 +08:00
.npmrc Try ExPlat: Add A/A test (https://github.com/woocommerce/woocommerce-admin/pull/6669) 2021-04-15 13:32:46 +12:00
CHANGELOG.md Add capability for ExPlat integration to authenticate WPCOM users (https://github.com/woocommerce/woocommerce-admin/pull/8428) 2022-03-16 11:03:10 +08:00
README.md Add capability for ExPlat integration to authenticate WPCOM users (https://github.com/woocommerce/woocommerce-admin/pull/8428) 2022-03-16 11:03:10 +08:00
jest.config.json Make ExPlat request URL args filterable (https://github.com/woocommerce/woocommerce-admin/pull/8231) 2022-02-01 14:17:03 -04:00
package.json Update dependency @automattic/explat-client-react-helpers to ^0.0.4 (https://github.com/woocommerce/woocommerce-admin/pull/8471) 2022-03-17 11:15:12 +08:00
tsconfig-cjs.json Allow packages to be built in isolation. (https://github.com/woocommerce/woocommerce-admin/pull/7286) 2021-07-14 16:38:57 -04:00
tsconfig.json Update dependency @automattic/explat-client-react-helpers to ^0.0.4 (https://github.com/woocommerce/woocommerce-admin/pull/8471) 2022-03-17 11:15:12 +08:00

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 }
/>;