@larscom/ng-qrcode-svg
Version:
Simple QR code generator (SVG only) for Angular
49 lines (35 loc) • 2.28 kB
Markdown
# @larscom/ng-qrcode-svg
[](https://www.npmjs.com/package/@larscom/ng-qrcode-svg)
[](https://github.com/larscom/ng-qrcode-svg/blob/main/LICENSE)
> Simple QR code generator (SVG only) for Angular
## Installation
```bash
npm install @larscom/ng-qrcode-svg
```
## Usage
1. Import component `QrcodeSvgComponent`
```ts
import { NgModule } from '@angular/core'
import { QrcodeSvgComponent } from '@larscom/ng-qrcode-svg'
@NgModule({
imports: [QrcodeSvgComponent]
})
export class MyModule {}
```
2. Use the `qrcode-svg` component which will render a QR code in SVG format
```html
<qrcode-svg value="hello world!"></qrcode-svg>
```
## Component Properties
| Name | Description | Default |
| ------------------------------------------------------- | --------------------------------------------------------- | --------- |
| @Input() value: string | The value which need to be encoded | undefined |
| @Input() ecl: 'low' \| 'medium' \| 'quartile' \| 'high' | Error correction level | medium |
| @Input() borderSize: number | The padding between the edge and the QR code (quiet zone) | 2 |
| @Input() size: string \| number | The size of the QR code SVG (css format) | 250px |
| @Input() backgroundColor: string | The 'path' color (background) | #FFFFFF |
| @Input() foregroundColor: string | The 'rect' color (foreground) | #000000 |
| @Input() alt: string \| undefined | HTML alt attribute | undefined |
| @Input() ariaLabel: string \| undefined | HTML aria-label attribute | undefined |