npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nuxt-google-optimize-next

v0.5.4

Published

SSR friendly Google Optimize module for Nuxt.js

Downloads

5

Readme

nuxt-google-optimize

npm (scoped with tag) npm CircleCI Codecov Dependencies js-standard-style

SSR friendly Google Optimize module for Nuxt.js

📖 Release Notes

Features

  • Support multiple experiments (AB or MVT[Multi-Variant])
  • Auto assign experiment/variant to users
  • SSR support using cookies
  • CSS and state injection
  • Automatically revoke expired experiments from testers
  • Ability to assign experiments based on context conditions (Route, State, etc)

Setup

  • Add nuxt-google-optimize dependency using yarn or npm to your project
yarn add nuxt-google-optimize

OR

npm install nuxt-google-optimize --save
  • Add nuxt-google-optimize to modules section of nuxt.config.js
{
  modules: [
    'nuxt-google-optimize',
  ],

  // Optional options
  googleOptimize: {
    /* module options */
  }
}

Options

experimentsDir

  • Type: String
  • Default: '~/experiments'

Provide path where experiments are located.

maxAge

  • Type: Number
  • Default: 60 * 60 * 24 * 7

Provides default max age for user to test.

pushPlugin

  • Type: Boolean
  • Default: true

eventHandler

  • Type: Function
  • Default:
(experiment, context) => {
  const exp =
    experiment.experimentID + '.' + experiment.$variantIndexes.join('-')
  const { ga } = window
  if (!ga) return
  ga('set', 'exp', exp)
}

Provide custom event handler to send experiment details.

Usage example:

googleOptimize: {
  eventHandler: (experiment, context) => {
    const exp = experiment.experimentID + '.' + experiment.$variantIndexes.join('-')
    const { ga } = window
    if (!ga) return
    ga('set', 'exp', exp)
  }
}

excludeBots

  • Type: Boolean
  • Default: true

botExpression

  • Type: RegExp
  • Default: /(bot|spider|crawler)/i

Usage

Create experiments directory inside your project.

Create experiments/index.js to define all available experiments:

import backgroundColor from './background-color'

export default [
  backgroundColor
]

Creating an experiment

Each experiment should export an object to define itself.

experiments/background-color/index.js:

export default {
  // A helper exp-{name}-{var} class will be added to the root element
  name: 'background-color',

  // Google optimize experiment id
  experimentID: '....',

  // [optional] specify number of sections for MVT experiments
  // sections: 1,

  // [optional] maxAge for a user to test this experiment
  // maxAge: 60 * 60 * 24, // 24 hours,

  // [optional] Enable/Set experiment on certain conditions
  // isEligible: ({ route }) => route.path !== '/foo'

  // Implemented variants and their weights
  variants: [
    { weight: 0 }, // <-- This is the default variant
    { weight: 2 },
    { weight: 1 }
  ],
}

$exp

Global object $exp will be universally injected in the app context to determine the currently active experiment.

It has the following keys:

{
  // Index of currently active experiment
  "$experimentIndex": 0,

  // Index of currently active experiment variants
  "$variantIndexes": [
    1
  ],

  // Same as $variantIndexes but each item is the real variant object
  "$activeVariants": [
    {
      /* */
    }
  ],

  // Classes to be globally injected (see global style tests section)
  "$classes": [
    "exp-background-color-1" // exp-{experiment-name}-{variant-id}
  ],

  // All of the keys of currently active experiment are available
  "name": "background-color",
  "experimentID": "testid",
  "sections": 1,
  "maxAge": 60,
  "variants": [
    /* all variants */
  ]
}

Using inside components:

<script>
export default {
  methods: {
    foo() {
      // You can use this.$exp here
    }
  }
}
</script>

Using inside templates:

<div v-if="$exp.name === 'something'">
  <!-- You can optionally use $exp.$activeVariants and $exp.$variantIndexes here -- >
  ...
</div>
<div v-else>
  ...
</div>

Global style tests

Inject global styles to page body.

layouts/default.vue:

<template>
  <nuxt/>
</template>

<script>
export default {
      head () {
        return {
            bodyAttrs: {
                class: this.$exp.$classes.join(' ')
            }
        }
    },
}
</script>

If you have custom CSS for each test, you can import it inside your experiment's .js file.

experiments/background-color/index.js:

import './styles.scss'

With Sass:

.exp-background-color {
  // ---------------- Variant 1 ----------------
  &-1 {
    background-color: red;
  }
  // ---------------- Variant 2 ----------------
  &-2 {
    background-color: blue;
  }
}

With CSS:

/* Variant 1 */
.exp-background-color-1 {
  background-color: red;
}

/* Variant 2 */
.exp-background-color-2 {
  background-color: blue;
}

Usage with GTM

  • Set options.eventHandler:
// GTM module
{
  eventHandler: (experiment, { $gtm }) => {
    const exp = `${experiment.experimentID}.${experiment.$variantIndexes.join( '-' )}`
    $gtm.push({ exp })
  }
}

// Default datalayer
{
  eventHandler: (experiment, { $gtm }) => {
    const exp = `${experiment.experimentID}.${experiment.$variantIndexes.join( '-' )}`
    const { dataLayer } = window
    if (!dataLayer) return
    dataLayer.push({ exp })
  }
}
  • Edit your "Page view (Google Analytics)" -tag in Google Tag Manager
    • Add new "Fields to Set":
      • Field Name: exp
      • Value: {{googleOptimizeExp}}
  • Add new Data Layer Variable called "googleOptimizeExp" as defined above.
    • Variable type: Data Layer Variable
    • Data Layer Variable Name: exp

Source for this setup lossleader's answer in StackOverflow

Now this module pushes experiment id and variable number to Google Analytics via Google Tag Manager. experiment.experimentID + '.' + experiment.$variantIndexes.join('-')

Development

  • Clone this repository
  • Install dependencies using yarn install or npm install
  • Start development server using yarn run dev or npm run dev
  • Point your browser to http://localhost:3000
  • You will see a different colour based on the variant set for you
  • In order to test your luck, try clearing your cookies and see if the background colour changes or not

License

MIT License - Alibaba Travels Co