mirror
/
badgen
kopia lustrzana https://github.com/badgen/badgen
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
Fast handcraft svg badge generator library . Used on badgen.net.
212 Commity
5 Gałęzie
46 Tagi
907 KiB
JavaScript 90.9%
TypeScript 9.1%
 
 
Go to file
Boris K ed4b6c9d08 chore: build badgen for browsers using Lyo (#21) 2018-09-07 17:50:50 +08:00
bench chore: update bench 2018-08-24 12:40:11 +08:00
lib fix: render correctly with iconWidth 2018-08-31 13:34:36 +08:00
preview fix: render correctly with iconWidth 2018-08-31 13:34:36 +08:00
tap-snapshots fix: render correctly with iconWidth 2018-08-31 13:34:36 +08:00
test fix: render correctly with iconWidth 2018-08-31 13:34:36 +08:00
.gitignore chore: build badgen for browsers using Lyo (#21) 2018-09-07 17:50:50 +08:00
.npmignore Update .npmignore 2018-07-19 14:21:31 +08:00
.travis.yml Revert "Add codecov report to travis.yml" 2018-07-18 15:18:35 +08:00
LICENSE.md chore: add license and improve readme 2018-08-08 22:05:01 +02:00
README.md docs: update benchmark results 2018-08-31 13:36:46 +08:00
package-lock.json chore: build badgen for browsers using Lyo (#21) 2018-09-07 17:50:50 +08:00
package.json chore: build badgen for browsers using Lyo (#21) 2018-09-07 17:50:50 +08:00

README.md

badgen

npm version Coverage Status Install size License

Fast handcraft svg badge generator. Used on badgen.net.

  • 🌀 Zero dependency
  • ⚡️ Fast by design (see benchmarks)
  • 👯‍ Pure JavaScript, running in node & browser

Usage

npm install badgen

const badgen = require('badgen')

const svgString = badgen({
  subject: 'npm',   // <Text>
  status: 'v1.2.3', // <Text>
  color: 'blue',    // <Color RGB> or <Color Name>, optional
  style: 'flat',    // 'flat' or undefined, optional
  icon: 'data:image/svg+xml;base64,PHN2Zy...', // Use icon, optional
  iconWidth: 13     // Use this if icon is not square.
})

Available color names:

Benchmarks

npm run bench on my MacBook Pro (Early 2015), 2.7G i5, with Node.js 10.9.0:

[classic] style, long params x 784,111 ops/sec ±1.53% (89 runs sampled)
[classic] style, full params x 1,096,667 ops/sec ±1.37% (90 runs sampled)
[classic] style, with emoji  x 1,086,230 ops/sec ±1.85% (92 runs sampled)
[classic] style, with icon   x 941,914 ops/sec ±0.41% (93 runs sampled)
   [flat] style, long params x 546,447 ops/sec ±0.52% (91 runs sampled)
   [flat] style, full params x 612,977 ops/sec ±1.08% (94 runs sampled)
   [flat] style, with emoji  x 620,193 ops/sec ±0.95% (92 runs sampled)
   [flat] style, with icon   x 566,848 ops/sec ±0.84% (93 runs sampled)