https://github.com/luciorubeens/ark-qrcode
A web component to generate QR codes for ARK payments.
https://github.com/luciorubeens/ark-qrcode
Last synced: 7 months ago
JSON representation
A web component to generate QR codes for ARK payments.
- Host: GitHub
- URL: https://github.com/luciorubeens/ark-qrcode
- Owner: luciorubeens
- License: mit
- Created: 2018-01-19T06:23:35.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-23T12:30:21.000Z (almost 8 years ago)
- Last Synced: 2025-04-10T02:00:06.815Z (8 months ago)
- Language: TypeScript
- Size: 135 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ark - Ark-QRCode - A web component to generate QR codes for ARK payments. (User Interfaces / Web)
README
# ARK QR Code
> A web component to generate QR codes for ARK payments.
[]()
## Install
### Script tag
- Put this script tag `` in the head of your index.html
### Node Modules
- Run `npm install ark-qrcode --save`
- Put this script tag `` in the head of your index.html
### In a stencil-starter app
- Run `npm install ark-qrcode --save`
- Add `{ name: 'ark-qrcode' }` to your `collections`.
## Usage
Insert the element in your code and enter your custom properties:
```html
```
## Examples
```html
document.querySelector('ark-qrcode').getURI();
// => ark:DE6os4N86ef9bba6kVGurqxmhpBHKctoxY?amount=10.5&vendorField=Hello%20Ark!
```
Generate this QR code:
## Properties
This package complies with the specifications described in [AIP-13](https://github.com/ArkEcosystem/AIPs/blob/master/AIPS/aip-13.md).
| 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 |
## Methods
You can interact with the component data using the methods below:
### `getURI()`
Format the properties entered to the [ARK URI scheme](https://github.com/ArkEcosystem/AIPs/blob/master/AIPS/aip-13.md#simpler-syntax).
```javascript
document.querySelector('ark-qrcode').getURI();
// => ark:DE6os4N86ef9bba6kVGurqxmhpBHKctoxY?amount=20.3
```
### `getDataURL([mime])`
Generates a base64 encoded data URI for the QR code.
```javascript
document.querySelector('ark-qrcode').getDataURL();
// => data:image/png;base64,iVBORw0KGgoAAAANSUhE...n6ofvMC4I9AAAAAElFTkSuQmCC
```
### `deserializeURI(uri)`
Deserialize the URI scheme to a JSON object.
```javascript
const uri = 'ark:DE6os4N86ef9bba6kVGurqxmhpBHKctoxY?amount=10.5&vendorField=Hello%20Ark!';
document.querySelector('ark-qrcode').deserializeURI(uri);
// => { address: 'DE6os4N86ef9bba6kVGurqxmhpBHKctoxY', amount: 10.5, label: null, vendorField: 'Hello Ark!' }
```
## Authors
- Lúcio Rubens
## License
ARK QRCode is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.