Nimble Pet Microbes

    @woocommerce/explat
    TypeScript icon, indicating that this package has built-in type declarations

    2.3.0 • Public • Published

    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 with Experiment Component

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

    Usage with useExperiment

    import { useExperiment } from '@woocommerce/explat';
    
    const DefaultExperience = <div>Hello World</div>;
    
    const TreatmentExperience = <div>Hello WooCommerce!</div>;
    
    const [ isLoadingExperiment, experimentAssignment ] = useExperiment('experiment-name');
    
    if ( ! isLoadingExperiment && experimentAssignment?.variationName === 'treatment' ) {
    	return <TreatmentExperience />
    }
    
    return <DefaultExperience />

    Install

    npm i @woocommerce/explat

    DownloadsWeekly Downloads

    439

    Version

    2.3.0

    License

    GPL-2.0-or-later

    Unpacked Size

    288 kB

    Total Files

    39

    Last publish

    Collaborators

    • chihsuan
    • rjchow
    • zhongruige
    • ~woocommerce
    • adrianduffell
    • octaedro
    • psealock
    • mikejolley
    • albertjuhe
    • nerrad
    • obliviousharmony
    • dygerati
    • louwie17
    • ilyasfoo
    • mattsherman
    • joshuatf
    • moon.kyong