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

package/barcode-validator.d.ts

@@ -6,17 +6,18 @@ import { ValidatorFn } from '@angular/forms';
 import { geometry } from '@progress/kendo-drawing';
 import { BarcodeType } from './chart-types';
 /**
- * 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/barcode.component.d.ts

@@ -8,13 +8,15 @@ import { BaseComponent } from './base.component';
 import { BarcodeText, BarcodeType, Border, Padding, RenderMode } from './chart-types';
 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">
@@ -30,280 +32,72 @@ export declare class BarcodeComponent extends BaseComponent {
     protected renderer: Renderer2;
     protected ngZone: 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?: string;
     /**
-     * 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?: 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?: boolean;
     /**
-     * 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?: string;
     /**
-     * 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?: number;
     /**
-     * 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?: Padding | number;
     /**
-     * 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?: RenderMode;
     /**
-     * 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?: BarcodeText;
     /**
-     * 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: BarcodeType;
     /**
-     * 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: number | string;
     /**
-     * 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?: number;
     /**
-     * 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: number;
     protected get options(): BarcodeOptions;

package/barcode.module.d.ts

@@ -5,34 +5,26 @@
 import * as i0 from "@angular/core";
 import * as i1 from "./barcode.component";
 /**
- * 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 declare class BarcodeModule {

package/barcodes.module.d.ts

@@ -6,34 +6,26 @@ import * as i0 from "@angular/core";
 import * as i1 from "./barcode.component";
 import * as i2 from "./qrcode.component";
 /**
- * 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 declare class BarcodesModule {

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

@@ -4,74 +4,74 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, Margin, Padding, RenderMode } from './field-types';
 /**
- * Supported symbologies (encodings) for the Barcode component.
+ * Lists the supported symbologies (encodings) for the Barcode component.
  */
 export type BarcodeType = 'EAN8' | 'EAN13' | 'UPCE' | 'UPCA' | 'Code11' | 'Code39' | 'Code39Extended' | 'Code93' | 'Code93Extended' | 'Code128' | 'Code128A' | 'Code128B' | 'Code128C' | 'GS1-128' | 'MSImod10' | 'MSImod11' | 'MSImod1010' | 'MSImod1110' | 'POSTNET';
 /**
- * The Barcode text label configuration.
+ * Represents the Barcode text label.
  */
 export interface BarcodeText {
     /**
-     * The color of the text. Any valid CSS color string will work here, including hex and rgb.
+     * Sets the color of the text. Accepts any valid CSS color string, including hex and rgb.
      *
      * @default "black"
      */
     color?: string;
     /**
-     * The font of the text.
+     * Sets the font of the text.
      *
      * @default "16px Consolas, Monaco, Sans Mono, monospace, sans-serif"
      */
     font?: string;
     /**
-     * The margin of the text. A numeric value sets all margins.
+     * Sets the margin of the text. A numeric value sets all margins.
      *
      * @default 0
      */
     margin?: Margin | number;
     /**
-     * A flag indicating that the Barcode text label is visible.
+     * Shows or hides the Barcode text label.
      *
-     * If set to `false`, the Barcode will not display the value as a text below the barcode lines.
+     * If you set this property to `false`, the Barcode does not display the value as text below the barcode lines.
      *
      * @default true
      */
     visible?: boolean;
 }
 /**
- * The Barcode configuration options.
+ * Represents the Barcode options.
  */
 export interface BarcodeOptions {
     /**
-     * The background color of the Barcode. Accepts a valid CSS color string, including hex and rgb.
+     * Sets the background color of the Barcode. Accepts a valid CSS color string, including hex and rgb.
      *
      * @default "white"
      */
     background?: string;
     /**
-     * The border of the Barcode.
+     * Sets the border of the Barcode.
      */
     border?: 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.
      *
      * @default true
      */
     checksum?: boolean;
     /**
-     * The color of the Barcode. Accepts a valid CSS color string, including hex and rgb.
+     * Sets the color of the Barcode. Accepts a valid CSS color string, including hex and rgb.
      *
      * @default "black"
      */
     color?: string;
     /**
-     * The height of the Barcode in pixels.
+     * Sets the height of the Barcode in pixels.
      *
      * @default 100
      */
     height?: number;
     /**
-     * The padding of the Barcode. A numeric value sets all paddings.
+     * Sets the padding of the Barcode. A numeric value sets all paddings.
      *
      * @default 0
      */
@@ -79,29 +79,25 @@ export interface BarcodeOptions {
     /**
      * Sets the preferred rendering mode of the Barcode.
      *
-     * 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;
     /**
-     * The Barcode text label configuration.
+     * Configures the Barcode text label.
      */
     text?: BarcodeText;
     /**
-     * The symbology (encoding) the Barcode will use.
+     * Sets the symbology (encoding) the Barcode uses.
      *
      * @default "Code39"
      */
     type: BarcodeType;
     /**
-     * The value of the Barcode.
+     * Sets the value of the Barcode.
      */
     value: number | string;
     /**
-     * The width of the Barcode in pixels.
+     * Sets the width of the Barcode in pixels.
      *
      * @default 300
      */

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

@@ -3,65 +3,65 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The dash line type.
+ * Lists the dash line types.
  */
 export type DashType = 'dash' | 'dashDot' | 'dot' | 'longDash' | 'longDashDot' | 'longDashDotDot' | 'solid';
 /**
- * The appearance settings for the border lines.
+ * Represents the appearance settings for border lines.
  */
 export interface Border {
     /**
-     * The color of the border line. Accepts a valid CSS color string, including hex and rgb.
+     * Sets the color of the border line. Accepts a valid CSS color string, including hex and rgb.
      */
     color?: string;
     /**
-     * The dash type of the border line.
+     * Sets the dash type of the border line.
      */
     dashType?: DashType;
     /**
-     * The width of the border line in pixels.
+     * Sets the width of the border line in pixels.
      */
     width?: number;
 }
 /**
- * The margin size for each side.
+ * Represents the margin options for each side.
  */
 export interface Margin {
     /**
-     * The top margin in pixels.
+     * Sets the top margin in pixels.
      */
     top?: number;
     /**
-     * The right margin in pixels.
+     * Sets the right margin in pixels.
      */
     right?: number;
     /**
-     * The bottom margin in pixels.
+     * Sets the bottom margin in pixels.
      */
     bottom?: number;
     /**
-     * The left margin in pixels.
+     * Sets the left margin in pixels.
      */
     left?: number;
 }
 /**
- * The padding size for each side.
+ * Represents the padding options for each side.
  */
 export interface Padding {
     /**
-     * The top padding in pixels.
+     * Sets the top padding in pixels.
      */
     top?: number;
     /**
-     * The right padding in pixels.
+     * Sets the right padding in pixels.
      */
     right?: number;
     /**
-     * The bottom padding in pixels.
+     * Sets the bottom padding in pixels.
      */
     bottom?: number;
     /**
-     * The left padding in pixels.
+     * Sets the left padding in pixels.
      */
     left?: number;
 }