gatsby-plugin-klaro-google-fonts

Description

This is a fork of gatsby-plugin-google-fonts that aims to be compatible with KIProtect Klaro. The plugin appends the necessary data attributes to prevent the execution of the API call until the user grants the necessary consent.

How to install

Install the plugin through npm

The installation of gatsby-plugin-klaro-google-fonts is done the same way as you would install other plugins. Refer to Using a plugin in your site for a detailed guide. Note that you need npm to use this plugin. You might also use another prefered package manager that you currently use.

Run the following commandto install gatsby-plugin-klaro-google-fonts:

npm install gatsby-plugin-klaro-google-fonts

Load the plugin

Put the plugin into your gatsby-config.js. It is important that you insert the plugin after the plugin that loads your CMP. The order of the plugins in your gatsby-config.js specifies their load order.

module.exports = {
    plugins: [
        ...
        {
            `gatsby-plugin-klaro-google-fonts`,
            options: {
                ...
            }
        },
        ...
    ]
};

Available options

fonts (required)

Provide the Google Fonts that should be available in the site. The format is the following: font name\:font,weights,and,styles.

Example value:

[
  "limelight",
  "source sans pro\:300,400,400i,700"
],

display (optional, default: "")

Provide the font-display property to set on the loaded font.

Example value: "swap"

disableKlaroCompatibility (optional, default: false)

Disable Klaro compatibility and always load the stylesheets using Googles API.

Example value: true

klaroName (optional, default: “googlefonts”)

The name that should be set for the data-name-attribute that Klaro uses for the configuration of the tag.

Example value: “googlefonts”

Examples of usage

Default usage

Default usage (Name for Klaro configuration will be googlefonts):

module.exports = {
    plugins: [
        ...
        {
            resolve: "gatsby-plugin-klaro-google-fonts",
            options: {
              fonts: [
                `limelight`,
                `source sans pro\:300,400,400i,700` // you can also specify font weights and styles
              ],
              display: 'swap'
            }
        },
        ...
    ],
};

Disable Klaro compatibility

Disable Klaro compatibility (e. g. for development):

module.exports = {
    plugins: [
        ...
        {
            resolve: "gatsby-plugin-klaro-google-fonts",
            options: {
              fonts: [
                `limelight`,
                `source sans pro\:300,400,400i,700` // you can also specify font weights and styles
              ],
              display: 'swap',
              disableKlaroCompatibility: true
            }
        },
        ...
    ],
};

Custom service name

Use a custom name to identify Google Fonts in your Klaro config:

module.exports = {
    plugins: [
        ...
        {
            resolve: "gatsby-plugin-klaro-google-fonts",
            options: {
              fonts: [
                `limelight`,
                `source sans pro\:300,400,400i,700` // you can also specify font weights and styles
              ],
              display: 'swap',
              klaroName: "some-custom-name"
            }
        },
        ...
    ],
};

How to develop locally

Prerequisites

To develop locally you need the following tools:

  • NodeJS (recommended version: 14.15.4)
  • NPM

Setup

To set the project up, simply let npm install your dependencies as always:

npm install

Building the project

To build the project use the build script provided by npm:

npm run build

Note that building will also run eslint and jest tests.

If you want to collect coverage while building, use the following script instead:

npm run buildCoverage

Compiling the project

To compile the project run the following npm script:

npm run compile

Clean compile output

To clean the compiled output (which lays in the root directory), run:

npm run clean

How to run tests

The project uses eslint as its linter. You can run the tool using npm.

Run the linter

Use the following npm command to run eslint and jest:

npm run test

How to contribute

You are welcome to contribute to gatsby-plugin-klaro-google-fonts! Refer to Contributing for information about issues and code contributions.