QRCodeOptions
Defined in: packages/core/src/core/QRCodeSvgRendererOptions.ts:6
Extends
Section titled “Extends”Omit<QRCodeRenderersOptions,"margin">
Properties
Section titled “Properties”aria-hidden?
Section titled “aria-hidden?”
optionalaria-hidden:boolean
Defined in: packages/core/src/core/QRCodeSvgRendererOptions.ts:11
aria-label?
Section titled “aria-label?”
optionalaria-label:string
Defined in: packages/core/src/core/QRCodeSvgRendererOptions.ts:9
aria-labelledby?
Section titled “aria-labelledby?”
optionalaria-labelledby:string
Defined in: packages/core/src/core/QRCodeSvgRendererOptions.ts:10
color?
Section titled “color?”
optionalcolor:object
Defined in: node_modules/.pnpm/@types+qrcode@1.5.6/node_modules/@types/qrcode/index.d.ts:172
optionaldark:string
Color of dark module. Value must be in hex format (RGBA).
Note: dark color should always be darker than color.light.
Default
Section titled “Default”'#000000ff'light?
Section titled “light?”
optionallight:string
Color of light module. Value must be in hex format (RGBA).
Default
Section titled “Default”'#ffffffff'Inherited from
Section titled “Inherited from”Omit.color
errorCorrectionLevel?
Section titled “errorCorrectionLevel?”
optionalerrorCorrectionLevel:QRCodeErrorCorrectionLevel
Defined in: node_modules/.pnpm/@types+qrcode@1.5.6/node_modules/@types/qrcode/index.d.ts:18
Error correction level.
Default
Section titled “Default”'M'Inherited from
Section titled “Inherited from”Omit.errorCorrectionLevel
fontSize?
Section titled “fontSize?”
optionalfontSize:number|`${number}%`|null
Defined in: packages/core/src/core/QRCodeSvgRendererOptions.ts:7
margin?
Section titled “margin?”
optionalmargin:number|`${number}%`|null
Defined in: packages/core/src/core/QRCodeSvgRendererOptions.ts:8
maskPattern?
Section titled “maskPattern?”
optionalmaskPattern:QRCodeMaskPattern
Defined in: node_modules/.pnpm/@types+qrcode@1.5.6/node_modules/@types/qrcode/index.d.ts:24
Mask pattern used to mask the symbol.
If not specified the more suitable value will be calculated.
Inherited from
Section titled “Inherited from”Omit.maskPattern
scale?
Section titled “scale?”
optionalscale:number
Defined in: node_modules/.pnpm/@types+qrcode@1.5.6/node_modules/@types/qrcode/index.d.ts:165
Scale factor. A value of 1 means 1px per modules (black dots).
Default
Section titled “Default”4Inherited from
Section titled “Inherited from”Omit.scale
toSJISFunc?
Section titled “toSJISFunc?”
optionaltoSJISFunc:QRCodeToSJISFunc
Defined in: node_modules/.pnpm/@types+qrcode@1.5.6/node_modules/@types/qrcode/index.d.ts:29
Helper function used internally to convert a kanji to its Shift JIS value. Provide this function if you need support for Kanji mode.
Inherited from
Section titled “Inherited from”Omit.toSJISFunc
version?
Section titled “version?”
optionalversion:number
Defined in: node_modules/.pnpm/@types+qrcode@1.5.6/node_modules/@types/qrcode/index.d.ts:13
QR Code version. If not specified the more suitable value will be calculated.
Inherited from
Section titled “Inherited from”Omit.version
width?
Section titled “width?”
optionalwidth:number
Defined in: node_modules/.pnpm/@types+qrcode@1.5.6/node_modules/@types/qrcode/index.d.ts:171
Forces a specific width for the output image.
If width is too small to contain the qr symbol, this option will be ignored.
Takes precedence over scale.
Inherited from
Section titled “Inherited from”Omit.width