Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/luciorubeens/ark-qrcode

A web component to generate QR codes for ARK payments.
https://github.com/luciorubeens/ark-qrcode

Last synced: 4 days 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 7 years ago)
Default Branch: master
Last Pushed: 2018-01-23T12:30:21.000Z (almost 7 years ago)
Last Synced: 2024-07-08T14:48:32.890Z (4 months ago)
Language: TypeScript
Size: 135 KB
Stars: 3
Watchers: 2
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

        ![](https://user-images.githubusercontent.com/4539235/35275160-96fc3da0-001d-11e8-9908-e43d0e40bac9.png)

# ARK QR Code

> A web component to generate QR codes for ARK payments.

[![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)]()

## 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.