QR Code
Render a scannable QR code, optionally branded with a centered logo. Compose a QrCode.Frame (the svg) wrapping a QrCode.Pattern (the modules) inside a QrCode.Root.
When to use
- Encode a string as a QR code that a phone camera can scan: a URL, an
otpauth://MFA enrollment URI, a Wi-Fi credential, and so on. - Brand the code with a logo in a centered
QrCode.Overlay. See Error correction.
Error correction
A QrCode.Overlay hides the modules beneath it, so raise the error correction
level via the ecc prop to keep the code scannable. Levels are L (~7%), M
(~15%), Q (~25%), and H (~30%). Prefer H whenever a logo is present.
The default level is L, which is plenty when no overlay covers modules.
Sizing
The Frame defaults to a square size-48. Because the encoded pattern scales
to the frame's viewBox, resize the whole code by passing a different size to
the Frame's className.
Quiet zone
A QR code includes a margin of light modules around the pattern (the quiet
zone) that scanners rely on to locate the code. It's encoded into the grid
itself, not cosmetic CSS padding, so adjust it with the quietZone prop on
Root rather than className. It defaults to 4, the QR spec's recommended
margin. Lower it to tighten the surrounding whitespace; avoid 0, which makes
the code unreliable for many scanners.
Composition
QrCode.Root encodes the value with the dependency-free uqr library. Compose the parts of a QrCode together to build your own:
Polymorphism
QrCode.Root and QrCode.Overlay support the asChild prop. When asChild is
true, the part renders its single child instead of its default element,
forwarding all class names, data-* attributes, and behavior onto that child
(for example, to render the whole code as a link).
QrCode.Frame and QrCode.Pattern render fixed SVG elements (svg and path)
and do not support asChild: the QR pattern must live inside an svg, so those
elements cannot be swapped.
Accessibility
QrCode.Frame is the image a screen reader meets. It always carries role="img". Pass an aria-label (or aria-labelledby) that says what the code encodes, so the reader knows what a scan does. When neither is set, the name falls back to "QR code".
An Overlay logo is decorative: the frame's name already describes the code.
API Reference
QrCode.Root
The root container. Encodes value and renders a white tile around the code.
Renders a div.
All props from div, plus:
QrCode.Frame
The svg frame that holds the Pattern. Defaults to size-48 and scales the
pattern to fit via its viewBox. Renders an svg with role="img". Pass
aria-label or aria-labelledby to name it; the name falls back to "QR code".
Does not support asChild.
Accepts all props from svg except role.
QrCode.Pattern
The encoded modules, rendered as a single path inside the Frame. Defaults
to a black fill; a className can override it, but a light or inverted fill
makes the code unreliable for many scanners. Renders a path. Does not
support asChild.
Accepts all props from path.
QrCode.Overlay
A container centered on top of the code, typically holding a brand logo. Renders
a white rounded "punch-out" so the logo stays legible. Renders a div.
All props from div, plus: