Render 1-D barcodes to canvas, svg, or path. Supports Code 128, 3 of 9, 2 of 5, EAN, and more.
Why?
This barcode library has no dependencies 👍.
This barcode library specializes in its use of the canvas API. You provide a canvas (be it in a browser or with node-canvas), and then specify where the barcode should be drawn, how large it should be, and at what angle.
Other barcode libraries that I found created pngs or svgs directly and were not very flexible in the output size (i.e. no maxWidth
option). Rendering directly to a canvas allows for a flexible API if that's your target anyway. You can also easily generate SVG or Path text output.
Demos/Playground
First of all, check out the demos.
Barcode Generator
Did you ever want to paste a list of strings and download a zip file of corresponding images? Well I did once and made this barcode-generator. See demos for the source.
How?
// In the browservar canvas = document;var g = canvas;;
// On the servervar bardcode = ;var Canvas = ;var canvas = 595 842 "pdf";var g = canvas;bardcode;
// Meteor servervar Canvas = Meteor;var canvas = 595 842 "pdf";var g = canvas;;
Symbology
The following barcode formats are supported:
- Codabar
- Code 128 (and GS1 128)
- Code 39
- EAN-8
- EAN-13
- FIM
- ITF (interleaved 2 of 5)
- UPC-A
API
// browser+meteor; // nodevar bardcode = ;bardcode;
g
is a Canvas' 2-D graphics context or the output format. The only supported non-canvas output format is"svg"
.barcodeText
is a string or an array (in case you want to include command characters like "FNC 1"). Allowed characters depend on the chosen symbology. You generally don't need to include start, end, or check characters.options
is an optional object with the following properties:options.type
Barcode type. Defaults to Code 128. Other valid options are "GS1 128", "Codabar", "Code 39", "EAN-8", "EAN-13", "FIM", "ITF" (interleaved 2 of 5), and "UPC-A".options.hasChecksum
If true, the barcode already has a checksum (which will be validated); if false, calculate and add a checksum. Defaults to false. Currently works only for EAN-type barcodes (EAN-8, EAN-13, UPC-A).options.x
Where to draw barcode. Defaults to 0.options.y
Where to draw the barcode. Defaults to 0.options.horizontalAlign
How to align the barcode. Defaults to "left". Other options are "center" and "right".options.verticalAlign
How to align the barcode. Defaults to "top". Other options are "middle" and "bottom".options.height
Barcode height. Defaults to 90.72.options.moduleWidth
Width of thinnest bar. Defaults to 2.892.options.quietZoneSize
Number of moduleWidths in quiet zone on either side. Defaults to 10.options.angle
Rotate barcode this many degrees clockwise. Defaults to 0.options.maxWidth
Maximum barcode width (including quiet zones). If specified, then the moduleWidth will be adjusted if necessary to make the entire barcode fit in the given width.options.width
If given, then ignore moduleWidth and maxWidth and set the moduleWidth so that the barcode will have the given width (including quiet zones).
Note: width
and maxWidth
refer to the unrotated barcode width.
SVG
If the first parameter to bardcode.drawBarcode
, g
, is "svg"
, then an SVG string is returned.
For the moment, the only supported options when using SVG are:
options.type
options.height
options.moduleWidth
options.quietZoneSize
options.maxWidth
options.width
Path
If the first parameter to bardcode.drawBarcode
, g
, is "path"
, then a path string is returned, like:
M 28.920,0 l 5.784,0 l 0,90.72 l -5.784,0 Z M 37.596,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 46.272,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 60.732,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 69.408,0 l 11.568,0 l 0,90.72 l -11.568,0 Z M 83.868,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 92.544,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 98.328,0 l 5.784,0 l 0,90.72 l -5.784,0 Z M 109.896,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 124.356,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 130.140,0 l 11.568,0 l 0,90.72 l -11.568,0 Z M 147.492,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 156.168,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 164.844,0 l 11.568,0 l 0,90.72 l -11.568,0 Z M 179.304,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 187.980,0 l 11.568,0 l 0,90.72 l -11.568,0 Z M 205.332,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 211.116,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 219.792,0 l 5.784,0 l 0,90.72 l -5.784,0 Z M 234.252,0 l 8.676,0 l 0,90.72 l -8.676,0 Z M 245.820,0 l 2.892,0 l 0,90.72 l -2.892,0 Z M 251.604,0 l 5.784,0 l 0,90.72 l -5.784,0 Z
For the moment, the only supported options when using path are:
options.type
options.height
options.moduleWidth
options.quietZoneSize
options.maxWidth
options.width
Errors
Errors are thrown on invalid input, for example when including letters in EAN barcodes.
Installation
node-canvas
installation causes issues for a lot of users. So it's an optional dependency (i.e. you should Bring Your Own Canvas). It's also not a node dependency because it's not the only output format.
For the browser:
- Include
dist/bardcode.js
ordist/bardcode.min.js
For node:
npm install canvas
(requires cairo)npm install bardcode
For meteor:
- (optional)
meteor add meteorhacks:npm
and add"canvas": "1.1.6"
topackages.json
meteor add froatsnook:bardcode
Testing
Tests require meteor and zbar.
- Download zbar: http://zbar.sourceforge.net/
./configure --disable-video --without-qt --without-gtk --without-python
make
- Copy
zbarimg/zbarimg
andzbar/.libs/libzbar.so*
to a new directory calledzbar
inbardcode
's project directory meteor test-packages ./
inbardcode
's project directory- Open
localhost:3000
in a browser
Contributors
Thank you:
- wolfgang42
- Tom S.
- I Putu Susila
License
MIT