Skip to main content

svgRenderer

SVG output for QR codes.

local svg = SvgRenderer.render(qr, { border = 4 })
local uri = SvgRenderer.toDataUri(svg)

Functions​

render​

</>
svgRenderer.render(
qr: QrCode,
options: SvgOptions?
) → string

Types

​

interface SvgOptions {
border: number?
lightColor: string?
darkColor: string?
moduleSize: number?
}

Render QR code as SVG.

renderMinimal​

</>
svgRenderer.renderMinimal(
qr: QrCode,
border: number?
) → string

Render QR code as minimal path-based SVG.

toDataUri​

</>
svgRenderer.toDataUri(svg: string) → string

Convert SVG to data URI.

Show raw api
{
    "functions": [
        {
            "name": "render",
            "desc": "Render QR code as SVG.",
            "params": [
                {
                    "name": "qr",
                    "desc": "",
                    "lua_type": "QrCode"
                },
                {
                    "name": "options",
                    "desc": "",
                    "lua_type": "SvgOptions?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 58,
                "path": "src/svgRenderer.luau"
            }
        },
        {
            "name": "renderMinimal",
            "desc": "Render QR code as minimal path-based SVG.",
            "params": [
                {
                    "name": "qr",
                    "desc": "",
                    "lua_type": "QrCode"
                },
                {
                    "name": "border",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 98,
                "path": "src/svgRenderer.luau"
            }
        },
        {
            "name": "toDataUri",
            "desc": "Convert SVG to data URI.",
            "params": [
                {
                    "name": "svg",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 117,
                "path": "src/svgRenderer.luau"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "SvgOptions",
            "desc": "",
            "fields": [
                {
                    "name": "border",
                    "lua_type": "number?",
                    "desc": ""
                },
                {
                    "name": "lightColor",
                    "lua_type": "string?",
                    "desc": ""
                },
                {
                    "name": "darkColor",
                    "lua_type": "string?",
                    "desc": ""
                },
                {
                    "name": "moduleSize",
                    "lua_type": "number?",
                    "desc": ""
                }
            ],
            "source": {
                "line": 23,
                "path": "src/svgRenderer.luau"
            }
        }
    ],
    "name": "svgRenderer",
    "desc": "SVG output for QR codes.\n\n```lua\nlocal svg = SvgRenderer.render(qr, { border = 4 })\nlocal uri = SvgRenderer.toDataUri(svg)\n```",
    "source": {
        "line": 12,
        "path": "src/svgRenderer.luau"
    }
}