https://github.com/gwuhaolin/pure-svg-code

Generate qrcode & barcode to svg in pure javascript
https://github.com/gwuhaolin/pure-svg-code

Last synced: 4 months ago
JSON representation

Generate qrcode & barcode to svg in pure javascript

• Host: GitHub
• URL: https://github.com/gwuhaolin/pure-svg-code
• Owner: gwuhaolin
• Created: 2017-12-21T07:31:19.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-02-21T20:06:01.000Z (almost 3 years ago)
• Last Synced: 2024-10-03T12:16:20.728Z (5 months ago)
• Language: JavaScript
• Homepage:
• Size: 33.2 KB
• Stars: 49
• Watchers: 3
• Forks: 15
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Npm Package](https://img.shields.io/npm/v/pure-svg-code.svg?style=flat-square)](https://www.npmjs.com/package/pure-svg-code)

[![Build Status](https://img.shields.io/travis/gwuhaolin/pure-svg-code.svg?style=flat-square)](https://travis-ci.org/gwuhaolin/pure-svg-code)

[![Npm Downloads](http://img.shields.io/npm/dm/pure-svg-code.svg?style=flat-square)](https://www.npmjs.com/package/pure-svg-code)

# pure-svg-code

Generate qrcode and barcode

## Feature

- SVG: can be used in any client support render svg like browser & 小程序 & Node.js;

- Small: write in pure javascript, no dependency;

- Typescript: support Typescript;  

## Install

Install from npm:

```bash

npm i pure-svg-code

```

Import it:

```js

// import both

const {barcode,qrcode,svg2url} = require('pure-svg-code');

// import as you need

const barcode = require('pure-svg-code/barcode');

const qrcode = require('pure-svg-code/qrcode');

const svg2url = require('pure-svg-code/svg2url');

```

#### File size:

- qrcode: minified 17Kb, Gzip 5.7Kb

- barcode: minified 19Kb, Gzip 6.2Kb

## qrcode

```js

const svgString = qrcode({

  content: "http://github.com/",

  padding: 4,

  width: 256,

  height: 256,

  color: "#000000",

  background: "#ffffff",

  ecl: "M"    

})

```

Output [svg content](qrcode/qrcode.svg):

```xml

...

```

#### List of options:

- `content` - QR Code content, required

- `padding` - white space padding, `4` modules by default, `0` for no border

- `width` - QR Code width in pixels

- `height` - QR Code height in pixels

- `color` - color of modules, color name or hex string, e.g. `#000000`

- `background` - color of background, color name or hex string, e.g. `white`

- `ecl` - error correction level: `L`, `M`, `H`, `Q`

## barcode

Set it up and specify your type and options. The following 3 are the only

required ones.

```javascript

var svgString = barcode("9234567890128", "ean13", {width:'50', barWidth:1, barHeight:50});

```

Output [svg content](barcode/barcode.svg):

```xml

  

  

  ...

```

#### Support types:

- codabar

- code11 (code 11)

- code39 (code 39)

- code93 (code 93)

- code128 (code 128)

- ean8 (ean 8)

- ean13 (ean 13)

- std25 (standard 2 of 5 - industrial 2 of 5)

- int25 (interleaved 2 of 5)

#### Support options:

- `barHeight` height of svg (default: 30);

- `width` width of svg (default: 100);

- `bgColor` background color css like (default: 'transparent');

- `color` barcode color (default: '#000000');

- `showHRI`: should show text under bar;

## Use it with `` tag

```js

const {qrcode,svg2url} = require('pure-svg-code');

const svgString = qrcode('data');

const url = svg2url(svgString);

// set img element's src to url

imgEle.src = url;

```

This way can be used for browser & 小程序 or any client can render svg.

## Use it in Node.js server

```js

const {qrcode} = require('pure-svg-code');

app.get('/',function(req, res) {

    const svgString = qrcode('data');

    res.send(svgString)

})

```