@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
|
@@ -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) > [logLevel](./foundation-notifications.dialogstructure.loglevel.md)
|
|
4
|
+
|
|
5
|
+
## DialogStructure.logLevel property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly logLevel?: LogLevel;
|
|
11
|
+
```
|
|
@@ -0,0 +1,23 @@
|
|
|
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)
|
|
4
|
+
|
|
5
|
+
## DialogStructure interface
|
|
6
|
+
|
|
7
|
+
Interface for Dialog Structure
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface DialogStructure
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [body](./foundation-notifications.dialogstructure.body.md) | <code>readonly</code> | string | |
|
|
20
|
+
| [dialog?](./foundation-notifications.dialogstructure.dialog.md) | <code>readonly</code> | [Dialog](./foundation-notifications.dialog.md) | _(Optional)_ |
|
|
21
|
+
| [logLevel?](./foundation-notifications.dialogstructure.loglevel.md) | <code>readonly</code> | LogLevel | _(Optional)_ |
|
|
22
|
+
| [title](./foundation-notifications.dialogstructure.title.md) | <code>readonly</code> | string | |
|
|
23
|
+
|
|
@@ -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) > [title](./foundation-notifications.dialogstructure.title.md)
|
|
4
|
+
|
|
5
|
+
## DialogStructure.title property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly title: string;
|
|
11
|
+
```
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## getBannerBuilder variable
|
|
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
|
Get banner builder instance
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## getDialogBuilder variable
|
|
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
|
Returns an instance of DialogBuilder
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## getNotificationBuilder variable
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Returns a new NotificationBuilder instance
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## getSnackbarBuilder variable
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationSnackbar instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Get snackbar builder instance
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## getToastBuilder variable
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Get notification builder instance
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -24,15 +24,20 @@
|
|
|
24
24
|
|
|
25
25
|
| Interface | Description |
|
|
26
26
|
| --- | --- |
|
|
27
|
+
| [AlertStructure](./foundation-notifications.alertstructure.md) | Interface for Alert Structure |
|
|
27
28
|
| [Banner](./foundation-notifications.banner.md) | Interface for Banner configuration |
|
|
29
|
+
| [BannerStructure](./foundation-notifications.bannerstructure.md) | Interface for Banner Structure |
|
|
28
30
|
| [ConfirmingAction](./foundation-notifications.confirmingaction.md) | Interface for Confirming Action configuration |
|
|
29
31
|
| [Dialog](./foundation-notifications.dialog.md) | Interface for Dialog configuration |
|
|
32
|
+
| [DialogStructure](./foundation-notifications.dialogstructure.md) | Interface for Dialog Structure |
|
|
30
33
|
| [DismissingAction](./foundation-notifications.dismissingaction.md) | Interface for Dismissing Action configuration |
|
|
31
34
|
| [NotificationDataRow](./foundation-notifications.notificationdatarow.md) | Interface for notify data |
|
|
32
|
-
| [NotificationStructure](./foundation-notifications.notificationstructure.md) | Interface for Structure |
|
|
35
|
+
| [NotificationStructure](./foundation-notifications.notificationstructure.md) | Interface for Notification Structure |
|
|
33
36
|
| [Snackbar](./foundation-notifications.snackbar.md) | Interface for Snackbar configuration |
|
|
37
|
+
| [SnackbarStructure](./foundation-notifications.snackbarstructure.md) | Interface for Snackbar Structure |
|
|
34
38
|
| [Toast](./foundation-notifications.toast.md) | Interface for Toast configuration |
|
|
35
39
|
| [ToastButton](./foundation-notifications.toastbutton.md) | Interface for ToastButton |
|
|
40
|
+
| [ToastStructure](./foundation-notifications.toaststructure.md) | Interface for Toast Structure |
|
|
36
41
|
|
|
37
42
|
## Variables
|
|
38
43
|
|
|
@@ -48,7 +53,13 @@
|
|
|
48
53
|
| [getSnackbarBuilder](./foundation-notifications.getsnackbarbuilder.md) | Get snackbar builder instance |
|
|
49
54
|
| [getToastBuilder](./foundation-notifications.gettoastbuilder.md) | Get notification builder instance |
|
|
50
55
|
| [showBanner](./foundation-notifications.showbanner.md) | Shows the notificationStructure dialog |
|
|
56
|
+
| [showLoggerLogLevel](./foundation-notifications.showloggerloglevel.md) | Shows logger with log level from NotificationStructure object |
|
|
51
57
|
| [showNotification](./foundation-notifications.shownotification.md) | Shows the notificationStructure in the appropriate component |
|
|
58
|
+
| [showNotificationAlert](./foundation-notifications.shownotificationalert.md) | Shows the notification alert |
|
|
59
|
+
| [showNotificationBanner](./foundation-notifications.shownotificationbanner.md) | Shows the notification banner |
|
|
60
|
+
| [showNotificationDialog](./foundation-notifications.shownotificationdialog.md) | Shows the notification dialog |
|
|
61
|
+
| [showNotificationSnackbar](./foundation-notifications.shownotificationsnackbar.md) | Shows the notification snackbar |
|
|
62
|
+
| [showNotificationToast](./foundation-notifications.shownotificationtoast.md) | Shows the notification toast |
|
|
52
63
|
|
|
53
64
|
## Type Aliases
|
|
54
65
|
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## NotificationBuilder.build() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Build NotificationStructure
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## NotificationBuilder class
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
NotificationBuilder to build NotificationStructure
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## NotificationBuilder.withAlert() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add alert to notification
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## NotificationBuilder.withBanner() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add banner to notification
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## NotificationBuilder.withBody() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add body details to notification
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## NotificationBuilder.withCreatedAt() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add the creation date to notification
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## NotificationBuilder.withDialog() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add dialog to notification
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## NotificationBuilder.withLogLevel() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add log level to notification
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## NotificationBuilder.withSnackbar() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add snackbar to notification
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## NotificationBuilder.withTitle() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add title to notification
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## NotificationBuilder.withToast() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationBanner/Dialog/Snackbar/Toast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add toast to notification
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
## NotificationStructure interface
|
|
6
6
|
|
|
7
|
-
Interface for Structure
|
|
7
|
+
Interface for Notification Structure
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
@@ -20,5 +20,5 @@ export interface NotificationStructure
|
|
|
20
20
|
| [config?](./foundation-notifications.notificationstructure.config.md) | <code>readonly</code> | { readonly logLevel?: LogLevel; readonly alert?: boolean; readonly toast?: [Toast](./foundation-notifications.toast.md)<!-- -->; readonly banner?: [Banner](./foundation-notifications.banner.md)<!-- -->; readonly snackbar?: [Snackbar](./foundation-notifications.snackbar.md)<!-- -->; readonly dialog?: [Dialog](./foundation-notifications.dialog.md)<!-- -->; } | _(Optional)_ |
|
|
21
21
|
| [createdAt?](./foundation-notifications.notificationstructure.createdat.md) | <code>readonly</code> | Date | _(Optional)_ |
|
|
22
22
|
| [logLevel?](./foundation-notifications.notificationstructure.loglevel.md) | <code>readonly</code> | LogLevel | _(Optional)_ |
|
|
23
|
-
| [title](./foundation-notifications.notificationstructure.title.md) | <code>readonly</code> | string |
|
|
23
|
+
| [title?](./foundation-notifications.notificationstructure.title.md) | <code>readonly</code> | string | _(Optional)_ |
|
|
24
24
|
|
|
@@ -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) > [showLoggerLogLevel](./foundation-notifications.showloggerloglevel.md)
|
|
4
|
+
|
|
5
|
+
## showLoggerLogLevel variable
|
|
6
|
+
|
|
7
|
+
Shows logger with log level from NotificationStructure object
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
showLoggerLogLevel: (notificationStructure: NotificationStructure) => void
|
|
13
|
+
```
|
|
@@ -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) > [showNotificationAlert](./foundation-notifications.shownotificationalert.md)
|
|
4
|
+
|
|
5
|
+
## showNotificationAlert variable
|
|
6
|
+
|
|
7
|
+
Shows the notification alert
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
showNotificationAlert: (configuration: AlertStructure) => void
|
|
13
|
+
```
|
|
@@ -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) > [showNotificationBanner](./foundation-notifications.shownotificationbanner.md)
|
|
4
|
+
|
|
5
|
+
## showNotificationBanner variable
|
|
6
|
+
|
|
7
|
+
Shows the notification banner
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
showNotificationBanner: (configuration: BannerStructure, tagName: String, notificationBoundary?: HTMLElement) => void
|
|
13
|
+
```
|
|
@@ -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) > [showNotificationDialog](./foundation-notifications.shownotificationdialog.md)
|
|
4
|
+
|
|
5
|
+
## showNotificationDialog variable
|
|
6
|
+
|
|
7
|
+
Shows the notification dialog
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
showNotificationDialog: (configuration: DialogStructure, tagName: String) => void
|
|
13
|
+
```
|
|
@@ -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) > [showNotificationSnackbar](./foundation-notifications.shownotificationsnackbar.md)
|
|
4
|
+
|
|
5
|
+
## showNotificationSnackbar variable
|
|
6
|
+
|
|
7
|
+
Shows the notification snackbar
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
showNotificationSnackbar: (configuration: SnackbarStructure, tagName: String) => void
|
|
13
|
+
```
|
|
@@ -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) > [showNotificationToast](./foundation-notifications.shownotificationtoast.md)
|
|
4
|
+
|
|
5
|
+
## showNotificationToast variable
|
|
6
|
+
|
|
7
|
+
Shows the notification toast
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
showNotificationToast: (configuration: ToastStructure, tagName: String) => void
|
|
13
|
+
```
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## SnackbarBuilder.build() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationSnackbar instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Build snackbar
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## SnackbarBuilder class
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationSnackbar instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
SnackbarBuilder to build Snackbar
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## SnackbarBuilder.withConfirmingAction() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationSnackbar instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add confirming action to snackbar
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## SnackbarBuilder.withType() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationSnackbar instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
**Signature:**
|
|
8
13
|
|
|
9
14
|
```typescript
|
|
@@ -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) > [SnackbarStructure](./foundation-notifications.snackbarstructure.md) > [body](./foundation-notifications.snackbarstructure.body.md)
|
|
4
|
+
|
|
5
|
+
## SnackbarStructure.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) > [SnackbarStructure](./foundation-notifications.snackbarstructure.md) > [logLevel](./foundation-notifications.snackbarstructure.loglevel.md)
|
|
4
|
+
|
|
5
|
+
## SnackbarStructure.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) > [SnackbarStructure](./foundation-notifications.snackbarstructure.md)
|
|
4
|
+
|
|
5
|
+
## SnackbarStructure interface
|
|
6
|
+
|
|
7
|
+
Interface for Snackbar Structure
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface SnackbarStructure
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [body](./foundation-notifications.snackbarstructure.body.md) | <code>readonly</code> | string | |
|
|
20
|
+
| [logLevel?](./foundation-notifications.snackbarstructure.loglevel.md) | <code>readonly</code> | LogLevel | _(Optional)_ |
|
|
21
|
+
| [snackbar?](./foundation-notifications.snackbarstructure.snackbar.md) | <code>readonly</code> | [Snackbar](./foundation-notifications.snackbar.md) | _(Optional)_ |
|
|
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) > [SnackbarStructure](./foundation-notifications.snackbarstructure.md) > [snackbar](./foundation-notifications.snackbarstructure.snackbar.md)
|
|
4
|
+
|
|
5
|
+
## SnackbarStructure.snackbar property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly snackbar?: Snackbar;
|
|
11
|
+
```
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## ToastBuilder.build() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Build notification
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## ToastBuilder.withAutoClose() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add auto close to notification
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## ToastBuilder.withButtons() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add buttons to notifications
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## ToastBuilder.withCloseTimeout() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add close timeout to notification
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## ToastBuilder.withDetails() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add details data to notifications
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## ToastBuilder.withPosition() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add position to toast
|
|
8
13
|
|
|
9
14
|
**Signature:**
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## ToastBuilder.withType() method
|
|
6
6
|
|
|
7
|
+
> Warning: This API is now obsolete.
|
|
8
|
+
>
|
|
9
|
+
> Use showNotificationToast instead or provide a NotificationStructure object when used with an event for a notification listener.
|
|
10
|
+
>
|
|
11
|
+
|
|
7
12
|
Add type to notification, if the type is anything other than 'warning' or 'success' do not add it
|
|
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) > [ToastStructure](./foundation-notifications.toaststructure.md) > [body](./foundation-notifications.toaststructure.body.md)
|
|
4
|
+
|
|
5
|
+
## ToastStructure.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) > [ToastStructure](./foundation-notifications.toaststructure.md) > [createdAt](./foundation-notifications.toaststructure.createdat.md)
|
|
4
|
+
|
|
5
|
+
## ToastStructure.createdAt property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly createdAt?: Date;
|
|
11
|
+
```
|