Skip to main content
API Documentation

Simple API. Powerful Results.

Generate custom QR codes in any platform with just a few lines of code. Full TypeScript support included.

Platform Integration Guides

Web (JavaScript/TypeScript)
Browser-based QR code generation with SVG output

Installation

npm i @intosoft/qrcode

Import

import { generateSVGString } from "@intosoft/qrcode";

Example Usage

const svg = generateSVGString({
  value: 'https://example.com',
  length: 300,
  shapes: {
    body: 'dots',
    eyeFrame: 'rounded',
    eyeball: 'circle'
  },
  colors: {
    body: '#667eea',
    eyeFrame: { topLeft: '#764ba2' }
  }
});

Configuration Options

generateSVGString() Parameters
All available configuration options for customizing your QR codes
valueRequired

The data to encode in the QR code (URL, text, etc.)

Type: string

length

Size of the QR code in pixels (default: 300)

Type: number

shapes.body

Body shape: square, dots, rounded, mosaic, etc. (31+ options)

Type: string

shapes.eyeFrame

Eye frame shape: square, circle, rounded, leaf, etc.

Type: string

shapes.eyeball

Eyeball shape: matches eyeFrame options

Type: string

colors.body

Body color as hex, or gradient object

Type: string | Gradient

logo.url

Logo image URL (PNG, JPEG, SVG, WebP)

Type: string

logo.size

Logo size in QR cells (default: 40)

Type: number

logo.padding

White space around logo (default: 0)

Type: number

logo.borderRadius

Logo corner radius in pixels

Type: number

errorCorrection

Error correction: L, M, Q, H (default: M)

Type: string

Additional Resources

Full Documentation
Complete guides for all platforms and features
Live Examples
Interactive demos and code samples
GitHub Repository
Source code, issues, and contributions

Ready to Get Started?

Install the package and start generating custom QR codes in minutes