ark-qrcode-react

A React component to generate QR codes for ARK payments.

Usage no npm install needed!

<script type="module">
  import arkQrcodeReact from 'https://cdn.skypack.dev/ark-qrcode-react';
</script>

README

ARK QR Code React Component

This is an unofficial spin-off of the official Ark web component to generate QR codes for ARK payments.

I wanted to be able to create Ark QR codes inside of my React app, which doesn't use TypeScript or Stencil.

Install

Node Modules

  • Run npm install ark-qrcode-react --save
  • Import the component import ArkQrCode from 'ark-qrcode-react';

Usage

Insert the element in your code and enter your custom properties:

<ArkQrCode
  address="AG2QPHeZhbaYvEhB2Sbng7HNDX2Sai1on1"
  amount={1}
  label="ArkMoon%20Donations"
  showLogo={true}
  size={200}
  vendorField="QR%20Code%20donation" />

Generates this QR code:

Properties

This package complies with the specifications described in AIP-13.

Attribute Description Type Required
address Ark recipient address encoded in Base58. String Yes
amount Amount in ARK (Ѧ) or DARK (DѦ). Number No
label Recipient label string. String No
size Size of the QR code (pixels) Number No
show-logo Display the ARK logo in QR code Boolean No
vendor-field Vendor field string (encoded URI). String No

Authors

based off of the work of:

License

ARK QRCode React is licensed under the MIT License - see the LICENSE file for details.