westminster-svg v2.0.0

westminster-svg

Generate westminster parliament charts as hast virtual DOM SVG*. Design inspired by the Wikipedia parliament charts. Play around with the live demo! For "normal" parliament charts, see parliament-svg.

*Also compatible with other virtual DOM implementations, see the docs below.

Installation

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm install --save westminster-svg

Usage

import westminsterSVG from 'westminster-svg'

const virtualSvg = westminsterSVG(parliament, [opt])

• opt can contain the following options:
  • hFunction is a function that will be used to generate the element tree. Defaults to hastscript's s() function, custom values need to match that function's signature. You could use virtual-hyperscript-svg's h() function here if you prefer working with virtual-dom, for example.
• parliament is an object containing party information for all four 'sides' of the parliament: headBench, left, crossBench and right. After the 2017 UK general election it should look as follows:

{
	headBench: {
		speaker: {
			seats: 1,
			colour: '#000'
		}
	},
	left: {
		labour: {
			seats: 262,
			colour: '#dc241f',
		},
		snp: {
			seats: 35,
			colour: '#ff0',
		},
		libdems: {
			seats: 12,
			colour: '#faa61a',
		},
		sinnfein: {
			seats: 7,
			colour: '#080',
		},
		plaidcymru: {
			seats: 4,
			colour: '#008142',
		},
		green: {
			seats: 1,
			colour: '#6ab023',
		},
		independent: {
			seats: 1,
			colour: '#aadfff',
		}
	},
	crossBench: {
		dup: {
			seats: 10,
			colour: '#d46a4c',
		}
	},
	right: {
		conservative: {
			seats: 317,
			colour: '#0087dc',
		}
	}
}

Please note that the parties will be displayed in the order of their object keys from left to right (based on the speaker's viewpoint). Further, each seat SVG element contains the party name in its class attribute.

For the given parliament object, the rendered result should look as follows:

If you want to convert the hast tree to an SVG string, use hast-util-to-html (don't get confused by the name, the library can also stringify SVG):

import westminsterSVG from 'westminster-svg'
import { toHtml as toSvg } from 'hast-util-to-html'

const virtualSvg = westminsterSVG(parliament)
const svg = toSvg(virtualSvg)

Check the code example as well.

What if I prefer virtual-dom (or anything else)?

If you prefer virtual-dom over hast, e.g. for diffing or patching, you can either:

• use hast-to-hyperscript to transform the tree after it was generated or
• use the hFunction parameter documented above with a virtual-dom h() function of your choice

Contributing

If you found a bug or want to propose a feature, feel free to visit the issues page.