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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-angular-barcodes",
3
- "version": "19.1.2-develop.2",
3
+ "version": "19.1.2-develop.3",
4
4
  "description": "Kendo UI Angular Barcodes",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "author": "Progress",
@@ -19,7 +19,7 @@
19
19
  "package": {
20
20
  "productName": "Kendo UI for Angular",
21
21
  "productCode": "KENDOUIANGULAR",
22
- "publishDate": 1749820734,
22
+ "publishDate": 1750152804,
23
23
  "licensingDocsUrl": "https://www.telerik.com/kendo-angular-ui/my-license/"
24
24
  }
25
25
  },
@@ -29,14 +29,14 @@
29
29
  "@angular/core": "16 - 20",
30
30
  "@angular/forms": "16 - 20",
31
31
  "@angular/platform-browser": "16 - 20",
32
- "@progress/kendo-angular-common": "19.1.2-develop.2",
32
+ "@progress/kendo-angular-common": "19.1.2-develop.3",
33
33
  "@progress/kendo-drawing": "^1.21.0",
34
34
  "@progress/kendo-licensing": "^1.5.0",
35
35
  "rxjs": "^6.5.3 || ^7.0.0"
36
36
  },
37
37
  "dependencies": {
38
38
  "tslib": "^2.3.1",
39
- "@progress/kendo-angular-schematics": "19.1.2-develop.2",
39
+ "@progress/kendo-angular-schematics": "19.1.2-develop.3",
40
40
  "@progress/kendo-charts": "2.7.2"
41
41
  },
42
42
  "schematics": "./schematics/collection.json",
@@ -5,10 +5,10 @@
5
5
  import { ValidatorFn } from '@angular/forms';
6
6
  import { QRCodeEncoding } from './chart-types';
7
7
  /**
8
- * Creates a value validator for a particular Barcode type.
8
+ * Creates a value validator for a specific QR Code encoding.
9
9
  *
10
- * @param {QRCodeEncoding} encoding The QR Code encoding. Defaults to 'ISO_8859_1'.
11
- * @returns {ValidatorFn} A validator function that returns an error map with the `qrcode` property if the validation check fails, otherwise `null`.
10
+ * @param {QRCodeEncoding} encoding Sets the QR Code encoding. Defaults to `ISO_8859_1`.
11
+ * @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`.
12
12
  *
13
13
  * @example
14
14
  * ```ts-no-run
@@ -8,13 +8,15 @@ import { BaseComponent } from './base.component';
8
8
  import { Border, QRCodeEncoding, QRCodeErrorCorrection, QRCodeOverlay, RenderMode } from './chart-types';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * Represents the Kendo UI QR Code component for Angular.
11
+ * Represents the [Kendo UI QR Code component for Angular](slug:overview_qrcode_barcodes).
12
+ *
13
+ * Shows a QR Code for the provided value.
12
14
  *
13
15
  * @example
14
16
  * ```ts
15
17
  * import { Component } from '@angular/core';
16
18
  *
17
- * _@Component({
19
+ * @Component({
18
20
  * selector: 'my-app',
19
21
  * template: `
20
22
  * <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui">
@@ -30,257 +32,72 @@ export declare class QRCodeComponent extends BaseComponent {
30
32
  protected renderer: Renderer2;
31
33
  protected ngZone: NgZone;
32
34
  /**
33
- * The background color of the QR Code. Accepts a valid CSS color string, including hex and rgb.
35
+ * Sets the background color of the QR Code. Accepts any valid CSS color string, such as hex or rgb.
34
36
  *
35
37
  * @default "white"
36
- *
37
- * @example
38
- * ```ts-preview
39
- * import { Component } from '@angular/core';
40
- *
41
- * _@Component({
42
- * selector: 'my-app',
43
- * template: `
44
- * <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
45
- * background="#fc0">
46
- * </kendo-qrcode>
47
- * `
48
- * })
49
- * export class AppComponent {
50
- * }
51
- * ```
52
38
  */
53
39
  background?: string;
54
40
  /**
55
- * The border of the QR Code.
56
- *
57
- * @example
58
- * ```ts-preview
59
- * import { Component } from '@angular/core';
60
- * import { Border } from '@progress/kendo-angular-barcodes';
61
- *
62
- * _@Component({
63
- * selector: 'my-app',
64
- * template: `
65
- * <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
66
- * [border]="qrcodeBorder" [padding]="5">
67
- * </kendo-qrcode>
68
- * `
69
- * })
70
- * export class AppComponent {
71
- * qrcodeBorder: Border = {
72
- * color: '#fc0',
73
- * width: 2
74
- * };
75
- * }
76
- * ```
41
+ * Sets the border of the QR Code.
77
42
  */
78
43
  border?: Border;
