# phantom-qrcode
> A web component to generate QR codes for PHANTOM payments.
Latest version **0.1.0** (published 2018-08-28) · MIT license · 0 weekly downloads
## Install
```sh
npm install phantom-qrcode
pnpm add phantom-qrcode
yarn add phantom-qrcode
bun add phantom-qrcode
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-08-28 |
| First published | 2018-08-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Lúcio Rubens |
| Maintainers | phantomcores |
## Links
- npm: https://www.npmjs.com/package/phantom-qrcode
- Repository: https://github.com/PhantomCore/qrcode
- Issues: https://github.com/PhantomCore/phantom-qrcode
- npm.io page: https://npm.io/package/phantom-qrcode
## Dependencies (3)
- [qrious](https://npm.io/package/qrious.md) ^4.0.2
- [@stencil/core](https://npm.io/package/@stencil/core.md) ^0.7.20
- [@stencil/sass](https://npm.io/package/@stencil/sass.md) 0.0.3
## Recent versions
- 0.1.0 (latest) — 2018-08-28
- 0.0.9 — 2018-08-28
- 0.0.8 — 2018-08-28
- 0.0.7 — 2018-08-28
## README
# PHANTOM QR Code
> A web component to generate QR codes for PHANTOM payments.
[]()
## Install
### Script tag
- @todo put dist version on cdn server
### Node Modules
- Run `npm install phantom-qrcode --save`
- Put this script tag `` in the head of your index.html
### In a stencil-starter app
- Run `npm install phantom-qrcode --save`
- Add `{ name: 'phantom-qrcode' }` to your `collections`.
## Usage
Insert the element in your code and enter your custom properties:
```html
```
## Examples
```html
```
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 | Phantom recipient address encoded in Base58. | String | Yes |
| amount | Amount in PHANTOM (Ẕ) or DPHANTOM (DẔ). | Number | No |
| label | Recipient label string. | String | No |
| size | Size of the QR code (pixels) | Number | No |
| show-logo | Display the PHANTOM 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 [PHANTOM URI scheme](https://github.com/ArkEcosystem/AIPs/blob/master/AIPS/aip-13.md#simpler-syntax).
```javascript
document.querySelector('phantom-qrcode').getURI();
// => phantom:DE6os4N86ef9bba6kVGurqxmhpBHKctoxY?amount=20.3
```
### `getDataURL([mime])`
Generates a base64 encoded data URI for the QR code.
```javascript
document.querySelector('phantom-qrcode').getDataURL();
// => data:image/png;base64,iVBORw0KGgoAAAANSUhE...n6ofvMC4I9AAAAAElFTkSuQmCC
```
### `validateURI(uri)`
Validate an URI string.
```javascript
const uri = 'phantom:DE6os4N86ef9bba6kVGurqxmhpBHKctoxY?amount=10.5';
document.querySelector('phantom-qrcode').validateURI(uri);
// => ["phantom:DE6os4N86ef9bba6kVGurqxmhpBHKctoxY?amount=10.5", "DE6os4N86ef9bba6kVGurqxmhpBHKctoxY", "?amount=10.5"]
```
### `deserializeURI(uri)`
Deserialize the URI scheme to a JSON object.
```javascript
const uri = 'phantom:DE6os4N86ef9bba6kVGurqxmhpBHKctoxY?amount=10.5&vendorField=Hello%20Phantom!';
document.querySelector('phantom-qrcode').deserializeURI(uri);
// => { address: 'DE6os4N86ef9bba6kVGurqxmhpBHKctoxY', amount: 10.5, label: null, vendorField: 'Hello Phantom!' }
```
### `fromObject(obj)`
Instantiate a URI from an Object.
```javascript
const obj = { address: DE6os4N86ef9bba6kVGurqxmhpBHKctoxY, amount: 10.5 };
const element = document.querySelector('phantom-qrcode').fromObject(obj);
// =>
```
## Security
If you discover a security vulnerability within this project, please send an e-mail to security@phantom.org. All security vulnerabilities will be promptly addressed.
## Authors
- Lúcio Rubens
## License
PHANTOM QRCode is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
---
_Source: https://npm.io/package/phantom-qrcode · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._