Changelog
Version 0.0.6 Latest
Patch Changes
-
61b4d56: Add opt-in QR code Kanji mode, which packs each double-byte Shift JIS character into 13 bits instead of UTF-8 bytes, so Japanese text fits smaller symbols. Import the Shift JIS table from the new
@qrcodesdk/core/kanjientry point and pass it as thekanjimatrix option or with.kanji(kanji). The table adds about 13 kB gzipped and stays out of bundles that don’t import it.With the table,
mode: 'kanji'forces Kanji mode,automode picks Kanji mode when every character fits, andautomaticSegmentercombines Kanji segments with numeric, alphanumeric, and octet segments. Custom segmenters receive the table askanjiin their options and can return{mode: 'kanji'}segments. Kanji mode only accepts characters that decode back unchanged, and Kanji segments never get an ECI header.Kanji mode or Kanji segments without the table throw
QRCodeErrorwith codeINVALID_OPTIONS; characters outside the table throwINVALID_PAYLOAD.QRCodeEncodingModeandQRCodeModenow include'kanji', so exhaustiveswitchstatements over them need a new case. The newQRCodeKanjitype describes the table. -
0d39229: Add Micro QR codes (M1 to M4) through the new
@qrcodesdk/core/microentry point. PassmicroQR()as thesymbolmatrix option, such asqrcode('12345').options({symbol: microQR()}), to generate the smallest Micro QR code that holds the payload.microQR()acceptsversion('M1'to'M4'),mask(0to3), andfallback, which generates a standard QR code when no Micro QR code can hold the payload. Applications that do not import@qrcodesdk/core/microdo not bundle the Micro QR encoder.Micro QR codes support numeric, alphanumeric, octet, and, with the
kanjitable from@qrcodesdk/core/kanji, Kanji mode in M3 and M4. They support levelsLandM, andQin M4. M1 only detects errors, so it is used only when requested withversion: 'M1'. Settingversion,mask,eci, orsegmenternext to a Micro QR symbol throwsQRCodeErrorwith codeINVALID_OPTIONS.QRCodeMatrixOptionsis now the union ofQRCodeStandardMatrixOptionsandQRCodeSymbolMatrixOptions. Interfaces can no longer extendQRCodeMatrixOptions; extendQRCodeStandardMatrixOptionsinstead, and use it when deriving types withOmitorPick. Add theQRCodeSymbol,QRCodeMicroVersion,QRCodeMicroMask, andQRCodeMicroOptionstypes.The default
style.quietZoneof the built-in renderers is now 2 modules for Micro QR codes and stays 4 modules for standard QR codes.finder()styles only the finder patterns that a symbol contains. -
cb8c78a: Add the
vcardPayload()andcalendarPayload()payload helpers to@qrcodesdk/core/payload.vcardPayload()serializes a contact as a vCard 3.0 payload with a formatted name and optional structured name, organization, title, phones, emails, addresses, URL, and note.calendarPayload()serializes an event as an iCalendar 2.0VEVENTwith a UID, timestamp, summary, start, end, and optional location, description, and URL. SetallDay: trueto passYYYY-MM-DDdates instead of date-times; the end is exclusive.Both helpers escape text values, fold long lines, and throw
QRCodeErrorwith codeINVALID_PAYLOADfor invalid fields, such as line breaks in single-line fields, unsupported control characters, non-HTTP(S) URLs, date-times without seconds or an explicit offset, or an end that is not later than the start. Errors for nested fields use paths such asaddresses[0].postalCodeindetails.field. URL fields require the standardURLAPI. Add theQRCodeVCardPayload,QRCodeVCardName,QRCodeVCardPhone,QRCodeVCardEmail,QRCodeVCardAddress, andQRCodeCalendarPayloadtypes. -
526d0e6: Breaking:
QRCodeMatrixdescribes its dimensions withwidth(modules per row) andheight(rows) instead ofsize. Standard and Micro QR matrices are square, so both values are equal, and the module at columnxand rowyis at indexy * width + x. Replacematrix.sizewithmatrix.width, and loop overheightfor rows in custom renderers so they also draw rectangular symbols.The SVG and text renderers draw rectangular matrices, the default
style.quietZoneis 2 modules for every symbol shorter than 21 modules, and a center image is a square sized from the shorter side of the symbol and centered on both axes. Thedimensionscheck of the built-in renderers applies to the output width and height separately. -
526d0e6: Add rectangular Micro QR (rMQR) codes (ISO/IEC 23941) through the new
@qrcodesdk/core/rmqrentry point. PassrMQR()as thesymbolmatrix option, such asqrcode('LOT-2026-0042').options({symbol: rMQR()}), to generate the rMQR code with the fewest modules that holds the payload.rMQR({version: 'R7'})selects the narrowest code of a height, from'R7'to'R17', andrMQR({version: 'R7x59'})selects an exact version, from'R7x43'to'R17x139'. Applications that do not import@qrcodesdk/core/rmqrdo not bundle the rMQR encoder.rMQR codes are 7 to 17 modules high and 27 to 139 modules wide and hold up to 361 digits, 219 alphanumeric characters, 150 bytes, or 92 Kanji characters. They encode one numeric, alphanumeric, octet, or, with the
kanjitable, Kanji segment at the error-correction levelsMandH. LevelsLandQ, andversion,mask,eci, orsegmenternext to an rMQR symbol, throwQRCodeErrorwith codeINVALID_OPTIONS. Add theQRCodeRMQRVersion,QRCodeRMQRHeight, andQRCodeRMQROptionstypes.rMQR codes reuse the standard module roles: the finder sub-pattern has the alignment roles, so
alignment()styles it, and it stays square whenmoduleshas a shape, because scanners locate the code with it.
Support QRCodeSDK
If you find QRCodeSDK useful, please consider sponsoring the project!