Custom renderers
A QRCodeRenderer<T> receives an immutable QR matrix and returns any output type. It owns its
layout, drawing, and output-specific options. The shared drawing pipeline used by built-in renderers
is internal to the SDK.
For custom shapes in SVG, Canvas, Image element, and Node.js raster output, use the public shape paths and styling factories.
Matrix-only renderer
Section titled “Matrix-only renderer”import {type QRCodeRenderer, qrcode} from '@qrcodesdk/core';
const textRenderer: QRCodeRenderer<string> = ({size, modules}) => { const rows: string[] = []; for (let y = 0; y < size; y++) { let row = ''; for (let x = 0; x < size; x++) row += modules[y * size + x] === 1 ? '#' : '.'; rows.push(row); } return rows.join('\n');};
const text = qrcode('custom output').render(textRenderer);Matrix data
Section titled “Matrix data”A QRCodeMatrix is a read-only object with flat, row-major module data. The module at column x
and row y is at index y * size + x in both arrays:
| Property | Type | Meaning |
|---|---|---|
size |
number |
Modules per side, without a quiet zone |
modules |
readonly (0 | 1)[] |
1 for a dark module and 0 for a light module |
roles |
readonly QRCodeModuleRole[] |
The module role of every module |
Module roles
Section titled “Module roles”roles records the function of every module, light or dark. QR_CODE_MODULE_ROLES from
@qrcodesdk/core/matrix names the values:
| Value | Name | Modules |
|---|---|---|
0 |
data |
Data and error correction |
1 |
finderRing |
7 × 7 finder ring, including the light gap inside it |
2 |
finderCenter |
3 × 3 finder center |
3 |
separator |
Light border around each finder pattern |
4 |
alignmentRing |
5 × 5 alignment ring, including the light gap inside it |
5 |
alignmentCenter |
1 × 1 alignment center |
6 |
timing |
Timing patterns |
7 |
format |
Format information, including the always-dark module |
8 |
version |
Version information, in version 7 and later |
Roles depend only on the version. Every matrix of the same size shares one roles array.
Both arrays are frozen. Use slice() to obtain a mutable copy.
import {qrcode} from '@qrcodesdk/core';import {QR_CODE_MODULE_ROLES} from '@qrcodesdk/core/matrix';
const {size, modules, roles} = qrcode('custom output').matrix();let darkDataModules = 0;for (let index = 0; index < size * size; index++) { if (modules[index] === 1 && roles[index] === QR_CODE_MODULE_ROLES.data) darkDataModules++;}Related pages
Section titled “Related pages”Support QRCodeSDK
If you find QRCodeSDK useful, please consider sponsoring the project!