kopia lustrzana https://github.com/badgen/badgen
09578dd4df | ||
---|---|---|
bench | ||
lib | ||
preview | ||
tap-snapshots | ||
test | ||
.gitignore | ||
.npmignore | ||
.travis.yml | ||
LICENSE.md | ||
README.md | ||
package-lock.json | ||
package.json |
README.md
badgen
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,...', // Use icon, optional
iconWidth: 13 // Use this if icon is not square.
})
Available color names:
In browser
<script src="https://cdn.jsdelivr.net/npm/badgen/badgen.min.js"></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
- gradient-badge - Badge generator with color gradient support