@scullyio/scully-plugin-google-analytics

- Description: This plugin allows the usage of Google Analytics via Global Site Tag. - Type: Render Plugin

Usage no npm install needed!

<script type="module">
  import scullyioScullyPluginGoogleAnalytics from 'https://cdn.skypack.dev/@scullyio/scully-plugin-google-analytics';
</script>

README

plugins-google-analytics

  • Description: This plugin allows the usage of Google Analytics via Global Site Tag.
  • Type: Render Plugin

Getting Started

1. Install the plugin:

npm install -D @scullyio/scully-plugin-google-analytics

2. Use the plugin:

In the application's scully..config.ts:

  1. Configure the plugin:

The plugin's configuration receives an object like this {globalSiteTag: string} where the globalSiteTag is the gtag provided by Google Analytics.

  1. Make a default post render array and add the plugin to it.

  2. Set the default post renders in Scully config.

e.g. ./scully.<your-app>.config.ts

import { setPluginConfig, ScullyConfig, prod } from '@scullyio/scully';
import { GoogleAnalytics } from '@scullyio/plugins/google-analytics';

const defaultPostRenderers = [];

if (prod) {
  setPluginConfig(GoogleAnalytics, { globalSiteTag: 'UA-#########-1' });
  defaultPostRenderers.push(GoogleAnalytics);
}
export const config: ScullyConfig = {
  defaultPostRenderers,
  routes: {
    '/': {
      type: 'contentFolder',
      postRenderers: [...defaultPostRenderers],
    },
  },
};

Running unit tests

Run ng test plugins-google-analytics to execute the unit tests via Jest.