@progress/kendo-angular-barcodes
Version:
Kendo UI Angular Barcodes
110 lines (109 loc) • 4.31 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { ElementRef, NgZone, Renderer2 } from '@angular/core';
import { QRCode, QRCodeOptions } from '@progress/kendo-charts';
import { BaseComponent } from './base.component';
import { Border, QRCodeEncoding, QRCodeErrorCorrection, QRCodeOverlay, RenderMode } from './chart-types';
import * as i0 from "@angular/core";
/**
* Represents the [Kendo UI QR Code component for Angular](slug:overview_qrcode_barcodes).
*
* Shows a QR Code for the provided value.
*
* @example
* ```ts
* import { Component } from '@angular/core';
*
* @Component({
* selector: 'my-app',
* template: `
* <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui">
* </kendo-qrcode>
* `
* })
* export class AppComponent {
* }
* ```
*/
export declare class QRCodeComponent extends BaseComponent {
protected element: ElementRef;
protected renderer: Renderer2;
protected ngZone: NgZone;
/**
* Sets the background color of the QR Code. Accepts any valid CSS color string, such as hex or rgb.
*
* @default "white"
*/
background?: string;
/**
* Sets the border of the QR Code.
*/
border?: Border;
/**
* Sets the color of the QR Code. Accepts any valid CSS color string, such as hex or rgb.
*
* @default "black"
*/
color?: string;
/**
* Sets the encoding mode for the value.
*
* > **Important** The UTF-8 encoding is not part of the specifications and some readers may not support it.
*
* @default "ISO_8859_1"
*/
encoding?: QRCodeEncoding;
/**
* Sets the error correction level.
*
* @default "L"
*/
errorCorrection?: QRCodeErrorCorrection;
/**
* Sets an optional image overlay to display over the QR Code.
*
* > **Note** Always test if the code scans correctly with the overlay. If needed, increase the `errorCorrection` level to `"M"` or `"H"`.
*/
overlay?: QRCodeOverlay;
/**
* Sets the padding for the QR Code in pixels.
*
* @default 0
*/
padding?: number;
/**
* Sets the rendering mode for the QR Code.
*
* @default "svg"
* ```
*/
renderAs?: RenderMode;
/**
* Sets the size of the QR Code. Numeric values are in pixels.
*
* If no size is specified, the size will be determined from the element width and height.
* If the element has width or height of zero, a default value of 200 pixels will be used.
*
* @default "200px"
*/
size?: number | string;
/**
* Sets the value to encode in the QR Code.
*/
value: number | string;
/**
* Limits how often the QR Code resizes automatically. Sets the maximum redraws per second when the container size changes.
* Set to `0` to disable automatic resizing.
*
* @default 10
*/
resizeRateLimit: number;
protected get options(): QRCodeOptions;
constructor(element: ElementRef, renderer: Renderer2, ngZone: NgZone);
protected createInstance(element: any, options: any): QRCode;
protected onError(error: Error): void;
static ɵfac: i0.ɵɵFactoryDeclaration<QRCodeComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<QRCodeComponent, "kendo-qrcode", ["kendoQRCode"], { "background": { "alias": "background"; "required": false; }; "border": { "alias": "border"; "required": false; }; "color": { "alias": "color"; "required": false; }; "encoding": { "alias": "encoding"; "required": false; }; "errorCorrection": { "alias": "errorCorrection"; "required": false; }; "overlay": { "alias": "overlay"; "required": false; }; "padding": { "alias": "padding"; "required": false; }; "renderAs": { "alias": "renderAs"; "required": false; }; "size": { "alias": "size"; "required": false; }; "value": { "alias": "value"; "required": false; }; "resizeRateLimit": { "alias": "resizeRateLimit"; "required": false; }; }, {}, never, never, true, never>;
}