@progress/kendo-angular-barcodes 19.1.2-develop.2 → 19.1.2-develop.4

package/esm2022/qrcode.component.mjs

@@ -12,13 +12,15 @@ const DEFAULT_COLOR = '#000';
 const DEFAULT_BACKGROUND = '#fff';
 const DEFAULT_ERROR_CORRECTION = 'L';
 /**
- * Represents the Kendo UI QR Code component for Angular.
+ * 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({
+ * @Component({
  *    selector: 'my-app',
  *    template: `
  *        <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui">
@@ -34,257 +36,72 @@ export class QRCodeComponent extends BaseComponent {
     renderer;
     ngZone;
     /**
-     * The background color of the QR Code. Accepts a valid CSS color string, including hex and rgb.
+     * Sets the background color of the QR Code. Accepts any valid CSS color string, such as hex or rgb.
      *
      * @default "white"
-     *
-     * @example
-     * ```ts-preview
-     * import { Component } from '@angular/core';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
-     *                      background="#fc0">
-     *        </kendo-qrcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
      */
     background;
     /**
-     * The border of the QR Code.
-     *
-     * @example
-     * ```ts-preview
-     * import { Component } from '@angular/core';
-     * import { Border } from '@progress/kendo-angular-barcodes';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
-     *                      [border]="qrcodeBorder" [padding]="5">
-     *        </kendo-qrcode>
-     *    `
-     * })
-     * export class AppComponent {
-     *     qrcodeBorder: Border = {
-     *         color: '#fc0',
-     *         width: 2
-     *     };
-     * }
-     * ```
+     * Sets the border of the QR Code.
      */
     border;
     /**
-     * The color of the QR Code. Accepts a valid CSS color string, including hex and rgb.
+     * Sets the color of the QR Code. Accepts any valid CSS color string, such as hex or rgb.
      *
      * @default "black"
-     *
-     * @example
-     * ```ts-preview
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
-     *                      color="#fc0">
-     *        </kendo-qrcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
      */
     color;
     /**
-     * The encoding mode used to encode the value.
-     *
-     * > **Important** The UTF-8 encoding is not included in the specifications and is not supported by all readers.
+     * Sets the encoding mode for the value.
      *
-     * The possible values are:
-     * * `"ISO_8859_1"`&mdash;Supports all characters from the [ISO/IEC 8859-1](https://en.wikipedia.org/wiki/ISO/IEC_8859-1) character set.
-     * * `"UTF_8"`&mdash;Supports all [Unicode](https://en.wikipedia.org/wiki/List_of_Unicode_characters) characters.
+     * > **Important** The UTF-8 encoding is not part of the specifications and some readers may not support it.
      *
      * @default "ISO_8859_1"
-     *
-     * @example
-     * ```ts-preview
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-qrcode value="АБВ" encoding="UTF_8">
-     *        </kendo-qrcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
      */
     encoding;
     /**
-     * The error correction level to use.
-     *
-     * The possible values are:
-     * * `"L"`&mdash;Approximately 7% of the codewords can be restored.
-     * * `"M"`&mdash;Approximately 15% of the codewords can be restored.
-     * * `"Q"`&mdash;Approximately 25% of the codewords can be restored.
-     * * `"H"`&mdash;Approximately 30% of the codewords can be restored.
+     * Sets the error correction level.
      *
      * @default "L"
-     *
-     * @example
-     * ```ts-preview
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
-     *                      errorCorrection="Q">
-     *        </kendo-qrcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
      */
     errorCorrection;
     /**
-     * An optional image overlay that will placed over the QR Code.
+     * Sets an optional image overlay to display over the QR Code.
      *
-     * > **Note** Always test if the code reads correctly with the applied overlay.
-     * > Depending on the length of the value and the size of the overlay, you might need to raise the `errorCorrection` level to `"M"` or `"H"`.
-     *
-     * @example
-     * ```ts-preview
-     * import { QRCodeOverlay } from '@progress/kendo-angular-barcodes';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
-     *                      [overlay]="qrcodeOverlay">
-     *        </kendo-qrcode>
-     *    `
-     * })
-     * export class AppComponent {
-     *     qrcodeOverlay: QRCodeOverlay = {
-     *         type: 'swiss'
-     *     };
-     * }
-     * ```
+     * > **Note** Always test if the code scans correctly with the overlay. If needed, increase the `errorCorrection` level to `"M"` or `"H"`.
      */
     overlay;
     /**
-     * The padding of the QR Code. The value sets all paddings in pixels.
+     * Sets the padding for the QR Code in pixels.
      *
      * @default 0
-     *
-     * @example
-     * ```ts-preview
-     * import { Component } from '@angular/core';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
-     *                      [padding]="10" background="#fc0">
-     *        </kendo-qrcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
      */
     padding;
     /**
-     * Sets the preferred rendering mode of the QR Code.
-     *
-     * The supported values are:
-     * * `"canvas"`&mdash;Renders the component as a Canvas element.
-     * * `"svg"`&mdash;Renders the component as an inline SVG document.
+     * Sets the rendering mode for the QR Code.
      *
      * @default "svg"
-     *
-     * @example
-     * ```ts-preview
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
-     *                      renderAs="canvas">
-     *        </kendo-qrcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
      * ```
      */
     renderAs;
     /**
-     * Specifies the size of a QR Code. Numeric values are treated as pixels.
+     * 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"
-     *
-     * @example
-     * ```ts-preview
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
-     *                      [size]="200">
-     *        </kendo-qrcode>
-     *
-     *        <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
-     *                      [style.width.px]="200" [style.height.px]="200">
-     *        </kendo-qrcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
      */
     size;
     /**
-     * The value of the QR Code.
-     *
-     * @example
-     * ```ts-preview
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui">
-     *        </kendo-qrcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
+     * Sets the value to encode in the QR Code.
      */
     value;
     /**
-     * Limits the automatic resizing of the QR Code. Sets the maximum number of times per second
-     * that the component redraws its content when the size of its container changes.
-     * Defaults to `10`. To disable the automatic resizing, set it to `0`.
+     * 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.
      *
-     * @example
-     * ```ts
-     * _@Component({
-     *     selector: 'my-app',
-     *     template: `
-     *         <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
-     *                       [resizeRateLimit]="2">
-     *         </kendo-qrcode>
-     *   `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
+     * @default 10
      */
     resizeRateLimit = 10;
     get options() {

package/esm2022/qrcode.module.mjs

@@ -9,34 +9,25 @@ import * as i0 from "@angular/core";
 import * as i1 from "./qrcode.component";
 //IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the QR Code component.
+ * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the QR Code component.
  *
- * @example
+ * Use this module to add QR Code support to your application.
  *
- * ```ts-no-run
- * // Import the QR Code module
+ * @example
+ * ```ts
+ * // Import the QRCodeModule
  * import { QRCodeModule } from '@progress/kendo-angular-barcodes';
  *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { BrowserModule } from '@angular/platform-browser';
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
- * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, QRCodeModule], // import QRCodeModule module
- *     bootstrap:    [AppComponent]
+ * @NgModule({
+ *     declarations: [AppComponent],
+ *     imports: [BrowserModule, QRCodeModule],
+ *     bootstrap: [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export class QRCodeModule {