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

package/chart-types/qrcode-types.d.ts

@@ -4,11 +4,15 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, Padding, RenderMode } from './field-types';
 /**
- * The QR Code encoding modes.
+ * Lists the QR Code encoding modes.
+ *
+ * The possible values are:
+ * `"ISO_8859_1"`—Supports all characters from the [ISO/IEC 8859-1](https://en.wikipedia.org/wiki/ISO/IEC_8859-1) character set.
+ * `"UTF_8"`—Supports all [Unicode](https://en.wikipedia.org/wiki/List_of_Unicode_characters) characters.
  */
 export type QRCodeEncoding = 'ISO_8859_1' | 'UTF_8';
 /**
- * The QR Code error correction levels.
+ * Lists the QR Code error correction levels.
  *
  * * `"L"`—Approximately 7% of the codewords can be restored.
  * * `"M"`—Approximately 15% of the codewords can be restored.
@@ -17,83 +21,74 @@ export type QRCodeEncoding = 'ISO_8859_1' | 'UTF_8';
  */
 export type QRCodeErrorCorrection = 'L' | 'M' | 'Q' | 'H';
 /**
- * The image overlay configuration of the QR Code.
+ * Provides the image overlay options for the QR Code.
  */
 export interface QRCodeOverlay {
     /**
-     * The overlay height in pixels.
+     * Sets the overlay height in pixels.
      */
     height?: number;
     /**
-     * The source image for the overlay.
+     * Sets the source image for the overlay.
      *
      * Required only when `type` is set to `'image'`.
      */
     imageUrl?: string;
     /**
-     * The overlay type.
+     * Sets the overlay type.
      *
      * @default 'image'
      */
     type?: 'image' | 'swiss';
     /**
-     * The overlay width in pixels.
+     * Sets the overlay width in pixels.
      */
     width?: number;
 }
 /**
- * The QR Code configuration options.
+ * Provides the QR Code options.
+ * ```
  */
 export interface QRCodeOptions {
     /**
-     * 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 a valid CSS color string, including hex and rgb.
      *
      * @default "white"
      */
     background?: string;
     /**
-     * The border of the QR Code.
+     * Sets the border of the QR Code.
      */
     border?: 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 a valid CSS color string, including hex and rgb.
      *
      * @default "black"
      */
     color?: string;
     /**
-     * The encoding mode used to encode the value.
+     * Sets 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.
      *
-     * The possible values are:
-     * * `"ISO_8859_1"`—Supports all characters from the [ISO/IEC 8859-1](https://en.wikipedia.org/wiki/ISO/IEC_8859-1) character set.
-     * * `"UTF_8"`—Supports all [Unicode](https://en.wikipedia.org/wiki/List_of_Unicode_characters) characters.
-     *
      * @default "ISO_8859_1"
      */
     encoding?: QRCodeEncoding;
     /**
-     * The error correction level to use.
-     *
-     * The possible values are:
-     * * `"L"`—Approximately 7% of the codewords can be restored.
-     * * `"M"`—Approximately 15% of the codewords can be restored.
-     * * `"Q"`—Approximately 25% of the codewords can be restored.
-     * * `"H"`—Approximately 30% of the codewords can be restored.
+     * Sets the error correction level to use.
      *
      * @default "L"
      */
     errorCorrection?: QRCodeErrorCorrection;
     /**
-     * An optional image overlay that will placed over the QR Code.
+     * Sets an optional image overlay that is placed 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"`.
      */
     overlay?: QRCodeOverlay;
     /**
-     * The padding of the QR Code. A numeric value sets all paddings.
+     * Sets the padding of the QR Code. A numeric value sets all paddings.
      *
      * @default 0
      */
@@ -101,24 +96,20 @@ export interface QRCodeOptions {
     /**
      * Sets the preferred rendering mode of the QR Code.
      *
-     * The supported values are:
-     * * `"canvas"`—Renders the component as a Canvas element.
-     * * `"svg"`—Renders the component as an inline SVG document.
-     *
      * @default "svg"
      */
     renderAs?: RenderMode;
     /**
-     * Specifies the size of a QR Code. Numeric values are treated as pixels.
+     * Sets the size of a QR Code. Numeric values are treated as 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.
+     * If you do not specify a size, the size is determined from the element width and height.
+     * If the element has width or height of zero, a default value of 200 pixels is used.
      *
      * @default "200px"
      */
     size?: number | string;
     /**
-     * The value of the QR Code.
+     * Sets the value of the QR Code.
      */
     value: number | string;
 }

package/directives.d.ts

@@ -5,14 +5,14 @@
 import { BarcodeComponent } from "./barcode.component";
 import { QRCodeComponent } from "./qrcode.component";
 /**
- * Utility array that contains all `Barcode` related components and directives
+ * Use this utility array to access all Barcode related components and directives in a standalone Angular component.
  */
 export declare const KENDO_BARCODE: readonly [typeof BarcodeComponent];
 /**
- * Utility array that contains all `QRCode` related components and directives
+ * Use this utility array to access all QRCode related components and directives in a standalone Angular component.
  */
 export declare const KENDO_QRCODE: readonly [typeof QRCodeComponent];
 /**
- * Utility array that contains all `@progress/kendo-angular-barcodes` related components and directives
+ * Use this utility array to access all `@progress/kendo-angular-barcodes` related components and directives in a standalone Angular component.
  */
 export declare const KENDO_BARCODES: readonly [typeof BarcodeComponent, typeof QRCodeComponent];

package/esm2022/barcode-validator.mjs

@@ -8,17 +8,18 @@ import { barcodeValidator } from '@progress/kendo-charts';
  */
 const isPresent = (value) => value !== null && value !== undefined;
 /**
- * Creates a value validator for a particular Barcode type.
+ * Creates a validator for a specific Barcode type.
  *
- * @param {BarcodeType} type The type of the Barcode.
- * @param {Size} size The size of the barcode, excluding the text label, padding and border. Optional.
- * @returns {ValidatorFn}  A validator function that returns an error map with the `barcode` property if the validation check fails, otherwise `null`.
+ * Use this function to validate a Barcode value for a given `BarcodeType`.
+ *
+ * @param type Specifies the type of the Barcode.
+ * @param size Specifies the size of the barcode, excluding the text label, padding, and border. This parameter is optional.
+ * @returns Returns a validator function. The function returns an error map with the `barcode` property if validation fails. Otherwise, it returns `null` if valid.
  *
  * @example
- * ```ts-no-run
+ * ```typescript
  * const control = new FormControl('1234', createBarcodeValidator('EAN8'));
  * console.log(control.errors);
- *
  * // {
  * //   barcode: {
  * //     message: 'The value of the "EAN13" encoding should be 12 symbols',

package/esm2022/barcode.component.mjs

@@ -9,13 +9,15 @@ import { packageMetadata } from './package-metadata';
 import { ResizeSensorComponent } from '@progress/kendo-angular-common';
 import * as i0 from "@angular/core";
 /**
- * Represents the Kendo UI Barcode component for Angular.
+ * Represents the [Kendo UI Barcode component for Angular](slug:overview_barcode_barcodes).
+ *
+ * Use this component to display a barcode in your Angular application.
  *
  * @example
- * ```ts
+ * ```typescript
  * import { Component } from '@angular/core';
  *
- * _@Component({
+ * @Component({
  *    selector: 'my-app',
  *    template: `
  *        <kendo-barcode type="EAN8" value="1234567">
@@ -31,280 +33,72 @@ export class BarcodeComponent extends BaseComponent {
     renderer;
     ngZone;
     /**
-     * The background color of the Barcode. Accepts a valid CSS color string, including hex and rgb.
+     * Sets the background color of the Barcode. 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-barcode type="EAN8" value="1234567"
-     *                       background="#fc0">
-     *        </kendo-barcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
      */
     background;
     /**
-     * The border of the Barcode.
-     *
-     * @example
-     * ```ts-preview
-     * import { Component } from '@angular/core';
-     * import { Border } from '@progress/kendo-angular-barcodes';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-barcode type="EAN8" value="1234567"
-     *                       [border]="barcodeBorder" [padding]="5">
-     *        </kendo-barcode>
-     *    `
-     * })
-     * export class AppComponent {
-     *     barcodeBorder: Border = {
-     *         color: '#fc0',
-     *         width: 2
-     *     };
-     * }
-     * ```
+     * Configures the border of the Barcode.
      */
     border;
     /**
-     * If set to `true`, the Barcode will display the checksum digit next to the value in the text area.
+     * Shows the checksum digit next to the value in the text area when set to `true`.
      *
      * @default false
-     *
-     * @example
-     * ```ts-preview
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-barcode type="EAN8" value="1234567"
-     *                       [checksum]="true">
-     *        </kendo-barcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
      */
     checksum;
     /**
-     * The color of the Barcode. Accepts a valid CSS color string, including hex and rgb.
+     * Sets the color of the Barcode. Accepts any valid CSS color string, such as hex or rgb.
      *
      * @default "black"
-     *
-     * @example
-     * ```ts-preview
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-barcode type="EAN8" value="1234567"
-     *                       color="#fc0">
-     *        </kendo-barcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
      */
     color;
     /**
-     * The height of the Barcode in pixels.
-     *
-     * The Barcode dimensions can also be set through regular CSS styling.
-     *
-     * @example
-     * ```ts-preview
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-barcode type="EAN8" value="1234567"
-     *                        [width]="200" [height]="100">
-     *        </kendo-barcode>
+     * Sets the height of the Barcode in pixels.
      *
-     *        <kendo-barcode type="EAN8" value="1234567"
-     *                       [style.width.px]="200" [style.height.px]="100">
-     *        </kendo-barcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
+     * You can also set the Barcode dimensions using CSS.
      */
     height;
     /**
-     * The padding of the Barcode. A numeric value sets all paddings.
+     * Sets the padding of the Barcode. Use a number to set all paddings, or a `Padding` object for the individual sides.
      *
      * @default 0
-     *
-     * @example
-     * ```ts-preview
-     * import { Component } from '@angular/core';
-     * import { Padding } from '@progress/kendo-angular-barcodes';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-barcode type="EAN8" value="1234567"
-     *                       [padding]="5" background="#fc0">
-     *        </kendo-barcode>
-     *
-     *        <kendo-barcode type="EAN8" value="1234567"
-     *                       [padding]="barcodePadding" background="#cf0">
-     *        </kendo-barcode>
-     *    `
-     * })
-     * export class AppComponent {
-     *     barcodePadding: Padding = {
-     *         top: 20,
-     *         bottom: 10,
-     *         left: 5,
-     *         right: 5
-     *     };
-     * }
-     * ```
      */
     padding;
     /**
-     * Sets the preferred rendering mode of the Barcode.
+     * Sets the rendering mode of the Barcode.
      *
-     * The supported values are:
-     * * `"canvas"`&mdash;Renders the component as a Canvas element.
-     * * `"svg"`&mdash;Renders the component as an inline SVG document.
+     * Use `"canvas"` to render as a Canvas element or `"svg"` to render as an inline SVG.
      *
      * @default "svg"
-     *
-     * @example
-     * ```ts-preview
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-barcode type="EAN8" value="1234567"
-     *                       renderAs="canvas">
-     *        </kendo-barcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
      */
     renderAs;
     /**
-     * The Barcode text label configuration.
-     *
-     * @example
-     * ```ts-preview
-     * import { Component } from '@angular/core';
-     * import { BarcodeText } from '@progress/kendo-angular-barcodes';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-barcode type="EAN8" value="1234567"
-     *                       [text]="barcodeText">
-     *        </kendo-barcode>
-     *    `
-     * })
-     * export class AppComponent {
-     *     barcodeText: BarcodeText = {
-     *         color: '#fc0',
-     *         font: '20px monospace'
-     *     };
-     * }
-     * ```
+     * Configures the Barcode text label.
      */
     text;
     /**
-     * The symbology (encoding) the Barcode will use.
+     * Sets the symbology (encoding) for the Barcode.
      *
      * @default "Code39"
-     *
-     * @example
-     * ```ts-preview
-     * import { Component } from '@angular/core';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-barcode type="EAN13" value="123456789987">
-     *        </kendo-barcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
      */
     type;
     /**
-     * The value of the Barcode.
-     *
-     * @example
-     * ```ts-preview
-     * import { Component } from '@angular/core';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-barcode type="EAN13" value="123456789987">
-     *        </kendo-barcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
+     * Sets the value of the Barcode.
      */
     value;
     /**
-     * The width of the Barcode in pixels.
-     *
-     * The Barcode dimensions can also be set through regular CSS styling.
-     *
-     * @example
-     * ```ts-preview
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-barcode type="EAN8" value="1234567"
-     *                        [width]="200" [height]="100">
-     *        </kendo-barcode>
+     * Sets the width of the Barcode in pixels.
      *
-     *        <kendo-barcode type="EAN8" value="1234567"
-     *                       [style.width.px]="200" [style.height.px]="100">
-     *        </kendo-barcode>
-     *    `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
+     * You can also set the Barcode dimensions using CSS.
      */
     width;
     /**
-     * Limits the automatic resizing of the Barcode. 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 Barcode resizes automatically. Sets the maximum number of redraws per second when the container size changes.
+     * Set to `0` to disable automatic resizing.
      *
-     * @example
-     * ```ts
-     * _@Component({
-     *     selector: 'my-app',
-     *     template: `
-     *         <kendo-barcode type="EAN8" [value]="1234567"
-     *                        [resizeRateLimit]="2">
-     *         </kendo-barcode>
-     *   `
-     * })
-     * export class AppComponent {
-     * }
-     * ```
+     * @default 10
      */
     resizeRateLimit = 10;
     get options() {

package/esm2022/barcode.module.mjs

@@ -9,34 +9,26 @@ import * as i0 from "@angular/core";
 import * as i1 from "./barcode.component";
 //IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the Barcode component.
+ * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the Barcode component.
+ *
+ * Use this module to add Barcode support to your application.
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Barcode module
+ * ```ts
+ * // Import the BarcodeModule.
  * import { BarcodeModule } 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, BarcodeModule], // import Barcode module
- *     bootstrap:    [AppComponent]
+ * @NgModule({
+ *     declarations: [AppComponent],
+ *     imports: [BrowserModule, BarcodeModule],
+ *     bootstrap: [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export class BarcodeModule {

package/esm2022/barcodes.module.mjs

@@ -10,34 +10,26 @@ import * as i1 from "./barcode.component";
 import * as i2 from "./qrcode.component";
 //IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the Barcode and QR Code components.
+ * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the Barcode and QR Code components.
+ *
+ * Use this module to add Barcode and QR Code features to your application.
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Barcodes module
+ * ```ts
+ * // Import the Barcodes module.
  * import { BarcodesModule } 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, BarcodesModule], // import Barcodes module
- *     bootstrap:    [AppComponent]
+ * @NgModule({
+ *     declarations: [AppComponent],
+ *     imports: [BrowserModule, BarcodesModule],
+ *     bootstrap: [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export class BarcodesModule {

package/esm2022/directives.mjs

@@ -5,19 +5,19 @@
 import { BarcodeComponent } from "./barcode.component";
 import { QRCodeComponent } from "./qrcode.component";
 /**
- * Utility array that contains all `Barcode` related components and directives
+ * Use this utility array to access all Barcode related components and directives in a standalone Angular component.
  */
 export const KENDO_BARCODE = [
     BarcodeComponent
 ];
 /**
- * Utility array that contains all `QRCode` related components and directives
+ * Use this utility array to access all QRCode related components and directives in a standalone Angular component.
  */
 export const KENDO_QRCODE = [
     QRCodeComponent
 ];
 /**
- * Utility array that contains all `@progress/kendo-angular-barcodes` related components and directives
+ * Use this utility array to access all `@progress/kendo-angular-barcodes` related components and directives in a standalone Angular component.
  */
 export const KENDO_BARCODES = [
     ...KENDO_BARCODE,

package/esm2022/package-metadata.mjs

@@ -10,7 +10,7 @@ export const packageMetadata = {
     productName: 'Kendo UI for Angular',
     productCode: 'KENDOUIANGULAR',
     productCodes: ['KENDOUIANGULAR'],
-    publishDate: 1749820734,
-    version: '19.1.2-develop.2',
+    publishDate: 1750157226,
+    version: '19.1.2-develop.4',
     licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
 };

package/esm2022/qrcode-validator.mjs

@@ -4,10 +4,10 @@
 *-------------------------------------------------------------------------------------------*/
 import { qrcodeValidator } from '@progress/kendo-charts';
 /**
- * Creates a value validator for a particular Barcode type.
+ * Creates a value validator for a specific QR Code encoding.
  *
- * @param {QRCodeEncoding} encoding The QR Code encoding. Defaults to 'ISO_8859_1'.
- * @returns {ValidatorFn}  A validator function that returns an error map with the `qrcode` property if the validation check fails, otherwise `null`.
+ * @param {QRCodeEncoding} encoding Sets the QR Code encoding. Defaults to `ISO_8859_1`.
+ * @returns {ValidatorFn} Returns a validator function. The function returns an error map with the `qrcode` property if the value is invalid. Otherwise, it returns `null`.
  *
  * @example
  * ```ts-no-run