@genesislcap/foundation-notifications 14.114.2 → 14.115.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.
- package/README.md +83 -11
- package/dist/dts/alert/alert-builder.d.ts +7 -0
- package/dist/dts/alert/alert-builder.d.ts.map +1 -0
- package/dist/dts/alert/index.d.ts +2 -0
- package/dist/dts/alert/index.d.ts.map +1 -0
- package/dist/dts/banner/banner-builder-old.d.ts +40 -0
- package/dist/dts/banner/banner-builder-old.d.ts.map +1 -0
- package/dist/dts/banner/banner-builder.d.ts +3 -31
- package/dist/dts/banner/banner-builder.d.ts.map +1 -1
- package/dist/dts/banner/banner-launcher.d.ts.map +1 -1
- package/dist/dts/banner/index.d.ts +1 -0
- package/dist/dts/banner/index.d.ts.map +1 -1
- package/dist/dts/dialog/dialog-builder-old.d.ts +40 -0
- package/dist/dts/dialog/dialog-builder-old.d.ts.map +1 -0
- package/dist/dts/dialog/dialog-builder.d.ts +3 -31
- package/dist/dts/dialog/dialog-builder.d.ts.map +1 -1
- package/dist/dts/dialog/dialog-launcher.d.ts +1 -1
- package/dist/dts/dialog/dialog-launcher.d.ts.map +1 -1
- package/dist/dts/dialog/index.d.ts +1 -0
- package/dist/dts/dialog/index.d.ts.map +1 -1
- package/dist/dts/index.d.ts +5 -4
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/notification-builder.d.ts +12 -0
- package/dist/dts/notification-builder.d.ts.map +1 -1
- package/dist/dts/notification-launcher.d.ts.map +1 -1
- package/dist/dts/notification-util.d.ts +6 -0
- package/dist/dts/notification-util.d.ts.map +1 -1
- package/dist/dts/snackbar/index.d.ts +1 -0
- package/dist/dts/snackbar/index.d.ts.map +1 -1
- package/dist/dts/snackbar/snackbar-builder-old.d.ts +39 -0
- package/dist/dts/snackbar/snackbar-builder-old.d.ts.map +1 -0
- package/dist/dts/snackbar/snackbar-builder.d.ts +3 -30
- package/dist/dts/snackbar/snackbar-builder.d.ts.map +1 -1
- package/dist/dts/snackbar/snackbar-launcher.d.ts +1 -1
- package/dist/dts/snackbar/snackbar-launcher.d.ts.map +1 -1
- package/dist/dts/toast/index.d.ts +1 -0
- package/dist/dts/toast/index.d.ts.map +1 -1
- package/dist/dts/toast/toast-builder-old.d.ts +74 -0
- package/dist/dts/toast/toast-builder-old.d.ts.map +1 -0
- package/dist/dts/toast/toast-builder.d.ts +3 -61
- package/dist/dts/toast/toast-builder.d.ts.map +1 -1
- package/dist/dts/toast/toast-launcher.d.ts.map +1 -1
- package/dist/dts/types.d.ts +50 -2
- package/dist/dts/types.d.ts.map +1 -1
- package/dist/esm/alert/alert-builder.js +9 -0
- package/dist/esm/alert/index.js +1 -0
- package/dist/esm/banner/banner-builder-old.js +56 -0
- package/dist/esm/banner/banner-builder.js +17 -43
- package/dist/esm/banner/banner-launcher.js +2 -1
- package/dist/esm/banner/index.js +1 -0
- package/dist/esm/dialog/dialog-builder-old.js +56 -0
- package/dist/esm/dialog/dialog-builder.js +21 -43
- package/dist/esm/dialog/dialog-launcher.js +4 -3
- package/dist/esm/dialog/index.js +1 -0
- package/dist/esm/index.js +5 -4
- package/dist/esm/notification-builder.js +14 -0
- package/dist/esm/notification-launcher.js +2 -10
- package/dist/esm/notification-util.js +12 -0
- package/dist/esm/snackbar/index.js +1 -0
- package/dist/esm/snackbar/snackbar-builder-old.js +55 -0
- package/dist/esm/snackbar/snackbar-builder.js +17 -42
- package/dist/esm/snackbar/snackbar-launcher.js +4 -3
- package/dist/esm/toast/index.js +1 -0
- package/dist/esm/toast/toast-builder-old.js +107 -0
- package/dist/esm/toast/toast-builder.js +22 -88
- package/dist/esm/toast/toast-launcher.js +2 -1
- package/dist/foundation-notifications.api.json +911 -88
- package/dist/foundation-notifications.d.ts +130 -4
- package/docs/api/foundation-notifications.alertstructure.body.md +11 -0
- package/docs/api/foundation-notifications.alertstructure.loglevel.md +11 -0
- package/docs/api/foundation-notifications.alertstructure.md +22 -0
- package/docs/api/foundation-notifications.alertstructure.title.md +11 -0
- package/docs/api/foundation-notifications.bannerbuilder.build.md +5 -0
- package/docs/api/foundation-notifications.bannerbuilder.md +5 -0
- package/docs/api/foundation-notifications.bannerbuilder.withconfirmingaction.md +5 -0
- package/docs/api/foundation-notifications.bannerbuilder.withdismissingaction.md +5 -0
- package/docs/api/foundation-notifications.bannerstructure.banner.md +11 -0
- package/docs/api/foundation-notifications.bannerstructure.body.md +11 -0
- package/docs/api/foundation-notifications.bannerstructure.loglevel.md +11 -0
- package/docs/api/foundation-notifications.bannerstructure.md +22 -0
- package/docs/api/foundation-notifications.dialogbuilder.build.md +5 -0
- package/docs/api/foundation-notifications.dialogbuilder.md +5 -0
- package/docs/api/foundation-notifications.dialogbuilder.withconfirmingaction.md +5 -0
- package/docs/api/foundation-notifications.dialogbuilder.withdismissingaction.md +5 -0
- package/docs/api/foundation-notifications.dialogstructure.body.md +11 -0
- package/docs/api/foundation-notifications.dialogstructure.dialog.md +11 -0
- package/docs/api/foundation-notifications.dialogstructure.loglevel.md +11 -0
- package/docs/api/foundation-notifications.dialogstructure.md +23 -0
- package/docs/api/foundation-notifications.dialogstructure.title.md +11 -0
- package/docs/api/foundation-notifications.getbannerbuilder.md +5 -0
- package/docs/api/foundation-notifications.getdialogbuilder.md +5 -0
- package/docs/api/foundation-notifications.getnotificationbuilder.md +5 -0
- package/docs/api/foundation-notifications.getsnackbarbuilder.md +5 -0
- package/docs/api/foundation-notifications.gettoastbuilder.md +5 -0
- package/docs/api/foundation-notifications.md +12 -1
- package/docs/api/foundation-notifications.notificationbuilder.build.md +5 -0
- package/docs/api/foundation-notifications.notificationbuilder.md +5 -0
- package/docs/api/foundation-notifications.notificationbuilder.withalert.md +5 -0
- package/docs/api/foundation-notifications.notificationbuilder.withbanner.md +5 -0
- package/docs/api/foundation-notifications.notificationbuilder.withbody.md +5 -0
- package/docs/api/foundation-notifications.notificationbuilder.withcreatedat.md +5 -0
- package/docs/api/foundation-notifications.notificationbuilder.withdialog.md +5 -0
- package/docs/api/foundation-notifications.notificationbuilder.withloglevel.md +5 -0
- package/docs/api/foundation-notifications.notificationbuilder.withsnackbar.md +5 -0
- package/docs/api/foundation-notifications.notificationbuilder.withtitle.md +5 -0
- package/docs/api/foundation-notifications.notificationbuilder.withtoast.md +5 -0
- package/docs/api/foundation-notifications.notificationstructure.md +2 -2
- package/docs/api/foundation-notifications.notificationstructure.title.md +1 -1
- package/docs/api/foundation-notifications.showloggerloglevel.md +13 -0
- package/docs/api/foundation-notifications.shownotificationalert.md +13 -0
- package/docs/api/foundation-notifications.shownotificationbanner.md +13 -0
- package/docs/api/foundation-notifications.shownotificationdialog.md +13 -0
- package/docs/api/foundation-notifications.shownotificationsnackbar.md +13 -0
- package/docs/api/foundation-notifications.shownotificationtoast.md +13 -0
- package/docs/api/foundation-notifications.snackbarbuilder.build.md +5 -0
- package/docs/api/foundation-notifications.snackbarbuilder.md +5 -0
- package/docs/api/foundation-notifications.snackbarbuilder.withconfirmingaction.md +5 -0
- package/docs/api/foundation-notifications.snackbarbuilder.withtype.md +5 -0
- package/docs/api/foundation-notifications.snackbarstructure.body.md +11 -0
- package/docs/api/foundation-notifications.snackbarstructure.loglevel.md +11 -0
- package/docs/api/foundation-notifications.snackbarstructure.md +22 -0
- package/docs/api/foundation-notifications.snackbarstructure.snackbar.md +11 -0
- package/docs/api/foundation-notifications.toastbuilder.build.md +5 -0
- package/docs/api/foundation-notifications.toastbuilder.md +4 -0
- package/docs/api/foundation-notifications.toastbuilder.withautoclose.md +5 -0
- package/docs/api/foundation-notifications.toastbuilder.withbuttons.md +5 -0
- package/docs/api/foundation-notifications.toastbuilder.withclosetimeout.md +5 -0
- package/docs/api/foundation-notifications.toastbuilder.withdetails.md +5 -0
- package/docs/api/foundation-notifications.toastbuilder.withposition.md +5 -0
- package/docs/api/foundation-notifications.toastbuilder.withtype.md +5 -0
- package/docs/api/foundation-notifications.toaststructure.body.md +11 -0
- package/docs/api/foundation-notifications.toaststructure.createdat.md +11 -0
- package/docs/api/foundation-notifications.toaststructure.loglevel.md +11 -0
- package/docs/api/foundation-notifications.toaststructure.md +24 -0
- package/docs/api/foundation-notifications.toaststructure.title.md +11 -0
- package/docs/api/foundation-notifications.toaststructure.toast.md +11 -0
- package/docs/api-report.md +113 -14
- package/package.json +5 -5
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
import { LogLevel } from '@genesislcap/foundation-logger';
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Interface for Alert Structure
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare interface AlertStructure {
|
|
8
|
+
readonly title: string;
|
|
9
|
+
readonly body: string;
|
|
10
|
+
readonly logLevel?: LogLevel;
|
|
11
|
+
}
|
|
12
|
+
|
|
3
13
|
/**
|
|
4
14
|
* Interface for Banner configuration
|
|
5
15
|
* @public
|
|
@@ -12,6 +22,7 @@ export declare interface Banner {
|
|
|
12
22
|
/**
|
|
13
23
|
* BannerBuilder
|
|
14
24
|
* @public
|
|
25
|
+
* @deprecated Use showNotificationBanner instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
15
26
|
*/
|
|
16
27
|
export declare class BannerBuilder {
|
|
17
28
|
private dismissingAction;
|
|
@@ -21,6 +32,7 @@ export declare class BannerBuilder {
|
|
|
21
32
|
* @public
|
|
22
33
|
* @param dismissingAction - {@link DismissingAction}
|
|
23
34
|
* @returns
|
|
35
|
+
* @deprecated Use showNotificationBanner instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
24
36
|
*/
|
|
25
37
|
withDismissingAction(dismissingAction: DismissingAction): BannerBuilder;
|
|
26
38
|
/**
|
|
@@ -28,16 +40,28 @@ export declare class BannerBuilder {
|
|
|
28
40
|
* @public
|
|
29
41
|
* @param confirmingAction - {@link ConfirmingAction}
|
|
30
42
|
* @returns
|
|
43
|
+
* @deprecated Use showNotificationBanner instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
31
44
|
*/
|
|
32
45
|
withConfirmingAction(confirmingAction: ConfirmingAction): BannerBuilder;
|
|
33
46
|
/**
|
|
34
47
|
* Build Banner
|
|
35
48
|
* @public
|
|
36
49
|
* @returns Banner
|
|
50
|
+
* @deprecated Use showNotificationBanner instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
37
51
|
*/
|
|
38
52
|
build(): Banner;
|
|
39
53
|
}
|
|
40
54
|
|
|
55
|
+
/**
|
|
56
|
+
* Interface for Banner Structure
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
export declare interface BannerStructure {
|
|
60
|
+
readonly body: string;
|
|
61
|
+
readonly logLevel?: LogLevel;
|
|
62
|
+
readonly banner?: Banner;
|
|
63
|
+
}
|
|
64
|
+
|
|
41
65
|
/**
|
|
42
66
|
* Interface for Confirming Action configuration
|
|
43
67
|
* @public
|
|
@@ -59,6 +83,7 @@ export declare interface Dialog {
|
|
|
59
83
|
/**
|
|
60
84
|
* DialogBuilder class
|
|
61
85
|
* @public
|
|
86
|
+
* @deprecated Use showNotificationDialog instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
62
87
|
*/
|
|
63
88
|
export declare class DialogBuilder {
|
|
64
89
|
private dismissingAction;
|
|
@@ -68,6 +93,7 @@ export declare class DialogBuilder {
|
|
|
68
93
|
* @public
|
|
69
94
|
* @param dismissingAction - {@link DismissingAction}
|
|
70
95
|
* @returns
|
|
96
|
+
* @deprecated Use showNotificationDialog instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
71
97
|
*/
|
|
72
98
|
withDismissingAction(dismissingAction: DismissingAction): DialogBuilder;
|
|
73
99
|
/**
|
|
@@ -75,12 +101,14 @@ export declare class DialogBuilder {
|
|
|
75
101
|
* @public
|
|
76
102
|
* @param confirmingAction - {@link ConfirmingAction}
|
|
77
103
|
* @returns
|
|
104
|
+
* @deprecated Use showNotificationDialog instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
78
105
|
*/
|
|
79
106
|
withConfirmingAction(confirmingAction: ConfirmingAction): DialogBuilder;
|
|
80
107
|
/**
|
|
81
108
|
* Build Dialog
|
|
82
109
|
* @public
|
|
83
110
|
* @returns Dialog
|
|
111
|
+
* @deprecated Use showNotificationDialog instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
84
112
|
*/
|
|
85
113
|
build(): Dialog;
|
|
86
114
|
}
|
|
@@ -92,6 +120,17 @@ export declare type DialogElement = NotificationElement & {
|
|
|
92
120
|
show: Function;
|
|
93
121
|
};
|
|
94
122
|
|
|
123
|
+
/**
|
|
124
|
+
* Interface for Dialog Structure
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
export declare interface DialogStructure {
|
|
128
|
+
readonly title: string;
|
|
129
|
+
readonly body: string;
|
|
130
|
+
readonly logLevel?: LogLevel;
|
|
131
|
+
readonly dialog?: Dialog;
|
|
132
|
+
}
|
|
133
|
+
|
|
95
134
|
/**
|
|
96
135
|
* Interface for Dismissing Action configuration
|
|
97
136
|
* @public
|
|
@@ -112,12 +151,14 @@ export declare const getBannerAnchor: (element: any) => HTMLElement | null;
|
|
|
112
151
|
/**
|
|
113
152
|
* Get banner builder instance
|
|
114
153
|
* @public
|
|
154
|
+
* @deprecated Use showNotificationBanner instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
115
155
|
*/
|
|
116
156
|
export declare const getBannerBuilder: () => BannerBuilder;
|
|
117
157
|
|
|
118
158
|
/**
|
|
119
159
|
* Returns an instance of DialogBuilder
|
|
120
160
|
* @public
|
|
161
|
+
* @deprecated Use showNotificationDialog instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
121
162
|
*/
|
|
122
163
|
export declare const getDialogBuilder: () => DialogBuilder;
|
|
123
164
|
|
|
@@ -132,6 +173,7 @@ export declare const getLoglevel: (details: NotificationStructure) => LogLevel;
|
|
|
132
173
|
/**
|
|
133
174
|
* Returns a new NotificationBuilder instance
|
|
134
175
|
* @public
|
|
176
|
+
* @deprecated Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
135
177
|
*/
|
|
136
178
|
export declare const getNotificationBuilder: () => NotificationBuilder;
|
|
137
179
|
|
|
@@ -155,18 +197,21 @@ export declare const getNotificationDetails: (details: NotificationStructure) =>
|
|
|
155
197
|
/**
|
|
156
198
|
* Get snackbar builder instance
|
|
157
199
|
* @public
|
|
200
|
+
* @deprecated Use showNotificationSnackbar instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
158
201
|
*/
|
|
159
202
|
export declare const getSnackbarBuilder: () => SnackbarBuilder;
|
|
160
203
|
|
|
161
204
|
/**
|
|
162
205
|
* Get notification builder instance
|
|
163
206
|
* @public
|
|
207
|
+
* @deprecated Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
164
208
|
*/
|
|
165
209
|
export declare const getToastBuilder: () => ToastBuilder;
|
|
166
210
|
|
|
167
211
|
/**
|
|
168
212
|
* NotificationBuilder to build NotificationStructure
|
|
169
213
|
* @public
|
|
214
|
+
* @deprecated Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
170
215
|
*/
|
|
171
216
|
export declare class NotificationBuilder {
|
|
172
217
|
private title;
|
|
@@ -183,6 +228,7 @@ export declare class NotificationBuilder {
|
|
|
183
228
|
* @public
|
|
184
229
|
* @param title - string
|
|
185
230
|
* @returns
|
|
231
|
+
* @deprecated Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
186
232
|
*/
|
|
187
233
|
withTitle(title: string): NotificationBuilder;
|
|
188
234
|
/**
|
|
@@ -190,6 +236,7 @@ export declare class NotificationBuilder {
|
|
|
190
236
|
* @public
|
|
191
237
|
* @param body - string
|
|
192
238
|
* @returns
|
|
239
|
+
* @deprecated Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
193
240
|
*/
|
|
194
241
|
withBody(body: string): NotificationBuilder;
|
|
195
242
|
/**
|
|
@@ -197,12 +244,14 @@ export declare class NotificationBuilder {
|
|
|
197
244
|
* @public
|
|
198
245
|
* @param createdAt - Date
|
|
199
246
|
* @returns
|
|
247
|
+
* @deprecated Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
200
248
|
*/
|
|
201
249
|
withCreatedAt(createdAt: Date): NotificationBuilder;
|
|
202
250
|
/**
|
|
203
251
|
* Add log level to notification
|
|
204
252
|
* @public
|
|
205
253
|
* @returns
|
|
254
|
+
* @deprecated Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
206
255
|
*/
|
|
207
256
|
withLogLevel(logLevel: LogLevel): NotificationBuilder;
|
|
208
257
|
/**
|
|
@@ -210,6 +259,7 @@ export declare class NotificationBuilder {
|
|
|
210
259
|
* @public
|
|
211
260
|
* @param alert - boolean
|
|
212
261
|
* @returns
|
|
262
|
+
* @deprecated Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
213
263
|
*/
|
|
214
264
|
withAlert(alert: boolean): NotificationBuilder;
|
|
215
265
|
/**
|
|
@@ -217,6 +267,7 @@ export declare class NotificationBuilder {
|
|
|
217
267
|
* @public
|
|
218
268
|
* @param notification - {@link Toast}
|
|
219
269
|
* @returns
|
|
270
|
+
* @deprecated Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
220
271
|
*/
|
|
221
272
|
withToast(toast: Toast): NotificationBuilder;
|
|
222
273
|
/**
|
|
@@ -224,6 +275,7 @@ export declare class NotificationBuilder {
|
|
|
224
275
|
* @public
|
|
225
276
|
* @param banner - {@link Banner}
|
|
226
277
|
* @returns
|
|
278
|
+
* @deprecated Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
227
279
|
*/
|
|
228
280
|
withBanner(banner: Banner): NotificationBuilder;
|
|
229
281
|
/**
|
|
@@ -231,6 +283,7 @@ export declare class NotificationBuilder {
|
|
|
231
283
|
* @public
|
|
232
284
|
* @param snackbar - {@link Snackbar}
|
|
233
285
|
* @returns
|
|
286
|
+
* @deprecated Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
234
287
|
*/
|
|
235
288
|
withSnackbar(snackbar: Snackbar): NotificationBuilder;
|
|
236
289
|
/**
|
|
@@ -238,12 +291,14 @@ export declare class NotificationBuilder {
|
|
|
238
291
|
* @public
|
|
239
292
|
* @param dialog - {@link Dialog}
|
|
240
293
|
* @returns
|
|
294
|
+
* @deprecated Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
241
295
|
*/
|
|
242
296
|
withDialog(dialog: Dialog): NotificationBuilder;
|
|
243
297
|
/**
|
|
244
298
|
* Build NotificationStructure
|
|
245
299
|
* @public
|
|
246
300
|
* @returns
|
|
301
|
+
* @deprecated Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
247
302
|
*/
|
|
248
303
|
build(): NotificationStructure;
|
|
249
304
|
}
|
|
@@ -291,11 +346,11 @@ export declare enum NotificationEvent {
|
|
|
291
346
|
export declare type NotificationSeverity = 'Information' | 'Warning' | 'Serious' | 'Critical';
|
|
292
347
|
|
|
293
348
|
/**
|
|
294
|
-
* Interface for Structure
|
|
349
|
+
* Interface for Notification Structure
|
|
295
350
|
* @public
|
|
296
351
|
*/
|
|
297
352
|
export declare interface NotificationStructure {
|
|
298
|
-
readonly title
|
|
353
|
+
readonly title?: string;
|
|
299
354
|
readonly body: string;
|
|
300
355
|
readonly createdAt?: Date;
|
|
301
356
|
readonly logLevel?: LogLevel;
|
|
@@ -335,7 +390,14 @@ export declare const showBanner: (notificationStructure: NotificationStructure,
|
|
|
335
390
|
* @param tagName - The tag name to create prefix for the design system provider & notification component
|
|
336
391
|
* @returns
|
|
337
392
|
* */
|
|
338
|
-
export declare const showDialog: (
|
|
393
|
+
export declare const showDialog: (notificationStructure: NotificationStructure, tagName: String) => void;
|
|
394
|
+
|
|
395
|
+
/**
|
|
396
|
+
* Shows logger with log level from NotificationStructure object
|
|
397
|
+
* @public
|
|
398
|
+
* @param notificationStructure - The NotificationStructure object
|
|
399
|
+
*/
|
|
400
|
+
export declare const showLoggerLogLevel: (notificationStructure: NotificationStructure) => void;
|
|
339
401
|
|
|
340
402
|
/**
|
|
341
403
|
* Shows the notificationStructure in the appropriate component
|
|
@@ -347,6 +409,36 @@ export declare const showDialog: (notification: NotificationStructure, tagName:
|
|
|
347
409
|
* */
|
|
348
410
|
export declare const showNotification: (notificationStructure: NotificationStructure, tagName: String, notificationBoundary?: HTMLElement) => void;
|
|
349
411
|
|
|
412
|
+
/**
|
|
413
|
+
* Shows the notification alert
|
|
414
|
+
* @public
|
|
415
|
+
*/
|
|
416
|
+
export declare const showNotificationAlert: (configuration: AlertStructure) => void;
|
|
417
|
+
|
|
418
|
+
/**
|
|
419
|
+
* Shows the notification banner
|
|
420
|
+
* @public
|
|
421
|
+
*/
|
|
422
|
+
export declare const showNotificationBanner: (configuration: BannerStructure, tagName: String, notificationBoundary?: HTMLElement) => void;
|
|
423
|
+
|
|
424
|
+
/**
|
|
425
|
+
* Shows the notification dialog
|
|
426
|
+
* @public
|
|
427
|
+
*/
|
|
428
|
+
export declare const showNotificationDialog: (configuration: DialogStructure, tagName: String) => void;
|
|
429
|
+
|
|
430
|
+
/**
|
|
431
|
+
* Shows the notification snackbar
|
|
432
|
+
* @public
|
|
433
|
+
*/
|
|
434
|
+
export declare const showNotificationSnackbar: (configuration: SnackbarStructure, tagName: String) => void;
|
|
435
|
+
|
|
436
|
+
/**
|
|
437
|
+
* Shows the notification toast
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
export declare const showNotificationToast: (configuration: ToastStructure, tagName: String) => void;
|
|
441
|
+
|
|
350
442
|
/**
|
|
351
443
|
* Shows the snackbar
|
|
352
444
|
* @internal
|
|
@@ -354,7 +446,7 @@ export declare const showNotification: (notificationStructure: NotificationStruc
|
|
|
354
446
|
* @param tagName - The tag name to create prefix for the design system provider & notification component
|
|
355
447
|
* @returns
|
|
356
448
|
* */
|
|
357
|
-
export declare const showSnackbar: (
|
|
449
|
+
export declare const showSnackbar: (notificationStructure: NotificationStructure, tagName: String) => void;
|
|
358
450
|
|
|
359
451
|
/**
|
|
360
452
|
* Shows the notificationStructure
|
|
@@ -377,6 +469,7 @@ export declare interface Snackbar {
|
|
|
377
469
|
/**
|
|
378
470
|
* SnackbarBuilder to build Snackbar
|
|
379
471
|
* @public
|
|
472
|
+
* @deprecated Use showNotificationSnackbar instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
380
473
|
*/
|
|
381
474
|
export declare class SnackbarBuilder {
|
|
382
475
|
private confirmingActions;
|
|
@@ -385,6 +478,7 @@ export declare class SnackbarBuilder {
|
|
|
385
478
|
* @public
|
|
386
479
|
* @param type - {@link SnackbarType}
|
|
387
480
|
* @returns
|
|
481
|
+
* @deprecated Use showNotificationSnackbar instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
388
482
|
*/
|
|
389
483
|
withType(type: SnackbarType): SnackbarBuilder;
|
|
390
484
|
/**
|
|
@@ -392,16 +486,28 @@ export declare class SnackbarBuilder {
|
|
|
392
486
|
* @public
|
|
393
487
|
* @param confirmingAction - {@link ConfirmingAction}
|
|
394
488
|
* @returns
|
|
489
|
+
* @deprecated Use showNotificationSnackbar instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
395
490
|
*/
|
|
396
491
|
withConfirmingAction(confirmingAction: ConfirmingAction): SnackbarBuilder;
|
|
397
492
|
/**
|
|
398
493
|
* Build snackbar
|
|
399
494
|
* @public
|
|
400
495
|
* @returns Snackbar
|
|
496
|
+
* @deprecated Use showNotificationSnackbar instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
401
497
|
*/
|
|
402
498
|
build(): Snackbar;
|
|
403
499
|
}
|
|
404
500
|
|
|
501
|
+
/**
|
|
502
|
+
* Interface for Snackbar Structure
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
export declare interface SnackbarStructure {
|
|
506
|
+
readonly body: string;
|
|
507
|
+
readonly logLevel?: LogLevel;
|
|
508
|
+
readonly snackbar?: Snackbar;
|
|
509
|
+
}
|
|
510
|
+
|
|
405
511
|
/**
|
|
406
512
|
* @public
|
|
407
513
|
* type for snackbar type
|
|
@@ -423,6 +529,7 @@ export declare interface Toast {
|
|
|
423
529
|
|
|
424
530
|
/**
|
|
425
531
|
* @public
|
|
532
|
+
* @deprecated Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
426
533
|
*/
|
|
427
534
|
export declare class ToastBuilder {
|
|
428
535
|
private position;
|
|
@@ -436,6 +543,7 @@ export declare class ToastBuilder {
|
|
|
436
543
|
* @public
|
|
437
544
|
* @param position - {@link ToastPosition}
|
|
438
545
|
* @returns
|
|
546
|
+
* @deprecated Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
439
547
|
*/
|
|
440
548
|
withPosition(position: ToastPosition): ToastBuilder;
|
|
441
549
|
/**
|
|
@@ -443,6 +551,7 @@ export declare class ToastBuilder {
|
|
|
443
551
|
* @public
|
|
444
552
|
* @param autoClose - boolean
|
|
445
553
|
* @returns
|
|
554
|
+
* @deprecated Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
446
555
|
*/
|
|
447
556
|
withAutoClose(autoClose: boolean): ToastBuilder;
|
|
448
557
|
/**
|
|
@@ -450,6 +559,7 @@ export declare class ToastBuilder {
|
|
|
450
559
|
* @public
|
|
451
560
|
* @param closeTimeout - number
|
|
452
561
|
* @returns
|
|
562
|
+
* @deprecated Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
453
563
|
*/
|
|
454
564
|
withCloseTimeout(closeTimeout: number): ToastBuilder;
|
|
455
565
|
/**
|
|
@@ -457,6 +567,7 @@ export declare class ToastBuilder {
|
|
|
457
567
|
* @public
|
|
458
568
|
* @param type - {@link NotificationType}
|
|
459
569
|
* @returns
|
|
570
|
+
* @deprecated Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
460
571
|
*/
|
|
461
572
|
withType(type: NotificationType): ToastBuilder;
|
|
462
573
|
/**
|
|
@@ -464,6 +575,7 @@ export declare class ToastBuilder {
|
|
|
464
575
|
* @public
|
|
465
576
|
* @param details - NotificationDataRow
|
|
466
577
|
* @returns
|
|
578
|
+
* @deprecated Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
467
579
|
*/
|
|
468
580
|
withDetails(details: NotificationDataRow): ToastBuilder;
|
|
469
581
|
/**
|
|
@@ -471,11 +583,13 @@ export declare class ToastBuilder {
|
|
|
471
583
|
* @public
|
|
472
584
|
* @param buttons - ToastButton[]
|
|
473
585
|
* @returns
|
|
586
|
+
* @deprecated Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
474
587
|
*/
|
|
475
588
|
withButtons(buttons: ToastButton[]): ToastBuilder;
|
|
476
589
|
/**
|
|
477
590
|
* Build notification
|
|
478
591
|
* @returns Toast
|
|
592
|
+
* @deprecated Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
479
593
|
*/
|
|
480
594
|
build(): Toast;
|
|
481
595
|
}
|
|
@@ -503,4 +617,16 @@ export declare interface ToastButton {
|
|
|
503
617
|
*/
|
|
504
618
|
export declare type ToastPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
|
505
619
|
|
|
620
|
+
/**
|
|
621
|
+
* Interface for Toast Structure
|
|
622
|
+
* @public
|
|
623
|
+
*/
|
|
624
|
+
export declare interface ToastStructure {
|
|
625
|
+
readonly title: string;
|
|
626
|
+
readonly body: string;
|
|
627
|
+
readonly createdAt?: Date;
|
|
628
|
+
readonly logLevel?: LogLevel;
|
|
629
|
+
readonly toast?: Toast;
|
|
630
|
+
}
|
|
631
|
+
|
|
506
632
|
export { }
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [AlertStructure](./foundation-notifications.alertstructure.md) > [body](./foundation-notifications.alertstructure.body.md)
|
|
4
|
+
|
|
5
|
+
## AlertStructure.body property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly body: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [AlertStructure](./foundation-notifications.alertstructure.md) > [logLevel](./foundation-notifications.alertstructure.loglevel.md)
|
|
4
|
+
|
|
5
|
+
## AlertStructure.logLevel property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly logLevel?: LogLevel;
|
|
11
|
+
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [AlertStructure](./foundation-notifications.alertstructure.md)
|
|
4
|
+
|
|
5
|
+
## AlertStructure interface
|
|
6
|
+
|
|
7
|
+
Interface for Alert Structure
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface AlertStructure
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [body](./foundation-notifications.alertstructure.body.md) | <code>readonly</code> | string | |
|
|
20
|
+
| [logLevel?](./foundation-notifications.alertstructure.loglevel.md) | <code>readonly</code> | LogLevel | _(Optional)_ |
|
|
21
|
+
| [title](./foundation-notifications.alertstructure.title.md) | <code>readonly</code> | string | |
|
|
22
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [AlertStructure](./foundation-notifications.alertstructure.md) > [title](./foundation-notifications.alertstructure.title.md)
|
|
4
|
+
|
|
5
|
+
## AlertStructure.title property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly title: string;
|
|
11
|
+
```
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## BannerBuilder.withConfirmingAction() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add confirming action to Banner
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## BannerBuilder.withDismissingAction() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add dismissing action to Banner
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [BannerStructure](./foundation-notifications.bannerstructure.md) > [banner](./foundation-notifications.bannerstructure.banner.md)
|
|
4
|
+
|
|
5
|
+
## BannerStructure.banner property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly banner?: Banner;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [BannerStructure](./foundation-notifications.bannerstructure.md) > [body](./foundation-notifications.bannerstructure.body.md)
|
|
4
|
+
|
|
5
|
+
## BannerStructure.body property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly body: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [BannerStructure](./foundation-notifications.bannerstructure.md) > [logLevel](./foundation-notifications.bannerstructure.loglevel.md)
|
|
4
|
+
|
|
5
|
+
## BannerStructure.logLevel property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly logLevel?: LogLevel;
|
|
11
|
+
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [BannerStructure](./foundation-notifications.bannerstructure.md)
|
|
4
|
+
|
|
5
|
+
## BannerStructure interface
|
|
6
|
+
|
|
7
|
+
Interface for Banner Structure
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface BannerStructure
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [banner?](./foundation-notifications.bannerstructure.banner.md) | <code>readonly</code> | [Banner](./foundation-notifications.banner.md) | _(Optional)_ |
|
|
20
|
+
| [body](./foundation-notifications.bannerstructure.body.md) | <code>readonly</code> | string | |
|
|
21
|
+
| [logLevel?](./foundation-notifications.bannerstructure.loglevel.md) | <code>readonly</code> | LogLevel | _(Optional)_ |
|
|
22
|
+
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## DialogBuilder.withConfirmingAction() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationDialog instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add confirming action to Dialog
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## DialogBuilder.withDismissingAction() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationDialog instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add dismissing action to Dialog
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [DialogStructure](./foundation-notifications.dialogstructure.md) > [body](./foundation-notifications.dialogstructure.body.md)
|
|
4
|
+
|
|
5
|
+
## DialogStructure.body property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly body: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [DialogStructure](./foundation-notifications.dialogstructure.md) > [dialog](./foundation-notifications.dialogstructure.dialog.md)
|
|
4
|
+
|
|
5
|
+
## DialogStructure.dialog property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly dialog?: Dialog;
|
|
11
|
+
```
|