79
44
  /**
80
- * The color of the QR Code. Accepts a valid CSS color string, including hex and rgb.
45
+ * Sets the color of the QR Code. Accepts any valid CSS color string, such as hex or rgb.
81
46
  *
82
47
  * @default "black"
83
- *
84
- * @example
85
- * ```ts-preview
86
- * _@Component({
87
- * selector: 'my-app',
88
- * template: `
89
- * <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
90
- * color="#fc0">
91
- * </kendo-qrcode>
92
- * `
93
- * })
94
- * export class AppComponent {
95
- * }
96
- * ```
97
48
  */
98
49
  color?: string;
99
50
  /**
100
- * The encoding mode used to encode the value.
101
- *
102
- * > **Important** The UTF-8 encoding is not included in the specifications and is not supported by all readers.
51
+ * Sets the encoding mode for the value.
103
52
  *
104
- * The possible values are:
105
- * * `"ISO_8859_1"`&mdash;Supports all characters from the [ISO/IEC 8859-1](https://en.wikipedia.org/wiki/ISO/IEC_8859-1) character set.
106
- * * `"UTF_8"`&mdash;Supports all [Unicode](https://en.wikipedia.org/wiki/List_of_Unicode_characters) characters.
53
+ * > **Important** The UTF-8 encoding is not part of the specifications and some readers may not support it.
107
54
  *
108
55
  * @default "ISO_8859_1"
109
- *
110
- * @example
111
- * ```ts-preview
112
- * _@Component({
113
- * selector: 'my-app',
114
- * template: `
115
- * <kendo-qrcode value="АБВ" encoding="UTF_8">
116
- * </kendo-qrcode>
117
- * `
118
- * })
119
- * export class AppComponent {
120
- * }
121
- * ```
122
56
  */
123
57
  encoding?: QRCodeEncoding;
124
58
  /**
125
- * The error correction level to use.
126
- *
127
- * The possible values are:
128
- * * `"L"`&mdash;Approximately 7% of the codewords can be restored.
129
- * * `"M"`&mdash;Approximately 15% of the codewords can be restored.
130
- * * `"Q"`&mdash;Approximately 25% of the codewords can be restored.
131
- * * `"H"`&mdash;Approximately 30% of the codewords can be restored.
59
+ * Sets the error correction level.
132
60
  *
133
61
  * @default "L"
134
- *
135
- * @example
136
- * ```ts-preview
137
- * _@Component({
138
- * selector: 'my-app',
139
- * template: `
140
- * <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
141
- * errorCorrection="Q">
142
- * </kendo-qrcode>
143
- * `
144
- * })
145
- * export class AppComponent {
146
- * }
147
- * ```
148
62
  */
149
63
  errorCorrection?: QRCodeErrorCorrection;
150
64
  /**
151
- * An optional image overlay that will placed over the QR Code.
65
+ * Sets an optional image overlay to display over the QR Code.
152
66
  *
153
- * > **Note** Always test if the code reads correctly with the applied overlay.
154
- * > 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"`.
155
- *
156
- * @example
157
- * ```ts-preview
158
- * import { QRCodeOverlay } from '@progress/kendo-angular-barcodes';
159
- *
160
- * _@Component({
161
- * selector: 'my-app',
162
- * template: `
163
- * <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
164
- * [overlay]="qrcodeOverlay">
165
- * </kendo-qrcode>
166
- * `
167
- * })
168
- * export class AppComponent {
169
- * qrcodeOverlay: QRCodeOverlay = {
170
- * type: 'swiss'
171
- * };
172
- * }
173
- * ```
67
+ * > **Note** Always test if the code scans correctly with the overlay. If needed, increase the `errorCorrection` level to `"M"` or `"H"`.
174
68
  */
175
69
  overlay?: QRCodeOverlay;
176
70
  /**
177
- * The padding of the QR Code. The value sets all paddings in pixels.
71
+ * Sets the padding for the QR Code in pixels.
178
72
  *
179
73
  * @default 0
180
- *
181
- * @example
182
- * ```ts-preview
183
- * import { Component } from '@angular/core';
184
- *
185
- * _@Component({
186
- * selector: 'my-app',
187
- * template: `
188
- * <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
189
- * [padding]="10" background="#fc0">
190
- * </kendo-qrcode>
191
- * `
192
- * })
193
- * export class AppComponent {
194
- * }
195
- * ```
196
74
  */
197
75
  padding?: number;
198
76
  /**
199
- * Sets the preferred rendering mode of the QR Code.
200
- *
201
- * The supported values are:
202
- * * `"canvas"`&mdash;Renders the component as a Canvas element.
203
- * * `"svg"`&mdash;Renders the component as an inline SVG document.
77
+ * Sets the rendering mode for the QR Code.
204
78
  *
205
79
  * @default "svg"
206
- *
207
- * @example
208
- * ```ts-preview
209
- * _@Component({
210
- * selector: 'my-app',
211
- * template: `
212
- * <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
213
- * renderAs="canvas">
214
- * </kendo-qrcode>
215
- * `
216
- * })
217
- * export class AppComponent {
218
- * }
219
80
  * ```
220
81
  */
