Name: badge-up
Owner: Yahoo Inc.
Description: This is a simple library that generates SVG badges without Cairo.
Created: 2016-04-25 20:56:36.0
Updated: 2018-04-25 21:36:06.0
Pushed: 2017-02-02 17:47:33.0
Homepage: https://www.npmjs.com/package/badge-up
Size: 20
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
This is a simple library that generates SVG badges without Cairo.
npm install badge-up
badge = require('badge-up');
e('batman', 'component', badge.colors.green, function (error, svg) {
// some callback
Produces:
The color argument can be a CSS color, or one of the specially named colors
found in badge.colors
.
With this API you can create arbitrary badges with an arbitrary number of sections.
Each section is an array. The first element is the text to show, and the rest of the (optional) elements are attributes to apply to the text. If there are no attributes then a single string (instead of an array of one element) can be passed instead.
The following attributes are supported:
{hex}{hex}{hex}{hex}{hex}{hex}
six hexadecimal characters or {css-color-name}
a named CSS color,
either of which is used to color the sections{{hex}{hex}{hex}{hex}{hex}{hex}}
six hexadecimal characters or s{css-color-name}
a named CSS color,
either of which is used to color stroke the section, e.g. s{d3d3d3}
The default color for the first section is 696969
and d3d3d3
for subsequent sections.
Any section can have mulitple lines by putting newlines in its text.
badge = require('badge-up');
sections = [
'foo/far;fun',
[ 'bar\nbaz', 'orange'],
[ 'mork "mindy"', 'olive', 's{white}'],
[ '<?>', 'moccasin']
];
e.v2(sections, function (error, svg) {
// some callback
Produces: