IQrCodeProps
interface
Data Display
Full props contract for <OrigamQrCode> — SSR-safe SVG QR code renderer. Extends all common DS surface contracts plus QR-specific controls for value, error correction level, quiet zone, overlays and accessibility.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- valuerequiredstring
- Text or URL encoded into the QR matrix. UTF-8 is supported via the underlying qrcode-generator Byte mode.
- titlestring
- Optional heading rendered above the QR matrix inside the wrapper.
- qrCodePropsIQrCodeOptions
- Per-matrix overrides (color, bgColor, rounded) applied to the SVG internals, not the wrapper.
- errorCorrectionLevelTQrCodeErrorCorrectionLevel
- Reed-Solomon redundancy level (L | M | Q | H). Higher levels tolerate more damage at the cost of density. Default "M".
- quietZonenumber
- Number of modules reserved as quiet-zone padding. ISO spec mandates >=4. Default 4.
- iconTIcon
- Optional centred MDI icon overlay rendered on top of the matrix via <OrigamIcon>.
- imagestring | ISrcObject
- Optional centred image overlay. Accepts a raw URL or an ISrcObject shape. Rendered as an <OrigamAvatar> overlay.
- ariaLabelstring
- Accessible aria-label. Falls back to "QR code for {value}" when omitted.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
QR code with high error correction and icon overlay