Skip to content

Repository files navigation

JsBarcode

Build StatusScrutinizer Code QualityCDNLicense

Introduction

JsBarcode is a barcode generator written in JavaScript. It supports multiple barcode formats and works in browsers and with Node.js. It has no dependencies when it is used for the web but works with jQuery if you are into that.

Demo

Supported barcodes:

Examples for browsers:

First create a canvas (or image)

<svgid="barcode"></svg><!-- or --><canvasid="barcode"></canvas><!-- or --><imgid="barcode"/>

Simple example:

JsBarcode("#barcode","Hi!");// or with jQuery$("#barcode").JsBarcode("Hi!");
Result:

Result

Example with options:

JsBarcode("#barcode","1234",{format: "pharmacode",lineColor: "#0aa",width:4,height:40,displayValue: false});
Result:

Result

More advanced use case:

JsBarcode("#barcode").options({font: "OCR-B"})// Will affect all barcodes.EAN13("1234567890128",{fontSize: 18,textMargin: 0}).blank(20)// Create space between the barcodes.EAN5("12345",{height: 85,textPosition: "top",fontSize: 16,marginTop: 15}).render();
Result:

Result

Or define the value and options in the HTML element:

Use any jsbarcode-* or data-* as attributes where * is any option.

<svgclass="barcode"
jsbarcode-format="upc"
jsbarcode-value="123456789012"
jsbarcode-textmargin="0"
jsbarcode-fontoptions="bold"></svg>

And then initialize it with:

JsBarcode(".barcode").init();
Result:

Result

Retrieve the barcode values so you can render it any way you'd like

Pass in an object which will be filled with data.

constdata={};JsBarcode(data,'text',{...options});

data will be filled with a encodings property which has all the needed values. See wiki for an example of what data looks like.

Setup for browsers:

Step 1:

Download or get the CDN link to the script:

NameSupported barcodesSize (gzip)CDN / Download
AllAll the barcodes!10.1 kBJsBarcode.all.min.js
CODE128CODE128 (auto and force mode)6.2 kBJsBarcode.code128.min.js
CODE39CODE395.1 kBJsBarcode.code39.min.js
EAN / UPCEAN-13, EAN-8, EAN-5, EAN-2, UPC (A)6.7 kBJsBarcode.ean-upc.min.js
ITFITF, ITF-145 kBJsBarcode.itf.min.js
MSIMSI, MSI10, MSI11, MSI1010, MSI11105 kBJsBarcode.msi.min.js
PharmacodePharmacode4.7 kBJsBarcode.pharmacode.min.js
CodabarCodabar4.9 kBJsBarcode.codabar.min.js

Step 2:

Include the script in your code:

<scriptsrc="JsBarcode.all.min.js"></script>

Step 3:

You are done! Go generate some barcodes 😄

Bower and npm:

You can also use Bower or npm to install and manage the library.

bower install jsbarcode --save
npm install jsbarcode --save

Node.js:

With canvas:

varJsBarcode=require('jsbarcode');// Canvas v1varCanvas=require("canvas");// Canvas v2var{ createCanvas }=require("canvas");// Canvas v1varcanvas=newCanvas();// Canvas v2varcanvas=createCanvas();JsBarcode(canvas,"Hello");// Do what you want with the canvas// See https://github.com/Automattic/node-canvas for more information

With svg:

const{ DOMImplementation, XMLSerializer }=require('xmldom');constxmlSerializer=newXMLSerializer();constdocument=newDOMImplementation().createDocument('http://www.w3.org/1999/xhtml','html',null);constsvgNode=document.createElementNS('http://www.w3.org/2000/svg','svg');JsBarcode(svgNode,'test',{xmlDocument: document,});constsvgText=xmlSerializer.serializeToString(svgNode);

Options:

For information about how to use the options, see the wiki page.

OptionDefault valueType
format"auto" (CODE128)String
width2Number
height100Number
displayValuetrueBoolean
textundefinedString
fontOptions""String
font"monospace"String
textAlign"center"String
textPosition"bottom"String
textMargin2Number
fontSize20Number
background"#ffffff"String (CSS color)
lineColor"#000000"String (CSS color)
margin10Number
marginTopundefinedNumber
marginBottomundefinedNumber
marginLeftundefinedNumber
marginRightundefinedNumber
validfunction(valid){}Function

Contributions and feedback:

We ❤️ contributions and feedback.

If you want to contribute, please check out the CONTRIBUTING.md file.

If you have any question or suggestion create an issue or ask about it in the gitter chat.

Bug reports should always be done with a new issue.

License:

JsBarcode is shared under the MIT license. This means you can modify and use it however you want, even for comercial use. But please give this the Github repo a ⭐ and write a small comment of how you are using JsBarcode in the gitter chat.

About

Barcode generation library written in JavaScript that works in both the browser and on Node.js

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages