react-abtesting
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

SSR support = true

Google Like A/B test

Google advises doing 2 things with A / B testing.

  1. Redirect with GET parameter on the page with the tested variant
  2. Set the canonical tag on page

examples

to run the examples you need

  1. clone this repo
  2. cd react-ab-test
  3. npm i && npm run build
    • cd examples/client_render_coockie or examples/client_render_localstorage
      • npm i && npm start
    • cd examples/server_render_coockie
      • npm i && npm run build && npm start

client_render_coockie

client_render_coockie_with_react-router

client_render_localstorage

server_render_coockie

server_render_coockie_with_react-router

Getting Started

First you need to create an array of tests..

The name Default is mandatory, this is an option that will be shown by default on the base link

const experimentMap = [
    {
        name: "MyExperiment",
        variants: [
            {
                name: "Default",
                weight: 1
            },
            {
                name: "B",
                weight: 2
            }
        ],
        resolve: variant => {
            console.log("MyExperiment: selected variant", variant);
        }
    }
    ...etc
];

resolve -> function will be called after selecting the option A/B testing variants of experiments will be sorted in ascending order automatically

The next step is to create an adapter for storing and deleting data about the selected variant.

The library doesn't care where you save/retrieve selected variant, the most common examples are storage in coockies and localStorage.

// cookies set/get example
import Cookies from "js-cookie";
import { StorageAdapter } from "react-abtesting";

const storageAdapter = new StorageAdapter({
    prefix: "AB_", // optional
    setter: (key, val) => Cookies.set(key, val), // required
    getter: key => Cookies.get(key) // required
});
// localStorage set/get example
import { StorageAdapter } from "react-abtesting";

const storageAdapter = new StorageAdapter({
    prefix: "AB_", // optional
    setter: (key, val) => localStorage.setItem(key, val), // required
    getter: key => localStorage.getItem(key) // required
});
The next step is to create an instance of the test class.
import { AB_Test } from "react-abtesting";
const abTest = new AB_Test(experimentMap, storageAdapter);
Wrap application.
import { AB_Provider } from "react-abtesting";
ReactDOM.render(
    <AB_Provider abTest={abTest}>
        <App />
    </AB_Provider>
);
Now, anywhere in the application, we can create our tests.
//App.js
import { Experiment, Variant } from "react-abtesting";
render() {
    return (
        <div>
            <Experiment name="MyExperiment">
                <Variant name="Default">
                    <div>AAAAAAAAAAAAAAAAAAAAAAAA</div>
                </Variant>
                <Variant name="B">
                    <div>BBBBBBBBBBBBBBBBBBBBBBBB</div>
                </Variant>
            </Experiment>
        </div>
)}

Use with history package

import { AB_Provider } from "react-abtesting";
import { createBrowserHistory } from "history";

const history = createBrowserHistory();
ReactDOM.render(
    <AB_Provider abTest={abTest} history={history}>
        <App />
    </AB_Provider>
);

Package Sidebar

Install

npm i react-abtesting

Weekly Downloads

15

Version

2.0.0

License

ISC

Unpacked Size

34.1 kB

Total Files

30

Last publish

Collaborators

  • xfloooo