IQrCodeLogo
interface
Data Display
Optional logo overlay rendered at the centre of an OrigamQrCode. The overlay is painted on top of the matrix — error-correction compensates for covered modules up to the configured level.
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.
- srcrequiredstring
- Logo source URL. Any URL accepted by <image href> — SVG, PNG, data-URI. If the asset fails to load the QR matrix remains valid.
- sizenumber
- Logo width as a proportion of the QR width (0..1). Default 0.2. Values above 0.3 trigger a console.warn as no error-correction level survives that.
- paddingnumber
- Pixel padding of the opaque backdrop drawn around the logo. Default 6. Keeps adjacent modules readable.
- backgroundstring
- Backdrop colour under the logo and within the padding box. Defaults to the QR background. Pass a brand colour to create a coloured halo.
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 a centred logo overlay