Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
badge-up
Advanced tools
Readme
This is a simple library that generates SVG badges without Cairo.
npm install badge-up
const badge = require('badge-up');
badge('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
.
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) {
//
}
}());
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.
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:
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) {
//
}
}());
FAQs
A module that produces hot badges without the need of Cairo
The npm package badge-up receives a total of 918 weekly downloads. As such, badge-up popularity was classified as not popular.
We found that badge-up demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.