@genesislcap/foundation-notifications 14.52.2 → 14.53.1-alpha-afe9ebe.0
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/dist/dts/notification-builder.d.ts.map +1 -1
- package/dist/dts/toast/toast-builder.d.ts +17 -1
- 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 +43 -0
- package/dist/dts/types.d.ts.map +1 -1
- package/dist/esm/toast/toast-builder.js +26 -0
- package/dist/esm/toast/toast-launcher.js +33 -6
- package/dist/foundation-notifications.api.json +712 -8
- package/dist/foundation-notifications.d.ts +62 -0
- package/docs/api/foundation-notifications.md +3 -0
- package/docs/api/foundation-notifications.notificationdatarow.alert_id.md +11 -0
- package/docs/api/foundation-notifications.notificationdatarow.created_at.md +11 -0
- package/docs/api/foundation-notifications.notificationdatarow.details.md +14 -0
- package/docs/api/foundation-notifications.notificationdatarow.expiry.md +11 -0
- package/docs/api/foundation-notifications.notificationdatarow.header.md +11 -0
- package/docs/api/foundation-notifications.notificationdatarow.md +30 -0
- package/docs/api/foundation-notifications.notificationdatarow.message.md +11 -0
- package/docs/api/foundation-notifications.notificationdatarow.notify_severity.md +11 -0
- package/docs/api/foundation-notifications.notificationdatarow.sender.md +11 -0
- package/docs/api/foundation-notifications.notificationdatarow.table_entity_id.md +11 -0
- package/docs/api/foundation-notifications.notificationdatarow.topic.md +11 -0
- package/docs/api/foundation-notifications.notificationdatarow.user_name.md +11 -0
- package/docs/api/foundation-notifications.notificationseverity.md +13 -0
- package/docs/api/foundation-notifications.toast.buttons.md +11 -0
- package/docs/api/foundation-notifications.toast.details.md +11 -0
- package/docs/api/foundation-notifications.toast.md +2 -0
- package/docs/api/foundation-notifications.toastbuilder.md +2 -0
- package/docs/api/foundation-notifications.toastbuilder.withbuttons.md +25 -0
- package/docs/api/foundation-notifications.toastbuilder.withdetails.md +25 -0
- package/docs/api/foundation-notifications.toastbutton.action.md +26 -0
- package/docs/api/foundation-notifications.toastbutton.appearance.md +11 -0
- package/docs/api/foundation-notifications.toastbutton.condition.md +24 -0
- package/docs/api/foundation-notifications.toastbutton.md +28 -0
- package/docs/api/foundation-notifications.toastbutton.placeholder.md +11 -0
- package/docs/api-report.md +56 -0
- package/package.json +5 -5
|
@@ -240,6 +240,27 @@ export declare class NotificationBuilder {
|
|
|
240
240
|
build(): NotificationStructure;
|
|
241
241
|
}
|
|
242
242
|
|
|
243
|
+
/**
|
|
244
|
+
* Interface for notify data
|
|
245
|
+
* @public
|
|
246
|
+
*/
|
|
247
|
+
export declare interface NotificationDataRow {
|
|
248
|
+
ALERT_ID: string;
|
|
249
|
+
CREATED_AT: number;
|
|
250
|
+
DETAILS: {
|
|
251
|
+
OPERATION: string;
|
|
252
|
+
ROW_REF: string;
|
|
253
|
+
};
|
|
254
|
+
HEADER: string;
|
|
255
|
+
MESSAGE: string;
|
|
256
|
+
NOTIFY_SEVERITY: NotificationSeverity;
|
|
257
|
+
EXPIRY?: null;
|
|
258
|
+
SENDER?: null;
|
|
259
|
+
USER_NAME: string;
|
|
260
|
+
TABLE_ENTITY_ID: string;
|
|
261
|
+
TOPIC: string;
|
|
262
|
+
}
|
|
263
|
+
|
|
243
264
|
/**
|
|
244
265
|
* @internal
|
|
245
266
|
*/
|
|
@@ -255,6 +276,12 @@ export declare enum NotificationEvent {
|
|
|
255
276
|
NOTIFICATION_EVENT = "notification-event"
|
|
256
277
|
}
|
|
257
278
|
|
|
279
|
+
/**
|
|
280
|
+
* type for notification severity
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
export declare type NotificationSeverity = 'Information' | 'Warning' | 'Serious' | 'Critical';
|
|
284
|
+
|
|
258
285
|
/**
|
|
259
286
|
* Interface for Structure
|
|
260
287
|
* @public
|
|
@@ -381,6 +408,8 @@ export declare interface Toast {
|
|
|
381
408
|
readonly type?: NotificationType;
|
|
382
409
|
readonly autoClose?: boolean;
|
|
383
410
|
readonly closeTimeout?: number;
|
|
411
|
+
readonly details?: NotificationDataRow;
|
|
412
|
+
readonly buttons?: ToastButton[];
|
|
384
413
|
}
|
|
385
414
|
|
|
386
415
|
/**
|
|
@@ -391,6 +420,8 @@ export declare class ToastBuilder {
|
|
|
391
420
|
private autoClose;
|
|
392
421
|
private closeTimeout;
|
|
393
422
|
private type;
|
|
423
|
+
private details;
|
|
424
|
+
private buttons;
|
|
394
425
|
/**
|
|
395
426
|
* Add position to toast
|
|
396
427
|
* @public
|
|
@@ -419,6 +450,20 @@ export declare class ToastBuilder {
|
|
|
419
450
|
* @returns
|
|
420
451
|
*/
|
|
421
452
|
withType(type: NotificationType): ToastBuilder;
|
|
453
|
+
/**
|
|
454
|
+
* Add details data to notifications
|
|
455
|
+
* @public
|
|
456
|
+
* @param details - NotificationDataRow
|
|
457
|
+
* @returns
|
|
458
|
+
*/
|
|
459
|
+
withDetails(details: NotificationDataRow): ToastBuilder;
|
|
460
|
+
/**
|
|
461
|
+
* Add buttons to notifications
|
|
462
|
+
* @public
|
|
463
|
+
* @param buttons - ToastButton[]
|
|
464
|
+
* @returns
|
|
465
|
+
*/
|
|
466
|
+
withButtons(buttons: ToastButton[]): ToastBuilder;
|
|
422
467
|
/**
|
|
423
468
|
* Build notification
|
|
424
469
|
* @returns Toast
|
|
@@ -426,6 +471,23 @@ export declare class ToastBuilder {
|
|
|
426
471
|
build(): Toast;
|
|
427
472
|
}
|
|
428
473
|
|
|
474
|
+
/**
|
|
475
|
+
* Interface for ToastButton
|
|
476
|
+
* @public
|
|
477
|
+
*/
|
|
478
|
+
export declare interface ToastButton {
|
|
479
|
+
action({ details, elementButton, elementToast, }: {
|
|
480
|
+
details: NotificationDataRow;
|
|
481
|
+
elementButton: HTMLElement;
|
|
482
|
+
elementToast: HTMLElement;
|
|
483
|
+
}): void;
|
|
484
|
+
condition({ details }?: {
|
|
485
|
+
details: NotificationDataRow;
|
|
486
|
+
}): boolean;
|
|
487
|
+
placeholder?: string;
|
|
488
|
+
appearance?: string;
|
|
489
|
+
}
|
|
490
|
+
|
|
429
491
|
/**
|
|
430
492
|
* @public
|
|
431
493
|
* type for notification position
|
|
@@ -28,9 +28,11 @@
|
|
|
28
28
|
| [ConfirmingAction](./foundation-notifications.confirmingaction.md) | Interface for Confirming Action configuration |
|
|
29
29
|
| [Dialog](./foundation-notifications.dialog.md) | Interface for Dialog configuration |
|
|
30
30
|
| [DismissingAction](./foundation-notifications.dismissingaction.md) | Interface for Dismissing Action configuration |
|
|
31
|
+
| [NotificationDataRow](./foundation-notifications.notificationdatarow.md) | Interface for notify data |
|
|
31
32
|
| [NotificationStructure](./foundation-notifications.notificationstructure.md) | Interface for Structure |
|
|
32
33
|
| [Snackbar](./foundation-notifications.snackbar.md) | Interface for Snackbar configuration |
|
|
33
34
|
| [Toast](./foundation-notifications.toast.md) | Interface for Toast configuration |
|
|
35
|
+
| [ToastButton](./foundation-notifications.toastbutton.md) | Interface for ToastButton |
|
|
34
36
|
|
|
35
37
|
## Variables
|
|
36
38
|
|
|
@@ -52,6 +54,7 @@
|
|
|
52
54
|
|
|
53
55
|
| Type Alias | Description |
|
|
54
56
|
| --- | --- |
|
|
57
|
+
| [NotificationSeverity](./foundation-notifications.notificationseverity.md) | type for notification severity |
|
|
55
58
|
| [NotificationType](./foundation-notifications.notificationtype.md) | type for notification |
|
|
56
59
|
| [SnackbarType](./foundation-notifications.snackbartype.md) | type for snackbar type |
|
|
57
60
|
| [ToastPosition](./foundation-notifications.toastposition.md) | type for notification position |
|
|
@@ -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) > [NotificationDataRow](./foundation-notifications.notificationdatarow.md) > [ALERT\_ID](./foundation-notifications.notificationdatarow.alert_id.md)
|
|
4
|
+
|
|
5
|
+
## NotificationDataRow.ALERT\_ID property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
ALERT_ID: 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) > [NotificationDataRow](./foundation-notifications.notificationdatarow.md) > [CREATED\_AT](./foundation-notifications.notificationdatarow.created_at.md)
|
|
4
|
+
|
|
5
|
+
## NotificationDataRow.CREATED\_AT property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
CREATED_AT: number;
|
|
11
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [NotificationDataRow](./foundation-notifications.notificationdatarow.md) > [DETAILS](./foundation-notifications.notificationdatarow.details.md)
|
|
4
|
+
|
|
5
|
+
## NotificationDataRow.DETAILS property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
DETAILS: {
|
|
11
|
+
OPERATION: string;
|
|
12
|
+
ROW_REF: string;
|
|
13
|
+
};
|
|
14
|
+
```
|
|
@@ -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) > [NotificationDataRow](./foundation-notifications.notificationdatarow.md) > [EXPIRY](./foundation-notifications.notificationdatarow.expiry.md)
|
|
4
|
+
|
|
5
|
+
## NotificationDataRow.EXPIRY property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
EXPIRY?: null;
|
|
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) > [NotificationDataRow](./foundation-notifications.notificationdatarow.md) > [HEADER](./foundation-notifications.notificationdatarow.header.md)
|
|
4
|
+
|
|
5
|
+
## NotificationDataRow.HEADER property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
HEADER: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [NotificationDataRow](./foundation-notifications.notificationdatarow.md)
|
|
4
|
+
|
|
5
|
+
## NotificationDataRow interface
|
|
6
|
+
|
|
7
|
+
Interface for notify data
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface NotificationDataRow
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [ALERT\_ID](./foundation-notifications.notificationdatarow.alert_id.md) | | string | |
|
|
20
|
+
| [CREATED\_AT](./foundation-notifications.notificationdatarow.created_at.md) | | number | |
|
|
21
|
+
| [DETAILS](./foundation-notifications.notificationdatarow.details.md) | | { OPERATION: string; ROW\_REF: string; } | |
|
|
22
|
+
| [EXPIRY?](./foundation-notifications.notificationdatarow.expiry.md) | | null | _(Optional)_ |
|
|
23
|
+
| [HEADER](./foundation-notifications.notificationdatarow.header.md) | | string | |
|
|
24
|
+
| [MESSAGE](./foundation-notifications.notificationdatarow.message.md) | | string | |
|
|
25
|
+
| [NOTIFY\_SEVERITY](./foundation-notifications.notificationdatarow.notify_severity.md) | | [NotificationSeverity](./foundation-notifications.notificationseverity.md) | |
|
|
26
|
+
| [SENDER?](./foundation-notifications.notificationdatarow.sender.md) | | null | _(Optional)_ |
|
|
27
|
+
| [TABLE\_ENTITY\_ID](./foundation-notifications.notificationdatarow.table_entity_id.md) | | string | |
|
|
28
|
+
| [TOPIC](./foundation-notifications.notificationdatarow.topic.md) | | string | |
|
|
29
|
+
| [USER\_NAME](./foundation-notifications.notificationdatarow.user_name.md) | | string | |
|
|
30
|
+
|
|
@@ -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) > [NotificationDataRow](./foundation-notifications.notificationdatarow.md) > [MESSAGE](./foundation-notifications.notificationdatarow.message.md)
|
|
4
|
+
|
|
5
|
+
## NotificationDataRow.MESSAGE property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
MESSAGE: 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) > [NotificationDataRow](./foundation-notifications.notificationdatarow.md) > [NOTIFY\_SEVERITY](./foundation-notifications.notificationdatarow.notify_severity.md)
|
|
4
|
+
|
|
5
|
+
## NotificationDataRow.NOTIFY\_SEVERITY property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
NOTIFY_SEVERITY: NotificationSeverity;
|
|
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) > [NotificationDataRow](./foundation-notifications.notificationdatarow.md) > [SENDER](./foundation-notifications.notificationdatarow.sender.md)
|
|
4
|
+
|
|
5
|
+
## NotificationDataRow.SENDER property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
SENDER?: null;
|
|
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) > [NotificationDataRow](./foundation-notifications.notificationdatarow.md) > [TABLE\_ENTITY\_ID](./foundation-notifications.notificationdatarow.table_entity_id.md)
|
|
4
|
+
|
|
5
|
+
## NotificationDataRow.TABLE\_ENTITY\_ID property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
TABLE_ENTITY_ID: 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) > [NotificationDataRow](./foundation-notifications.notificationdatarow.md) > [TOPIC](./foundation-notifications.notificationdatarow.topic.md)
|
|
4
|
+
|
|
5
|
+
## NotificationDataRow.TOPIC property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
TOPIC: 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) > [NotificationDataRow](./foundation-notifications.notificationdatarow.md) > [USER\_NAME](./foundation-notifications.notificationdatarow.user_name.md)
|
|
4
|
+
|
|
5
|
+
## NotificationDataRow.USER\_NAME property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
USER_NAME: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [NotificationSeverity](./foundation-notifications.notificationseverity.md)
|
|
4
|
+
|
|
5
|
+
## NotificationSeverity type
|
|
6
|
+
|
|
7
|
+
type for notification severity
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export type NotificationSeverity = 'Information' | 'Warning' | 'Serious' | 'Critical';
|
|
13
|
+
```
|
|
@@ -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) > [Toast](./foundation-notifications.toast.md) > [buttons](./foundation-notifications.toast.buttons.md)
|
|
4
|
+
|
|
5
|
+
## Toast.buttons property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly buttons?: ToastButton[];
|
|
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) > [Toast](./foundation-notifications.toast.md) > [details](./foundation-notifications.toast.details.md)
|
|
4
|
+
|
|
5
|
+
## Toast.details property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly details?: NotificationDataRow;
|
|
11
|
+
```
|
|
@@ -17,7 +17,9 @@ export interface Toast
|
|
|
17
17
|
| Property | Modifiers | Type | Description |
|
|
18
18
|
| --- | --- | --- | --- |
|
|
19
19
|
| [autoClose?](./foundation-notifications.toast.autoclose.md) | <code>readonly</code> | boolean | _(Optional)_ |
|
|
20
|
+
| [buttons?](./foundation-notifications.toast.buttons.md) | <code>readonly</code> | [ToastButton](./foundation-notifications.toastbutton.md)<!-- -->\[\] | _(Optional)_ |
|
|
20
21
|
| [closeTimeout?](./foundation-notifications.toast.closetimeout.md) | <code>readonly</code> | number | _(Optional)_ |
|
|
22
|
+
| [details?](./foundation-notifications.toast.details.md) | <code>readonly</code> | [NotificationDataRow](./foundation-notifications.notificationdatarow.md) | _(Optional)_ |
|
|
21
23
|
| [position?](./foundation-notifications.toast.position.md) | <code>readonly</code> | [ToastPosition](./foundation-notifications.toastposition.md) | _(Optional)_ |
|
|
22
24
|
| [type?](./foundation-notifications.toast.type.md) | <code>readonly</code> | [NotificationType](./foundation-notifications.notificationtype.md) | _(Optional)_ |
|
|
23
25
|
|
|
@@ -17,7 +17,9 @@ export declare class ToastBuilder
|
|
|
17
17
|
| --- | --- | --- |
|
|
18
18
|
| [build()](./foundation-notifications.toastbuilder.build.md) | | Build notification |
|
|
19
19
|
| [withAutoClose(autoClose)](./foundation-notifications.toastbuilder.withautoclose.md) | | Add auto close to notification |
|
|
20
|
+
| [withButtons(buttons)](./foundation-notifications.toastbuilder.withbuttons.md) | | Add buttons to notifications |
|
|
20
21
|
| [withCloseTimeout(closeTimeout)](./foundation-notifications.toastbuilder.withclosetimeout.md) | | Add close timeout to notification |
|
|
22
|
+
| [withDetails(details)](./foundation-notifications.toastbuilder.withdetails.md) | | Add details data to notifications |
|
|
21
23
|
| [withPosition(position)](./foundation-notifications.toastbuilder.withposition.md) | | Add position to toast |
|
|
22
24
|
| [withType(type)](./foundation-notifications.toastbuilder.withtype.md) | | Add type to notification, if the type is anything other than 'warning' or 'success' do not add it |
|
|
23
25
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [ToastBuilder](./foundation-notifications.toastbuilder.md) > [withButtons](./foundation-notifications.toastbuilder.withbuttons.md)
|
|
4
|
+
|
|
5
|
+
## ToastBuilder.withButtons() method
|
|
6
|
+
|
|
7
|
+
Add buttons to notifications
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withButtons(buttons: ToastButton[]): ToastBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| buttons | [ToastButton](./foundation-notifications.toastbutton.md)<!-- -->\[\] | ToastButton\[\] |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[ToastBuilder](./foundation-notifications.toastbuilder.md)
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [ToastBuilder](./foundation-notifications.toastbuilder.md) > [withDetails](./foundation-notifications.toastbuilder.withdetails.md)
|
|
4
|
+
|
|
5
|
+
## ToastBuilder.withDetails() method
|
|
6
|
+
|
|
7
|
+
Add details data to notifications
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withDetails(details: NotificationDataRow): ToastBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| details | [NotificationDataRow](./foundation-notifications.notificationdatarow.md) | NotificationDataRow |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[ToastBuilder](./foundation-notifications.toastbuilder.md)
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [ToastButton](./foundation-notifications.toastbutton.md) > [action](./foundation-notifications.toastbutton.action.md)
|
|
4
|
+
|
|
5
|
+
## ToastButton.action() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
action({ details, elementButton, elementToast, }: {
|
|
11
|
+
details: NotificationDataRow;
|
|
12
|
+
elementButton: HTMLElement;
|
|
13
|
+
elementToast: HTMLElement;
|
|
14
|
+
}): void;
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Type | Description |
|
|
20
|
+
| --- | --- | --- |
|
|
21
|
+
| { details, elementButton, elementToast, } | { details: [NotificationDataRow](./foundation-notifications.notificationdatarow.md)<!-- -->; elementButton: HTMLElement; elementToast: HTMLElement; } | |
|
|
22
|
+
|
|
23
|
+
**Returns:**
|
|
24
|
+
|
|
25
|
+
void
|
|
26
|
+
|
|
@@ -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) > [ToastButton](./foundation-notifications.toastbutton.md) > [appearance](./foundation-notifications.toastbutton.appearance.md)
|
|
4
|
+
|
|
5
|
+
## ToastButton.appearance property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
appearance?: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [ToastButton](./foundation-notifications.toastbutton.md) > [condition](./foundation-notifications.toastbutton.condition.md)
|
|
4
|
+
|
|
5
|
+
## ToastButton.condition() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
condition({ details }?: {
|
|
11
|
+
details: NotificationDataRow;
|
|
12
|
+
}): boolean;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| { details } | { details: [NotificationDataRow](./foundation-notifications.notificationdatarow.md)<!-- -->; } | _(Optional)_ |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
boolean
|
|
24
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [ToastButton](./foundation-notifications.toastbutton.md)
|
|
4
|
+
|
|
5
|
+
## ToastButton interface
|
|
6
|
+
|
|
7
|
+
Interface for ToastButton
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface ToastButton
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [appearance?](./foundation-notifications.toastbutton.appearance.md) | | string | _(Optional)_ |
|
|
20
|
+
| [placeholder?](./foundation-notifications.toastbutton.placeholder.md) | | string | _(Optional)_ |
|
|
21
|
+
|
|
22
|
+
## Methods
|
|
23
|
+
|
|
24
|
+
| Method | Description |
|
|
25
|
+
| --- | --- |
|
|
26
|
+
| [action({ details, elementButton, elementToast, })](./foundation-notifications.toastbutton.action.md) | |
|
|
27
|
+
| [condition({ details })](./foundation-notifications.toastbutton.condition.md) | |
|
|
28
|
+
|
|
@@ -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) > [ToastButton](./foundation-notifications.toastbutton.md) > [placeholder](./foundation-notifications.toastbutton.placeholder.md)
|
|
4
|
+
|
|
5
|
+
## ToastButton.placeholder property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
placeholder?: string;
|
|
11
|
+
```
|
package/docs/api-report.md
CHANGED
|
@@ -99,6 +99,35 @@ export class NotificationBuilder {
|
|
|
99
99
|
withToast(toast: Toast): NotificationBuilder;
|
|
100
100
|
}
|
|
101
101
|
|
|
102
|
+
// @public
|
|
103
|
+
export interface NotificationDataRow {
|
|
104
|
+
// (undocumented)
|
|
105
|
+
ALERT_ID: string;
|
|
106
|
+
// (undocumented)
|
|
107
|
+
CREATED_AT: number;
|
|
108
|
+
// (undocumented)
|
|
109
|
+
DETAILS: {
|
|
110
|
+
OPERATION: string;
|
|
111
|
+
ROW_REF: string;
|
|
112
|
+
};
|
|
113
|
+
// (undocumented)
|
|
114
|
+
EXPIRY?: null;
|
|
115
|
+
// (undocumented)
|
|
116
|
+
HEADER: string;
|
|
117
|
+
// (undocumented)
|
|
118
|
+
MESSAGE: string;
|
|
119
|
+
// (undocumented)
|
|
120
|
+
NOTIFY_SEVERITY: NotificationSeverity;
|
|
121
|
+
// (undocumented)
|
|
122
|
+
SENDER?: null;
|
|
123
|
+
// (undocumented)
|
|
124
|
+
TABLE_ENTITY_ID: string;
|
|
125
|
+
// (undocumented)
|
|
126
|
+
TOPIC: string;
|
|
127
|
+
// (undocumented)
|
|
128
|
+
USER_NAME: string;
|
|
129
|
+
}
|
|
130
|
+
|
|
102
131
|
// Warning: (ae-internal-missing-underscore) The name "NotificationElement" should be prefixed with an underscore because the declaration is marked as @internal
|
|
103
132
|
//
|
|
104
133
|
// @internal (undocumented)
|
|
@@ -112,6 +141,9 @@ export enum NotificationEvent {
|
|
|
112
141
|
NOTIFICATION_EVENT = "notification-event"
|
|
113
142
|
}
|
|
114
143
|
|
|
144
|
+
// @public
|
|
145
|
+
export type NotificationSeverity = 'Information' | 'Warning' | 'Serious' | 'Critical';
|
|
146
|
+
|
|
115
147
|
// @public
|
|
116
148
|
export interface NotificationStructure {
|
|
117
149
|
// (undocumented)
|
|
@@ -179,8 +211,12 @@ export interface Toast {
|
|
|
179
211
|
// (undocumented)
|
|
180
212
|
readonly autoClose?: boolean;
|
|
181
213
|
// (undocumented)
|
|
214
|
+
readonly buttons?: ToastButton[];
|
|
215
|
+
// (undocumented)
|
|
182
216
|
readonly closeTimeout?: number;
|
|
183
217
|
// (undocumented)
|
|
218
|
+
readonly details?: NotificationDataRow;
|
|
219
|
+
// (undocumented)
|
|
184
220
|
readonly position?: ToastPosition;
|
|
185
221
|
// (undocumented)
|
|
186
222
|
readonly type?: NotificationType;
|
|
@@ -190,11 +226,31 @@ export interface Toast {
|
|
|
190
226
|
export class ToastBuilder {
|
|
191
227
|
build(): Toast;
|
|
192
228
|
withAutoClose(autoClose: boolean): ToastBuilder;
|
|
229
|
+
withButtons(buttons: ToastButton[]): ToastBuilder;
|
|
193
230
|
withCloseTimeout(closeTimeout: number): ToastBuilder;
|
|
231
|
+
withDetails(details: NotificationDataRow): ToastBuilder;
|
|
194
232
|
withPosition(position: ToastPosition): ToastBuilder;
|
|
195
233
|
withType(type: NotificationType): ToastBuilder;
|
|
196
234
|
}
|
|
197
235
|
|
|
236
|
+
// @public
|
|
237
|
+
export interface ToastButton {
|
|
238
|
+
// (undocumented)
|
|
239
|
+
action({ details, elementButton, elementToast, }: {
|
|
240
|
+
details: NotificationDataRow;
|
|
241
|
+
elementButton: HTMLElement;
|
|
242
|
+
elementToast: HTMLElement;
|
|
243
|
+
}): void;
|
|
244
|
+
// (undocumented)
|
|
245
|
+
appearance?: string;
|
|
246
|
+
// (undocumented)
|
|
247
|
+
condition({ details }?: {
|
|
248
|
+
details: NotificationDataRow;
|
|
249
|
+
}): boolean;
|
|
250
|
+
// (undocumented)
|
|
251
|
+
placeholder?: string;
|
|
252
|
+
}
|
|
253
|
+
|
|
198
254
|
// @public
|
|
199
255
|
export type ToastPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
|
200
256
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/foundation-notifications",
|
|
3
3
|
"description": "Genesis Foundation UI Notifications Utils",
|
|
4
|
-
"version": "14.
|
|
4
|
+
"version": "14.53.1-alpha-afe9ebe.0",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -37,11 +37,11 @@
|
|
|
37
37
|
"test:debug": "genx test --debug"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
|
-
"@genesislcap/foundation-testing": "14.
|
|
41
|
-
"@genesislcap/genx": "14.
|
|
40
|
+
"@genesislcap/foundation-testing": "14.53.1-alpha-afe9ebe.0",
|
|
41
|
+
"@genesislcap/genx": "14.53.1-alpha-afe9ebe.0"
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@genesislcap/foundation-utils": "14.
|
|
44
|
+
"@genesislcap/foundation-utils": "14.53.1-alpha-afe9ebe.0",
|
|
45
45
|
"@microsoft/fast-element": "^1.7.0",
|
|
46
46
|
"tslib": "^2.3.1"
|
|
47
47
|
},
|
|
@@ -53,5 +53,5 @@
|
|
|
53
53
|
"publishConfig": {
|
|
54
54
|
"access": "public"
|
|
55
55
|
},
|
|
56
|
-
"gitHead": "
|
|
56
|
+
"gitHead": "26b12468723f058fc4630b5dafa2b6306117faf0"
|
|
57
57
|
}
|