IUseQrCodeOptions
interface
Composable Options
Lower-level options accepted by useQrCode. Unlike IQrCodeProps, the composable does not speak the canonical DS contracts — it only owns the raw SVG string. The wrapper component is responsible for mapping color/bgColor/rounded down to the primitive foreground/background/cornerRadius keys here.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- errorCorrectionLevelTQrCodeErrorCorrectionLevel
- Reed-Solomon redundancy level — same semantics as IQrCodeProps.
- foregroundstring
- Raw CSS colour painted on dark modules.
- backgroundstring
- Raw CSS colour painted behind the matrix (quiet zone).
- marginnumber
- Quiet-zone padding in module units.
- cornerRadiusnumber
- Per-module corner radius in module units (0 = square, 0.5 = circle). The component layer derives this from the public qrCodeProps.rounded prop.
- logo{ src: string size?: number padding?: number background?: string }
- Optional logo overlay rendered inside the SVG via <image>. Public consumers should use the image prop on OrigamQrCode.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Generating a QR code SVG directly with useQrCode