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.
261 Commity
5 Gałęzie
46 Tagi
907 KiB
JavaScript 90.9%
TypeScript 9.1%
 
 
Go to file
Amio 7c0c70a5f4 Allow `subject` in type def 2019-07-06 17:54:41 +08:00
.github Add github action config 2019-07-06 17:36:53 +08:00
bench chore: update bench 2018-08-24 12:40:11 +08:00
preview Update preview 2019-07-06 16:04:16 +08:00
src Allow `subject` in type def 2019-07-06 17:54:41 +08:00
tap-snapshots subject => label 2019-07-06 15:34:14 +08:00
test Use src for testing 2019-07-06 15:51:18 +08:00
.gitignore use ncc & test on dist 2019-01-29 20:53:41 +08:00
.npmignore use ncc & test on dist 2019-01-29 20:53:41 +08:00
.travis.yml chore: publish bundled badgen.min.js only 2018-09-07 23:05:09 +08:00
LICENSE.md chore: add license and improve readme 2018-08-08 22:05:01 +02:00
README.md Update browserify link 2019-07-06 16:25:40 +08:00
package-lock.json 2.8.0 2019-07-06 16:14:25 +08:00
package.json 2.8.0 2019-07-06 16:14:25 +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')

// only `status` is required.
const svgString = badgen({
  label: 'npm',     // <Text>
  labelColor: 'ADF' // <Color RGB> or <Color Name> (default 555)
  status: 'v1.2.3', // <Text>, required
  color: 'blue',    // <Color RGB> or <Color Name> (default blue)
  style: 'flat',    // 'flat' or undefined
  icon: 'data:image/svg+xml;base64,...', // Use icon
  iconWidth: 13,    // Set this if icon is not square
})

Available color names:

In browser

<script src="https://wzrd.in/standalone/badgen@latest"></script>
<script>
  var svgString = badgen({ /*...*/ })
</script>

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)

See Also