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

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.

typescript

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.

errorCorrectionLevel
TQrCodeErrorCorrectionLevel
Reed-Solomon redundancy level — same semantics as IQrCodeProps.
foreground
string
Raw CSS colour painted on dark modules.
background
string
Raw CSS colour painted behind the matrix (quiet zone).
margin
number
Quiet-zone padding in module units.
cornerRadius
number
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.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Generating a QR code SVG directly with useQrCode

typescript