Skip to content

Repository files navigation

quick-response

Customizable QR codes as crisp SVG — a centered logo overlay, twelve module shapes, square or circular frames, styleable finder patterns, gradients, PNG/JPEG/WebP export, zero third-party dependencies.

Live demo →

Packages

PackageVersionWhat it is
quick-response-corenpmPure functions: string → SVG paths or a full <svg> string. No DOM, no framework.
react-quick-responsenpmThe React component, built on the core.
// Reactimport{ReactQR}from"react-quick-response";<ReactQRvalue="https://example.com"size={200}shape="rounded"/>;
// Anywhere elseimport{toSVGString}from"quick-response-core";constsvg=toSVGString({value: "https://example.com",size: 200});

Full docs: core · react

Development

pnpm workspace. Node 22+, pnpm 11+.

pnpm install # install every package and example
pnpm dev # run the Vite playground (examples/vite)
pnpm build # build core, then react
pnpm lint # lint both packages

Layout:

packages/core quick-response-core — encoder, path builders, buildQR/toSVGString
packages/react react-quick-response — the <ReactQR /> component
examples/vite playground deployed to GitHub Pages
examples/ssr React Router SSR smoke test

Both examples resolve react-quick-response and quick-response-core to the workspace sources through Vite aliases, so pnpm dev gives HMR with no build step.

Releases are automated with semantic-release on main: both packages are published in lockstep at the same version, core first.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT

About

Lightweight React QR code component — generate customizable QR codes as SVG with a centered logo overlay, dot/rounded module shapes, and zero dependencies.

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages