npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

badge-up

v3.0.0

Published

A module that produces hot badges without the need of Cairo

Downloads

16,117

Readme

badge-up

npm downloads build coverage

This is a simple library that generates SVG badges without Cairo.

Install

npm install badge-up

V1 Usage

const badge = require('badge-up');
badge('batman', 'component', badge.colors.green, function (error, svg) {
    // some callback
});

Produces: example

The color argument can be a CSS color, or one of the specially named colors found in badge.colors.

You can alternatively use the returned Promise:

const badge = require('badge-up');
(async () => {
try {
    const svg = await badge('batman', 'component', badge.colors.green);
} catch (error) {
    //
}
}());

V2 Usage

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 section
  • s{{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.

const badge = require('badge-up');
const sections = [
    'foo/far;fun',
    [ 'bar\nbaz', 'orange'],
    [ 'mork "mindy"', 'olive', 's{white}'],
    [ '<∀>', 'moccasin']
];
badge.v2(sections, function (error, svg) {
    // some callback
});

Produces: example

You can also use the returned Promise:

const badge = require('badge-up');
const sections = [
    'foo/far;fun',
    [ 'bar\nbaz', 'orange'],
    [ 'mork "mindy"', 'olive', 's{white}'],
    [ '<∀>', 'moccasin']
];

(async () => {
try {
    const svg = await badge.v2(sections);
} catch (error) {
  //
}
}());