221
82
  renderAs?: RenderMode;
222
83
  /**
223
- * Specifies the size of a QR Code. Numeric values are treated as pixels.
84
+ * Sets the size of the QR Code. Numeric values are in pixels.
224
85
  *
225
86
  * If no size is specified, the size will be determined from the element width and height.
226
87
  * If the element has width or height of zero, a default value of 200 pixels will be used.
227
88
  *
228
89
  * @default "200px"
229
- *
230
- * @example
231
- * ```ts-preview
232
- * _@Component({
233
- * selector: 'my-app',
234
- * template: `
235
- * <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
236
- * [size]="200">
237
- * </kendo-qrcode>
238
- *
239
- * <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
240
- * [style.width.px]="200" [style.height.px]="200">
241
- * </kendo-qrcode>
242
- * `
243
- * })
244
- * export class AppComponent {
245
- * }
246
- * ```
247
90
  */
248
91
  size?: number | string;
249
92
  /**
250
- * The value of the QR Code.
251
- *
252
- * @example
253
- * ```ts-preview
254
- * _@Component({
255
- * selector: 'my-app',
256
- * template: `
257
- * <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui">
258
- * </kendo-qrcode>
259
- * `
260
- * })
261
- * export class AppComponent {
262
- * }
263
- * ```
93
+ * Sets the value to encode in the QR Code.
264
94
  */
265
95
  value: number | string;
266
96
  /**
267
- * Limits the automatic resizing of the QR Code. Sets the maximum number of times per second
268
- * that the component redraws its content when the size of its container changes.
269
- * Defaults to `10`. To disable the automatic resizing, set it to `0`.
97
+ * Limits how often the QR Code resizes automatically. Sets the maximum redraws per second when the container size changes.
98
+ * Set to `0` to disable automatic resizing.
270
99
  *
271
- * @example
272
- * ```ts
273
- * _@Component({
274
- * selector: 'my-app',
275
- * template: `
276
- * <kendo-qrcode value="https://www.telerik.com/kendo-angular-ui"
277
- * [resizeRateLimit]="2">
278
- * </kendo-qrcode>
279
- * `
280
- * })
281
- * export class AppComponent {
282
- * }
283
- * ```
100
+ * @default 10
284
101
  */
285
102
  resizeRateLimit: number;
286
103
  protected get options(): QRCodeOptions;
@@ -5,34 +5,25 @@
5
5
  import * as i0 from "@angular/core";
6
6
  import * as i1 from "./qrcode.component";
7
7
  /**
8
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
9
- * definition for the QR Code component.
8
+ * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the QR Code component.
10
9
  *
11
- * @example
10
+ * Use this module to add QR Code support to your application.
12
11
  *
13
- * ```ts-no-run
14
- * // Import the QR Code module
12
+ * @example
13
+ * ```ts
14
+ * // Import the QRCodeModule
15
15
  * import { QRCodeModule } from '@progress/kendo-angular-barcodes';
16
16
  *
17
- * // The browser platform with a compiler
18
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
19
- *
20
17
  * import { NgModule } from '@angular/core';
21
- *
22
- * // Import the app component
18
+ * import { BrowserModule } from '@angular/platform-browser';
23
19
  * import { AppComponent } from './app.component';
24
20
  *
25
- * // Define the app module
26
- * _@NgModule({
27
- * declarations: [AppComponent], // declare app component
28
- * imports: [BrowserModule, QRCodeModule], // import QRCodeModule module
29
- * bootstrap: [AppComponent]
21
+ * @NgModule({
22
+ * declarations: [AppComponent],
23
+ * imports: [BrowserModule, QRCodeModule],
24
+ * bootstrap: [AppComponent]
30
25
  * })
31
26
  * export class AppModule {}
32
- *
33
- * // Compile and launch the module
34
- * platformBrowserDynamic().bootstrapModule(AppModule);
35
- *
36
27
  * ```
37
28
  */
38
29
  export declare class QRCodeModule {
@@ -9,7 +9,7 @@ function default_1(options) {
9
9
  package: 'barcodes',
10
10
  // Additional dependencies to install (required by npm 6.x)
11
11
  peerDependencies: {
12
- // '@progress/kendo-angular-foo': '19.1.2-develop.2'
12
+ // '@progress/kendo-angular-foo': '19.1.2-develop.3'
13
13
  } });
14
14
  return (0, schematics_1.externalSchematic)('@progress/kendo-angular-schematics', 'ng-add', finalOptions);
15
15
  }