CardOptions

Defined in: render/dist/card.d.ts:38

Properties

accent?

optional accent?: string

Defined in: render/dist/card.d.ts:48

Foreground / accent colour for text + silhouette artwork.

---

amountLabel?

optional amountLabel?: string

Defined in: render/dist/card.d.ts:42

Optional amount label rendered below the QR.

---

background?

optional background?: string

Defined in: render/dist/card.d.ts:46

Background colour of the entire card.

---

centerOverlay?

optional centerOverlay?: boolean

Defined in: render/dist/card.d.ts:61

Overlay the Thai QR Payment icon at the centre of the QR matrix. Defaults to true for theme: 'color', false for 'silhouette'. Always pair with encodeQR({ errorCorrectionLevel: 'Q' | 'H' }) so the obscured modules are recoverable.

---

headerLogo?

optional headerLogo?: "PromptPay1" | "PromptPay2" | "Thai_QR_Payment_Logo-01"

Defined in: render/dist/card.d.ts:52

Override the Thai QR Payment header logo by registry name.

---

merchantName?

optional merchantName?: string

Defined in: render/dist/card.d.ts:44

Optional merchant name rendered below the QR (above the amount).

---

promptpayLogo?

optional promptpayLogo?: "PromptPay1" | "PromptPay2" | "Thai_QR_Payment_Logo-01"

Defined in: render/dist/card.d.ts:54

Override the PromptPay sub-mark by registry name.

---

qrColor?

optional qrColor?: string

Defined in: render/dist/card.d.ts:50

QR module fill colour. Defaults to #000000 for max scanner contrast.

---

theme?

optional theme?: CardTheme

Defined in: render/dist/card.d.ts:40

Brand artwork flavor. color keeps full fidelity, silhouette is monochrome.