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
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
Héritage
Hérite de
Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- valuerequisstring
- 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.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
QR code with high error correction and icon overlay