@progress/kendo-angular-notification 19.1.1 → 19.1.2-develop.1

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.
Files changed (9) hide show
  1. package/esm2022/models/notification-settings.mjs +13 -3
  2. package/esm2022/package-metadata.mjs +2 -2
  3. package/esm2022/services/notification.service.mjs +17 -24
  4. package/fesm2022/progress-kendo-angular-notification.mjs +32 -29
  5. package/models/animation.d.ts +2 -2
  6. package/models/notification-ref.d.ts +2 -2
  7. package/models/notification-settings.d.ts +13 -3
  8. package/package.json +6 -6
  9. package/services/notification.service.d.ts +17 -24
package/esm2022/models/notification-settings.mjs CHANGED
@@ -11,7 +11,8 @@ export class NotificationSettings {
11
11
  * Specifies the time in milliseconds after which the
12
12
  * Notification will hide
13
13
  * ([see example](slug:hiding_notifications#toc-defining-a-delay-before-hiding)).
14
- * Defaults to `5000`.
14
+ *
15
+ * @default 5000
15
16
  */
16
17
  hideAfter = 5000;
17
18
  /**
@@ -21,6 +22,8 @@ export class NotificationSettings {
21
22
  * The possible values are:
22
23
  * * `horizontal: 'left'|'center'|'right'`
23
24
  * * `vertical: 'top'|'bottom'`
25
+ *
26
+ * @default { horizontal: 'right', vertical: 'top' }
24
27
  */
25
28
  position = { horizontal: 'right', vertical: 'top' };
26
29
  /**
@@ -30,16 +33,20 @@ export class NotificationSettings {
30
33
  * The possible values are:
31
34
  * * `duration`—Accepts a number in milliseconds. Defaults to `500ms`.
32
35
  * * `type?: 'slide'| (Default) 'fade'`
36
+ *
37
+ * @default { type: 'fade', duration: 500 }
33
38
  */
34
39
  animation = { type: 'fade', duration: 500 };
35
40
  /**
36
41
  * Specifies if the Notification will require a user action to hide.
37
- * If the property is set to `true`, the Notification renders a **Close** button
42
+ * If you set the property to `true`, the Notification renders a **Close** button
38
43
  * ([see example]({% slug hiding_notifications %}#toc-defining-a-closable-notification)).
39
44
  *
40
45
  * The possible values are:
41
46
  * * (Default) `false`
42
47
  * * `true`
48
+ *
49
+ * @default false
43
50
  */
44
51
  closable = false;
45
52
  /**
@@ -53,6 +60,8 @@ export class NotificationSettings {
53
60
  * The possible values are:
54
61
  * * `style: (Default) 'none'|'success'|'error'|'warning'|'info'`
55
62
  * * `icon: 'true'|'false'`
63
+ *
64
+ * @default { style: 'none', icon: true }
56
65
  */
57
66
  type = { style: 'none', icon: true };
58
67
  /**
@@ -65,11 +74,12 @@ export class NotificationSettings {
65
74
  height;
66
75
  /**
67
76
  * The value of the Notification element `aria-label` attribute.
77
+ *
68
78
  * @default 'Notification'
69
79
  */
70
80
  notificationLabel = 'Notification';
71
81
  /**
72
- * Specifies a list of CSS classes that will be added to the Notification.
82
+ * Specifies a list of CSS classes that you add to the Notification.
73
83
  * To apply CSS rules to the component, set `encapsulation` to `ViewEncapsulation.None`
74
84
  * ([see example](slug:overview_notification)).
75
85
  *
package/esm2022/package-metadata.mjs CHANGED
@@ -10,7 +10,7 @@ export const packageMetadata = {
10
10
  productName: 'Kendo UI for Angular',
11
11
  productCode: 'KENDOUIANGULAR',
12
12
  productCodes: ['KENDOUIANGULAR'],
13
- publishDate: 1749540399,
14
- version: '19.1.1',
13
+ publishDate: 1749804487,
14
+ version: '19.1.2-develop.1',
15
15
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
16
16
  };
package/esm2022/services/notification.service.mjs CHANGED
@@ -6,41 +6,34 @@ import { Injectable, ComponentFactoryResolver, ApplicationRef, Injector, Injecti
6
6
  import { NotificationContainerComponent } from '../notification.container.component';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Used to inject the Notification container. If not provided, the first root component of
10
- * the application is used.
9
+ * Injects the Notification container. When not provided, uses the first root component of
10
+ * the application.
11
11
  *
12
- * > The `NOTIFICATION_CONTAINER` can be used only with the [`NotificationService`]({% slug api_notification_notificationservice %}) class.
12
+ * > Use `NOTIFICATION_CONTAINER` only with the [`NotificationService`]({% slug api_notification_notificationservice %}) class.
13
13
  *
14
14
  * @example
15
15
  *
16
- * ```ts-no-run
17
- * // Import the Notification module
18
- * import { NotificationModule, NOTIFICATION_CONTAINER } from '@progress/kendo-angular-notification';
19
- *
20
- * // The browser platform with a compiler
16
+ * ```ts
17
+ * import { NgModule, ElementRef } from '@angular/core';
18
+ * import { BrowserModule } from '@angular/platform-browser';
21
19
  * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
22
20
  *
23
- * import { ElementRef, NgModule } from '@angular/core';
24
- *
25
- * // Import the app component
21
+ * import { NotificationModule, NOTIFICATION_CONTAINER } from '@progress/kendo-angular-notification';
26
22
  * import { AppComponent } from './app.component';
27
23
  *
28
- * // Define the app module
29
- * _@NgModule({
30
- * declarations: [AppComponent], // declare app component
31
- * imports: [BrowserModule, NotificationModule], // import Notification module
32
- * bootstrap: [AppComponent],
33
- * providers: [{
24
+ * @NgModule({
25
+ * declarations: [AppComponent],
26
+ * imports: [BrowserModule, NotificationModule],
27
+ * bootstrap: [AppComponent],
28
+ * providers: [
29
+ * {
34
30
  * provide: NOTIFICATION_CONTAINER,
35
- * useFactory: () => {
36
- * //return the container ElementRef, where the notification will be injected
37
- * return { nativeElement: document.body } as ElementRef;
38
- * }
39
- * }]
31
+ * useFactory: () => ({ nativeElement: document.body } as ElementRef)
32
+ * }
33
+ * ]
40
34
  * })
41
35
  * export class AppModule {}
42
36
  *
43
- * // Compile and launch the module
44
37
  * platformBrowserDynamic().bootstrapModule(AppModule);
45
38
  * ```
46
39
  */
@@ -68,7 +61,7 @@ export class NotificationService {
68
61
  this.container = container;
69
62
  }
70
63
  /**
71
- * Opens a Notification component. Created Notification are mounted
64
+ * Opens a Notification component. Created Notifications are mounted
72
65
  * in the DOM directly in the root application component.
73
66
  *
74
67
  * @param {NotificationSettings} settings - The settings which define the Notification.
package/fesm2022/progress-kendo-angular-notification.mjs CHANGED
@@ -24,7 +24,8 @@ class NotificationSettings {
24
24
  * Specifies the time in milliseconds after which the
25
25
  * Notification will hide
26
26
  * ([see example](slug:hiding_notifications#toc-defining-a-delay-before-hiding)).
27
- * Defaults to `5000`.
27
+ *
28
+ * @default 5000
28
29
  */
29
30
  hideAfter = 5000;
30
31
  /**
@@ -34,6 +35,8 @@ class NotificationSettings {
34
35
  * The possible values are:
35
36
  * * `horizontal: 'left'|'center'|'right'`
36
37
  * * `vertical: 'top'|'bottom'`
38
+ *
39
+ * @default { horizontal: 'right', vertical: 'top' }
37
40
  */
38
41
  position = { horizontal: 'right', vertical: 'top' };
39
42
  /**
@@ -43,16 +46,20 @@ class NotificationSettings {
43
46
  * The possible values are:
44
47
  * * `duration`—Accepts a number in milliseconds. Defaults to `500ms`.
45
48
  * * `type?: 'slide'| (Default) 'fade'`
49
+ *
50
+ * @default { type: 'fade', duration: 500 }
46
51
  */
47
52
  animation = { type: 'fade', duration: 500 };
48
53
  /**
49
54
  * Specifies if the Notification will require a user action to hide.
50
- * If the property is set to `true`, the Notification renders a **Close** button
55
+ * If you set the property to `true`, the Notification renders a **Close** button
51
56
  * ([see example]({% slug hiding_notifications %}#toc-defining-a-closable-notification)).
52
57
  *
53
58
  * The possible values are:
54
59
  * * (Default) `false`
55
60
  * * `true`
61
+ *
62
+ * @default false
56
63
  */
57
64
  closable = false;
58
65
  /**
@@ -66,6 +73,8 @@ class NotificationSettings {
66
73
  * The possible values are:
67
74
  * * `style: (Default) 'none'|'success'|'error'|'warning'|'info'`
68
75
  * * `icon: 'true'|'false'`
76
+ *
77
+ * @default { style: 'none', icon: true }
69
78
  */
70
79
  type = { style: 'none', icon: true };
71
80
  /**
@@ -78,11 +87,12 @@ class NotificationSettings {
78
87
  height;
79
88
  /**
80
89
  * The value of the Notification element `aria-label` attribute.
90
+ *
81
91
  * @default 'Notification'
82
92
  */
83
93
  notificationLabel = 'Notification';
84
94
  /**
85
- * Specifies a list of CSS classes that will be added to the Notification.
95
+ * Specifies a list of CSS classes that you add to the Notification.
86
96
  * To apply CSS rules to the component, set `encapsulation` to `ViewEncapsulation.None`
87
97
  * ([see example](slug:overview_notification)).
88
98
  *
@@ -107,8 +117,8 @@ const packageMetadata = {
107
117
  productName: 'Kendo UI for Angular',
108
118
  productCode: 'KENDOUIANGULAR',
109
119
  productCodes: ['KENDOUIANGULAR'],
110
- publishDate: 1749540399,
111
- version: '19.1.1',
120
+ publishDate: 1749804487,
121
+ version: '19.1.2-develop.1',
112
122
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
113
123
  };
114
124
 
@@ -645,41 +655,34 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
645
655
  }] } });
646
656
 
647
657
  /**
648
- * Used to inject the Notification container. If not provided, the first root component of
649
- * the application is used.
658
+ * Injects the Notification container. When not provided, uses the first root component of
659
+ * the application.
650
660
  *
651
- * > The `NOTIFICATION_CONTAINER` can be used only with the [`NotificationService`]({% slug api_notification_notificationservice %}) class.
661
+ * > Use `NOTIFICATION_CONTAINER` only with the [`NotificationService`]({% slug api_notification_notificationservice %}) class.
652
662
  *
653
663
  * @example
654
664
  *
655
- * ```ts-no-run
656
- * // Import the Notification module
657
- * import { NotificationModule, NOTIFICATION_CONTAINER } from '@progress/kendo-angular-notification';
658
- *
659
- * // The browser platform with a compiler
665
+ * ```ts
666
+ * import { NgModule, ElementRef } from '@angular/core';
667
+ * import { BrowserModule } from '@angular/platform-browser';
660
668
  * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
661
669
  *
662
- * import { ElementRef, NgModule } from '@angular/core';
663
- *
664
- * // Import the app component
670
+ * import { NotificationModule, NOTIFICATION_CONTAINER } from '@progress/kendo-angular-notification';
665
671
  * import { AppComponent } from './app.component';
666
672
  *
667
- * // Define the app module
668
- * _@NgModule({
669
- * declarations: [AppComponent], // declare app component
670
- * imports: [BrowserModule, NotificationModule], // import Notification module
671
- * bootstrap: [AppComponent],
672
- * providers: [{
673
+ * @NgModule({
674
+ * declarations: [AppComponent],
675
+ * imports: [BrowserModule, NotificationModule],
676
+ * bootstrap: [AppComponent],
677
+ * providers: [
678
+ * {
673
679
  * provide: NOTIFICATION_CONTAINER,
674
- * useFactory: () => {
675
- * //return the container ElementRef, where the notification will be injected
676
- * return { nativeElement: document.body } as ElementRef;
677
- * }
678
- * }]
680
+ * useFactory: () => ({ nativeElement: document.body } as ElementRef)
681
+ * }
682
+ * ]
679
683
  * })
680
684
  * export class AppModule {}
681
685
  *
682
- * // Compile and launch the module
683
686
  * platformBrowserDynamic().bootstrapModule(AppModule);
684
687
  * ```
685
688
  */
@@ -707,7 +710,7 @@ class NotificationService {
707
710
  this.container = container;
708
711
  }
709
712
  /**
710
- * Opens a Notification component. Created Notification are mounted
713
+ * Opens a Notification component. Created Notifications are mounted
711
714
  * in the DOM directly in the root application component.
712
715
  *
713
716
  * @param {NotificationSettings} settings - The settings which define the Notification.
package/models/animation.d.ts CHANGED
@@ -7,8 +7,8 @@
7
7
  * ([see example]({% slug animations_notification %})).
8
8
  *
9
9
  * The possible values are:
10
- * `duration`—Accepts a number in milliseconds (default: 500ms).
11
- * `type?: 'slide'|'fade' (default)`
10
+ * * `duration`—Accepts a number in milliseconds (default: 500ms).
11
+ * * `type?: 'slide'|'fade' (default)`
12
12
  */
13
13
  export type Animation = {
14
14
  duration: number;
package/models/notification-ref.d.ts CHANGED
@@ -7,7 +7,7 @@ import { NotificationComponent } from '../index';
7
7
  import { Observable } from 'rxjs';
8
8
  /**
9
9
  * Holds references to the object instance of the Notification.
10
- * Controls the Notifications which are opened through `NotificationService`.
10
+ * Controls the Notifications which you open through `NotificationService`.
11
11
  * For an example on sample usage, refer to the
12
12
  * [`NotificationService.show`]({% slug api_notification_notificationservice %}#toc-show) method.
13
13
  */
@@ -22,7 +22,7 @@ export interface NotificationRef {
22
22
  notification?: ComponentRef<NotificationComponent>;
23
23
  /**
24
24
  * A reference to the child component of the Notification.
25
- * Available when the Notification is shown with
25
+ * Available when you show the Notification with
26
26
  * [`content`]({% slug content_notification %}#toc-rendering-a-component).
27
27
  */
28
28
  content?: ComponentRef<any>;
package/models/notification-settings.d.ts CHANGED
@@ -15,7 +15,8 @@ export declare class NotificationSettings {
15
15
  * Specifies the time in milliseconds after which the
16
16
  * Notification will hide
17
17
  * ([see example](slug:hiding_notifications#toc-defining-a-delay-before-hiding)).
18
- * Defaults to `5000`.
18
+ *
19
+ * @default 5000
19
20
  */
20
21
  hideAfter?: number;
21
22
  /**
@@ -25,6 +26,8 @@ export declare class NotificationSettings {
25
26
  * The possible values are:
26
27
  * * `horizontal: 'left'|'center'|'right'`
27
28
  * * `vertical: 'top'|'bottom'`
29
+ *
30
+ * @default { horizontal: 'right', vertical: 'top' }
28
31
  */
29
32
  position?: Position;
30
33
  /**
@@ -34,16 +37,20 @@ export declare class NotificationSettings {
34
37
  * The possible values are:
35
38
  * * `duration`&mdash;Accepts a number in milliseconds. Defaults to `500ms`.
36
39
  * * `type?: 'slide'| (Default) 'fade'`
40
+ *
41
+ * @default { type: 'fade', duration: 500 }
37
42
  */
38
43
  animation?: Animation;
39
44
  /**
40
45
  * Specifies if the Notification will require a user action to hide.
41
- * If the property is set to `true`, the Notification renders a **Close** button
46
+ * If you set the property to `true`, the Notification renders a **Close** button
42
47
  * ([see example]({% slug hiding_notifications %}#toc-defining-a-closable-notification)).
43
48
  *
44
49
  * The possible values are:
45
50
  * * (Default) `false`
46
51
  * * `true`
52
+ *
53
+ * @default false
47
54
  */
48
55
  closable?: boolean;
49
56
  /**
@@ -57,6 +64,8 @@ export declare class NotificationSettings {
57
64
  * The possible values are:
58
65
  * * `style: (Default) 'none'|'success'|'error'|'warning'|'info'`
59
66
  * * `icon: 'true'|'false'`
67
+ *
68
+ * @default { style: 'none', icon: true }
60
69
  */
61
70
  type?: Type;
62
71
  /**
@@ -69,11 +78,12 @@ export declare class NotificationSettings {
69
78
  height?: number;
70
79
  /**
71
80
  * The value of the Notification element `aria-label` attribute.
81
+ *
72
82
  * @default 'Notification'
73
83
  */
74
84
  notificationLabel?: string;
75
85
  /**
76
- * Specifies a list of CSS classes that will be added to the Notification.
86
+ * Specifies a list of CSS classes that you add to the Notification.
77
87
  * To apply CSS rules to the component, set `encapsulation` to `ViewEncapsulation.None`
78
88
  * ([see example](slug:overview_notification)).
79
89
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-angular-notification",
3
- "version": "19.1.1",
3
+ "version": "19.1.2-develop.1",
4
4
  "description": "Kendo UI Notification for Angular",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "author": "Progress",
@@ -17,7 +17,7 @@
17
17
  "package": {
18
18
  "productName": "Kendo UI for Angular",
19
19
  "productCode": "KENDOUIANGULAR",
20
- "publishDate": 1749540399,
20
+ "publishDate": 1749804487,
21
21
  "licensingDocsUrl": "https://www.telerik.com/kendo-angular-ui/my-license/"
22
22
  }
23
23
  },
@@ -27,14 +27,14 @@
27
27
  "@angular/core": "16 - 20",
28
28
  "@angular/platform-browser": "16 - 20",
29
29
  "@progress/kendo-licensing": "^1.5.0",
30
- "@progress/kendo-angular-common": "19.1.1",
31
- "@progress/kendo-angular-l10n": "19.1.1",
32
- "@progress/kendo-angular-icons": "19.1.1",
30
+ "@progress/kendo-angular-common": "19.1.2-develop.1",
31
+ "@progress/kendo-angular-l10n": "19.1.2-develop.1",
32
+ "@progress/kendo-angular-icons": "19.1.2-develop.1",
33
33
  "rxjs": "^6.5.3 || ^7.0.0"
34
34
  },
35
35
  "dependencies": {
36
36
  "tslib": "^2.3.1",
37
- "@progress/kendo-angular-schematics": "19.1.1"
37
+ "@progress/kendo-angular-schematics": "19.1.2-develop.1"
38
38
  },
39
39
  "schematics": "./schematics/collection.json",
40
40
  "module": "fesm2022/progress-kendo-angular-notification.mjs",
package/services/notification.service.d.ts CHANGED
@@ -7,41 +7,34 @@ import { NotificationSettings } from '../models/notification-settings';
7
7
  import { NotificationRef } from '../models/notification-ref';
8
8
  import * as i0 from "@angular/core";
9
9
  /**
10
- * Used to inject the Notification container. If not provided, the first root component of
11
- * the application is used.
10
+ * Injects the Notification container. When not provided, uses the first root component of
11
+ * the application.
12
12
  *
13
- * > The `NOTIFICATION_CONTAINER` can be used only with the [`NotificationService`]({% slug api_notification_notificationservice %}) class.
13
+ * > Use `NOTIFICATION_CONTAINER` only with the [`NotificationService`]({% slug api_notification_notificationservice %}) class.
14
14
  *
15
15
  * @example
16
16
  *
17
- * ```ts-no-run
18
- * // Import the Notification module
19
- * import { NotificationModule, NOTIFICATION_CONTAINER } from '@progress/kendo-angular-notification';
20
- *
21
- * // The browser platform with a compiler
17
+ * ```ts
18
+ * import { NgModule, ElementRef } from '@angular/core';
19
+ * import { BrowserModule } from '@angular/platform-browser';
22
20
  * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
23
21
  *
24
- * import { ElementRef, NgModule } from '@angular/core';
25
- *
26
- * // Import the app component
22
+ * import { NotificationModule, NOTIFICATION_CONTAINER } from '@progress/kendo-angular-notification';
27
23
  * import { AppComponent } from './app.component';
28
24
  *
29
- * // Define the app module
30
- * _@NgModule({
31
- * declarations: [AppComponent], // declare app component
32
- * imports: [BrowserModule, NotificationModule], // import Notification module
33
- * bootstrap: [AppComponent],
34
- * providers: [{
25
+ * @NgModule({
26
+ * declarations: [AppComponent],
27
+ * imports: [BrowserModule, NotificationModule],
28
+ * bootstrap: [AppComponent],
29
+ * providers: [
30
+ * {
35
31
  * provide: NOTIFICATION_CONTAINER,
36
- * useFactory: () => {
37
- * //return the container ElementRef, where the notification will be injected
38
- * return { nativeElement: document.body } as ElementRef;
39
- * }
40
- * }]
32
+ * useFactory: () => ({ nativeElement: document.body } as ElementRef)
33
+ * }
34
+ * ]
41
35
  * })
42
36
  * export class AppModule {}
43
37
  *
44
- * // Compile and launch the module
45
38
  * platformBrowserDynamic().bootstrapModule(AppModule);
46
39
  * ```
47
40
  */
@@ -65,7 +58,7 @@ export declare class NotificationService {
65
58
  */
66
59
  constructor(resolver: ComponentFactoryResolver, injector: Injector, container: ElementRef);
67
60
  /**
68
- * Opens a Notification component. Created Notification are mounted
61
+ * Opens a Notification component. Created Notifications are mounted
69
62
  * in the DOM directly in the root application component.
70
63
  *
71
64
  * @param {NotificationSettings} settings - The settings which define the Notification.