Skip to main content

2 posts tagged with "community"

View All Tags

· 5 min read
Simon Porritt

jsPlumb uses Statcounter to keep track of what pages in the documentation people are looking at. Recently, at the tail end of the work to migrate to Typescript and release version 5.x of the Community and Toolkit editions, I started using Docusaurus, a super handy static site generator that not only runs on React but has React baked right into it, allowing us to easily embed working demonstrations throughout our docs, or to embed snippets from the api documentation directly into the main documentation via React components. It's a really handy tool, and if you're looking for a static site generator I recommend giving it a look.

note

When I say "Docusaurus" in this post I am talking about v2. I've not used v1.

This is not a post about how great Docusaurus is, though. This is a quick post about a Statcounter plugin I wrote while working on the jsPlumb API documentation. Docusaurus ships with a plugin for Google Analytics, allowing to quickly add support for GA to all the pages on your site, but jsPlumb doesn't use Google Analytics. Statcounter's interface has a pleasing directness to it and gives us all the information we need. A quick look around the internets came up blank on existing Docusaurus/Statcounter integrations, so I wrote a plugin.

Installation#

npm i @jsplumb/docusaurus-plugin-statcounter

Configuration#

First you have to add the plugin to the list of plugins in docusaurus.config.js:

plugins:[      "@jsplumb/docusaurus-plugin-statcounter"  ],

Then you need to configure the plugin via a statCounter block in the themeConfig of your docusaurus.config.js. It takes two arguments, both required:

themeConfig: {    statCounter:{      projectId: "2222222",      securityCode: "2222222"    },    ...}

projectId and securityCode are available in the Statcounter console for the project you wish to target.

Internals#

This is the first plugin I've written for Docusaurus and it doesn't have the most complex requirements, but I was quite impressed with the plugin mechanism. Let's start with the package.json:

{  "main": "src/index.js",  "name": "@jsplumb/docusaurus-plugin-statcounter",  "version": "1.0.0"}

We deliver a basic package with a single entry point.

Bootstrap#

Let's take a look at the first few lines of index.js:


const path = require('path');
module.exports = function (context) {    const {siteConfig} = context;  const {themeConfig} = siteConfig;  const {statCounter} = themeConfig || {};    };

Our module exports a single function that takes a context object, inside of which we can extract the siteConfig, and, from that, the themeConfig, which contains our statCounter settings.

Once we have our statCounter object, we extract the things we need from it, and complain about stuff that is missing:

const {projectId, securityCode} = statCounter;
if (!projectId) {    throw new Error(`The statcounter plugin requires a "projectId" to be set`)}
if (!securityCode) {    throw new Error(`The statcounter plugin requires a "securityCode" to be set`)}

Linking with Statcounter#

Statcounter works by importing a JS file in your document's head, after setting a couple of global variables. Docusaurus makes this very easy for us - all we have to do is declare an injectHtmlTags() method in our plugin:

return {    name: 'docusaurus-plugin-statcounter',
    getClientModules() {      return [path.resolve(__dirname, './statcounter')]    },
    injectHtmlTags() {
      return {        headTags:[          {              tagName:'script',              innerHTML: `                var sc_project="${projectId}";                 var sc_invisible=1;                 var sc_security="${securityCode}";              `          },          {            tagName:'script',            attributes:{              src:"https://www.statcounter.com/counter/counter.js"            }          }        ]      }    }  };

We inject two tags into the head: first we inject a script element and provide its innerHTML - this sets up the global variables. Next, we inject another script, but this time we set its src attribute, so it loads the JS from Statcounter's site. Documentation for injectHtmlTags(..) can be found here.

Tracking page changes#

Given that Docusaurus is an SPA, pages get swapped in and out without new page loads, and Statcounter would be oblivious, were we not to advise it. Fortunately this was also straightforward. Note this block in our plugin's code:

getClientModules() {  return [path.resolve(__dirname, './statcounter')]}

This instructs Docusaurus to load the module found in ./statcounter.js. The source code for that file looks like this:

import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
export default (function () {  if (!ExecutionEnvironment.canUseDOM) {    return null;  }
  return {    onRouteUpdate({location}) {      _statcounter.record_pageview()    },  };})();

This module hooks into onRouteUpdate, which I think is perhaps undocumented (for inspiration on this bit I used the Google Analytics plugin).

When a route update event occurs, we call _statcounter.record_pageview(). _statcounter is an object in the global space that was added by Statcounter's JS.

Conclusion#

That's the whole plugin - perhaps 80 lines of code. Very straightforward - it took me about half an hour to write and deploy. Injecting HTML tags is not the only thing you can do with a Docusaurus plugin, though. Take a look through the lifecycle APIs to get a feel for what's possible.

If you want to follow up on this, the source is on Github at https://github.com/jsplumb/docusaurus-plugin-statcounter.

· 3 min read
Simon Porritt

Over the last several months, jsPlumb - both the Community and Toolkit editions - has been ported into Typescript, undergoing various refactoring and API changes along the way, with the goal of producing a version of jsPlumb that is:

  • smaller
  • faster
  • tree shakeable
  • better documented

In version 5.x, the version numbering for the Toolkit and Community editions will be kept in sync: a release containing changes only to the Community edition will result in a corresponding Toolkit edition release, even though it contains no changes, and vice-versa. Keeping the version numbers in sync in this way takes a certain amount of guesswork out of the equation.

I'm pleased to share that we're almost ready to release version 5.0.0. Over the next few weeks I'll be running a series of "howto" posts, short posts that discuss one aspect of using jsPlumb, both the Community and Toolkit editions, in a modern web app.

Installation#

Community edition#

You can already try version 5.x of the Community edition - it's on npm (albeit with an RC version suffix):

npm i @jsplumb/browser-ui

This package is the equivalent of the jsPlumb window global that users of 2.x will be familiar with. It's been on npm for a couple of months now and is used quite extensively already, so don't let the RC version suffix put you off. You can browse the documentation here.

Toolkit edition#

For licensees or evaluators of the Toolkit edition, version 5.x is also available, hosted in jsPlumb's own npm repo. If you'd like to check it out, you can register your interest here.

Documentation for version 5.x of the Toolkit edition can be found here.

What happens to 2.x?#

It depends on which version you're talking about. For the Community edition, 2.x is now very much in maintenance mode, and is unlikely to receive any updates unless the current 2.x version of the Toolkit requires it. Users of the Community edition are strongly encouraged to migrate to 5.x now.

For licensees/evaluators of version 2.x of the Toolkit edition, when 5.x is released the current version will switch into a lightweight maintenance mode, which is to say that any bugs reported will be fixed, and, wherever possible, any new features added to 5.x that can also be added to 2.x without major dev work will be added to 2.x. When the support window closes for the last 2.x licensee at some point in the future, the 2.x version of the Toolkit will enter a stricter maintenance mode. When version 5.x of the Toolkit is released it will also not be possible for new evaluators/licensees to download version 2.x of the Toolkit edition.