@genesislcap/foundation-notifications 14.50.2-alpha-f13a8e3.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/README.md +66 -0
- package/dist/dts/banner/banner-builder.d.ts +35 -0
- package/dist/dts/banner/banner-builder.d.ts.map +1 -0
- package/dist/dts/banner/banner-launcher.d.ts +11 -0
- package/dist/dts/banner/banner-launcher.d.ts.map +1 -0
- package/dist/dts/banner/index.d.ts +3 -0
- package/dist/dts/banner/index.d.ts.map +1 -0
- package/dist/dts/dialog/dialog-builder.d.ts +35 -0
- package/dist/dts/dialog/dialog-builder.d.ts.map +1 -0
- package/dist/dts/dialog/dialog-launcher.d.ts +10 -0
- package/dist/dts/dialog/dialog-launcher.d.ts.map +1 -0
- package/dist/dts/dialog/index.d.ts +3 -0
- package/dist/dts/dialog/index.d.ts.map +1 -0
- package/dist/dts/index.d.ts +9 -0
- package/dist/dts/index.d.ts.map +1 -0
- package/dist/dts/index.federated.d.ts +1 -0
- package/dist/dts/index.federated.d.ts.map +1 -0
- package/dist/dts/logger.d.ts +2 -0
- package/dist/dts/logger.d.ts.map +1 -0
- package/dist/dts/notification-builder.d.ts +83 -0
- package/dist/dts/notification-builder.d.ts.map +1 -0
- package/dist/dts/notification-launcher.d.ts +11 -0
- package/dist/dts/notification-launcher.d.ts.map +1 -0
- package/dist/dts/notification-util.d.ts +32 -0
- package/dist/dts/notification-util.d.ts.map +1 -0
- package/dist/dts/snackbar/index.d.ts +3 -0
- package/dist/dts/snackbar/index.d.ts.map +1 -0
- package/dist/dts/snackbar/snackbar-builder.d.ts +34 -0
- package/dist/dts/snackbar/snackbar-builder.d.ts.map +1 -0
- package/dist/dts/snackbar/snackbar-launcher.d.ts +10 -0
- package/dist/dts/snackbar/snackbar-launcher.d.ts.map +1 -0
- package/dist/dts/toast/index.d.ts +3 -0
- package/dist/dts/toast/index.d.ts.map +1 -0
- package/dist/dts/toast/toast-builder.d.ts +49 -0
- package/dist/dts/toast/toast-builder.d.ts.map +1 -0
- package/dist/dts/toast/toast-launcher.d.ts +10 -0
- package/dist/dts/toast/toast-launcher.d.ts.map +1 -0
- package/dist/dts/tsdoc-metadata.json +11 -0
- package/dist/dts/types.d.ts +106 -0
- package/dist/dts/types.d.ts.map +1 -0
- package/dist/esm/banner/banner-builder.js +49 -0
- package/dist/esm/banner/banner-launcher.js +23 -0
- package/dist/esm/banner/index.js +2 -0
- package/dist/esm/dialog/dialog-builder.js +49 -0
- package/dist/esm/dialog/dialog-launcher.js +16 -0
- package/dist/esm/dialog/index.js +2 -0
- package/dist/esm/index.federated.js +1 -0
- package/dist/esm/index.js +8 -0
- package/dist/esm/logger.js +2 -0
- package/dist/esm/notification-builder.js +133 -0
- package/dist/esm/notification-launcher.js +36 -0
- package/dist/esm/notification-util.js +67 -0
- package/dist/esm/snackbar/index.js +2 -0
- package/dist/esm/snackbar/snackbar-builder.js +48 -0
- package/dist/esm/snackbar/snackbar-launcher.js +15 -0
- package/dist/esm/toast/index.js +2 -0
- package/dist/esm/toast/toast-builder.js +70 -0
- package/dist/esm/toast/toast-launcher.js +54 -0
- package/dist/esm/types.js +8 -0
- package/dist/foundation-notifications.api.json +2531 -0
- package/dist/foundation-notifications.d.ts +435 -0
- package/docs/.gitattributes +2 -0
- package/docs/api/foundation-notifications.banner.confirmingactions.md +11 -0
- package/docs/api/foundation-notifications.banner.dismissingaction.md +11 -0
- package/docs/api/foundation-notifications.banner.md +21 -0
- package/docs/api/foundation-notifications.bannerbuilder.build.md +19 -0
- package/docs/api/foundation-notifications.bannerbuilder.md +22 -0
- package/docs/api/foundation-notifications.bannerbuilder.withconfirmingaction.md +25 -0
- package/docs/api/foundation-notifications.bannerbuilder.withdismissingaction.md +25 -0
- package/docs/api/foundation-notifications.confirmingaction.action.md +11 -0
- package/docs/api/foundation-notifications.confirmingaction.label.md +11 -0
- package/docs/api/foundation-notifications.confirmingaction.md +21 -0
- package/docs/api/foundation-notifications.dialog.confirmingactions.md +11 -0
- package/docs/api/foundation-notifications.dialog.dismissingaction.md +11 -0
- package/docs/api/foundation-notifications.dialog.md +21 -0
- package/docs/api/foundation-notifications.dialogbuilder.build.md +19 -0
- package/docs/api/foundation-notifications.dialogbuilder.md +22 -0
- package/docs/api/foundation-notifications.dialogbuilder.withconfirmingaction.md +25 -0
- package/docs/api/foundation-notifications.dialogbuilder.withdismissingaction.md +25 -0
- package/docs/api/foundation-notifications.dismissingaction.action.md +11 -0
- package/docs/api/foundation-notifications.dismissingaction.label.md +11 -0
- package/docs/api/foundation-notifications.dismissingaction.md +21 -0
- package/docs/api/foundation-notifications.getbanneranchor.md +13 -0
- package/docs/api/foundation-notifications.getbannerbuilder.md +13 -0
- package/docs/api/foundation-notifications.getdialogbuilder.md +13 -0
- package/docs/api/foundation-notifications.getloglevel.md +13 -0
- package/docs/api/foundation-notifications.getnotificationbuilder.md +13 -0
- package/docs/api/foundation-notifications.getnotificationcontainer.md +13 -0
- package/docs/api/foundation-notifications.getnotificationdetails.md +13 -0
- package/docs/api/foundation-notifications.getsnackbarbuilder.md +13 -0
- package/docs/api/foundation-notifications.gettoastbuilder.md +13 -0
- package/docs/api/foundation-notifications.md +58 -0
- package/docs/api/foundation-notifications.notificationbuilder.build.md +18 -0
- package/docs/api/foundation-notifications.notificationbuilder.md +28 -0
- package/docs/api/foundation-notifications.notificationbuilder.withalert.md +25 -0
- package/docs/api/foundation-notifications.notificationbuilder.withbanner.md +25 -0
- package/docs/api/foundation-notifications.notificationbuilder.withbody.md +25 -0
- package/docs/api/foundation-notifications.notificationbuilder.withdialog.md +25 -0
- package/docs/api/foundation-notifications.notificationbuilder.withloglevel.md +25 -0
- package/docs/api/foundation-notifications.notificationbuilder.withsnackbar.md +25 -0
- package/docs/api/foundation-notifications.notificationbuilder.withtitle.md +25 -0
- package/docs/api/foundation-notifications.notificationbuilder.withtoast.md +25 -0
- package/docs/api/foundation-notifications.notificationevent.md +20 -0
- package/docs/api/foundation-notifications.notificationstructure.body.md +11 -0
- package/docs/api/foundation-notifications.notificationstructure.config.md +18 -0
- package/docs/api/foundation-notifications.notificationstructure.loglevel.md +11 -0
- package/docs/api/foundation-notifications.notificationstructure.md +23 -0
- package/docs/api/foundation-notifications.notificationstructure.title.md +11 -0
- package/docs/api/foundation-notifications.notificationtype.md +13 -0
- package/docs/api/foundation-notifications.showbanner.md +13 -0
- package/docs/api/foundation-notifications.shownotification.md +13 -0
- package/docs/api/foundation-notifications.snackbar.confirmingactions.md +11 -0
- package/docs/api/foundation-notifications.snackbar.md +21 -0
- package/docs/api/foundation-notifications.snackbar.type.md +11 -0
- package/docs/api/foundation-notifications.snackbarbuilder.build.md +19 -0
- package/docs/api/foundation-notifications.snackbarbuilder.md +22 -0
- package/docs/api/foundation-notifications.snackbarbuilder.withconfirmingaction.md +25 -0
- package/docs/api/foundation-notifications.snackbarbuilder.withtype.md +23 -0
- package/docs/api/foundation-notifications.snackbartype.md +13 -0
- package/docs/api/foundation-notifications.toast.autoclose.md +11 -0
- package/docs/api/foundation-notifications.toast.closetimeout.md +11 -0
- package/docs/api/foundation-notifications.toast.md +23 -0
- package/docs/api/foundation-notifications.toast.position.md +11 -0
- package/docs/api/foundation-notifications.toast.type.md +11 -0
- package/docs/api/foundation-notifications.toastbuilder.build.md +19 -0
- package/docs/api/foundation-notifications.toastbuilder.md +23 -0
- package/docs/api/foundation-notifications.toastbuilder.withautoclose.md +25 -0
- package/docs/api/foundation-notifications.toastbuilder.withclosetimeout.md +25 -0
- package/docs/api/foundation-notifications.toastbuilder.withposition.md +25 -0
- package/docs/api/foundation-notifications.toastbuilder.withtype.md +25 -0
- package/docs/api/foundation-notifications.toastposition.md +13 -0
- package/docs/api/index.md +12 -0
- package/docs/api-report.md +203 -0
- package/license.txt +46 -0
- package/package.json +57 -0
|
@@ -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) > [DialogBuilder](./foundation-notifications.dialogbuilder.md)
|
|
4
|
+
|
|
5
|
+
## DialogBuilder class
|
|
6
|
+
|
|
7
|
+
DialogBuilder class
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare class DialogBuilder
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Methods
|
|
16
|
+
|
|
17
|
+
| Method | Modifiers | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| [build()](./foundation-notifications.dialogbuilder.build.md) | | Build Dialog |
|
|
20
|
+
| [withConfirmingAction(confirmingAction)](./foundation-notifications.dialogbuilder.withconfirmingaction.md) | | Add confirming action to Dialog |
|
|
21
|
+
| [withDismissingAction(dismissingAction)](./foundation-notifications.dialogbuilder.withdismissingaction.md) | | Add dismissing action to Dialog |
|
|
22
|
+
|
|
@@ -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) > [DialogBuilder](./foundation-notifications.dialogbuilder.md) > [withConfirmingAction](./foundation-notifications.dialogbuilder.withconfirmingaction.md)
|
|
4
|
+
|
|
5
|
+
## DialogBuilder.withConfirmingAction() method
|
|
6
|
+
|
|
7
|
+
Add confirming action to Dialog
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withConfirmingAction(confirmingAction: ConfirmingAction): DialogBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| confirmingAction | [ConfirmingAction](./foundation-notifications.confirmingaction.md) | [ConfirmingAction](./foundation-notifications.confirmingaction.md) |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[DialogBuilder](./foundation-notifications.dialogbuilder.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) > [DialogBuilder](./foundation-notifications.dialogbuilder.md) > [withDismissingAction](./foundation-notifications.dialogbuilder.withdismissingaction.md)
|
|
4
|
+
|
|
5
|
+
## DialogBuilder.withDismissingAction() method
|
|
6
|
+
|
|
7
|
+
Add dismissing action to Dialog
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withDismissingAction(dismissingAction: DismissingAction): DialogBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| dismissingAction | [DismissingAction](./foundation-notifications.dismissingaction.md) | [DismissingAction](./foundation-notifications.dismissingaction.md) |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[DialogBuilder](./foundation-notifications.dialogbuilder.md)
|
|
24
|
+
|
|
25
|
+
|
|
@@ -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) > [DismissingAction](./foundation-notifications.dismissingaction.md) > [action](./foundation-notifications.dismissingaction.action.md)
|
|
4
|
+
|
|
5
|
+
## DismissingAction.action property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly action?: Function;
|
|
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) > [DismissingAction](./foundation-notifications.dismissingaction.md) > [label](./foundation-notifications.dismissingaction.label.md)
|
|
4
|
+
|
|
5
|
+
## DismissingAction.label property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly label: String;
|
|
11
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [DismissingAction](./foundation-notifications.dismissingaction.md)
|
|
4
|
+
|
|
5
|
+
## DismissingAction interface
|
|
6
|
+
|
|
7
|
+
Interface for Dismissing Action configuration
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface DismissingAction
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [action?](./foundation-notifications.dismissingaction.action.md) | <code>readonly</code> | Function | _(Optional)_ |
|
|
20
|
+
| [label](./foundation-notifications.dismissingaction.label.md) | <code>readonly</code> | String | |
|
|
21
|
+
|
|
@@ -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) > [getBannerAnchor](./foundation-notifications.getbanneranchor.md)
|
|
4
|
+
|
|
5
|
+
## getBannerAnchor variable
|
|
6
|
+
|
|
7
|
+
Get the banner anchor to attach the banner to
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getBannerAnchor: (element: any) => HTMLElement | null
|
|
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) > [getBannerBuilder](./foundation-notifications.getbannerbuilder.md)
|
|
4
|
+
|
|
5
|
+
## getBannerBuilder variable
|
|
6
|
+
|
|
7
|
+
Get banner builder instance
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getBannerBuilder: () => BannerBuilder
|
|
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) > [getDialogBuilder](./foundation-notifications.getdialogbuilder.md)
|
|
4
|
+
|
|
5
|
+
## getDialogBuilder variable
|
|
6
|
+
|
|
7
|
+
Returns an instance of DialogBuilder
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getDialogBuilder: () => DialogBuilder
|
|
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) > [getLoglevel](./foundation-notifications.getloglevel.md)
|
|
4
|
+
|
|
5
|
+
## getLoglevel variable
|
|
6
|
+
|
|
7
|
+
Retrieves the log level from an NotificationStructure object
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getLoglevel: (details: NotificationStructure) => LogLevel
|
|
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) > [getNotificationBuilder](./foundation-notifications.getnotificationbuilder.md)
|
|
4
|
+
|
|
5
|
+
## getNotificationBuilder variable
|
|
6
|
+
|
|
7
|
+
Returns a new NotificationBuilder instance
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getNotificationBuilder: () => NotificationBuilder
|
|
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) > [getNotificationContainer](./foundation-notifications.getnotificationcontainer.md)
|
|
4
|
+
|
|
5
|
+
## getNotificationContainer variable
|
|
6
|
+
|
|
7
|
+
Get/Create the error container in the DOM
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getNotificationContainer: (id: string, tagName: String) => HTMLElement
|
|
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) > [getNotificationDetails](./foundation-notifications.getnotificationdetails.md)
|
|
4
|
+
|
|
5
|
+
## getNotificationDetails variable
|
|
6
|
+
|
|
7
|
+
Retrieves the notification details from an NotificationStructure object
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getNotificationDetails: (details: NotificationStructure) => string
|
|
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) > [getSnackbarBuilder](./foundation-notifications.getsnackbarbuilder.md)
|
|
4
|
+
|
|
5
|
+
## getSnackbarBuilder variable
|
|
6
|
+
|
|
7
|
+
Get snackbar builder instance
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getSnackbarBuilder: () => SnackbarBuilder
|
|
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) > [getToastBuilder](./foundation-notifications.gettoastbuilder.md)
|
|
4
|
+
|
|
5
|
+
## getToastBuilder variable
|
|
6
|
+
|
|
7
|
+
Get notification builder instance
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getToastBuilder: () => ToastBuilder
|
|
13
|
+
```
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md)
|
|
4
|
+
|
|
5
|
+
## foundation-notifications package
|
|
6
|
+
|
|
7
|
+
## Classes
|
|
8
|
+
|
|
9
|
+
| Class | Description |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| [BannerBuilder](./foundation-notifications.bannerbuilder.md) | BannerBuilder |
|
|
12
|
+
| [DialogBuilder](./foundation-notifications.dialogbuilder.md) | DialogBuilder class |
|
|
13
|
+
| [NotificationBuilder](./foundation-notifications.notificationbuilder.md) | NotificationBuilder to build NotificationStructure |
|
|
14
|
+
| [SnackbarBuilder](./foundation-notifications.snackbarbuilder.md) | SnackbarBuilder to build Snackbar |
|
|
15
|
+
| [ToastBuilder](./foundation-notifications.toastbuilder.md) | |
|
|
16
|
+
|
|
17
|
+
## Enumerations
|
|
18
|
+
|
|
19
|
+
| Enumeration | Description |
|
|
20
|
+
| --- | --- |
|
|
21
|
+
| [NotificationEvent](./foundation-notifications.notificationevent.md) | enum for different types of notification events |
|
|
22
|
+
|
|
23
|
+
## Interfaces
|
|
24
|
+
|
|
25
|
+
| Interface | Description |
|
|
26
|
+
| --- | --- |
|
|
27
|
+
| [Banner](./foundation-notifications.banner.md) | Interface for Banner configuration |
|
|
28
|
+
| [ConfirmingAction](./foundation-notifications.confirmingaction.md) | Interface for Confirming Action configuration |
|
|
29
|
+
| [Dialog](./foundation-notifications.dialog.md) | Interface for Dialog configuration |
|
|
30
|
+
| [DismissingAction](./foundation-notifications.dismissingaction.md) | Interface for Dismissing Action configuration |
|
|
31
|
+
| [NotificationStructure](./foundation-notifications.notificationstructure.md) | Interface for Structure |
|
|
32
|
+
| [Snackbar](./foundation-notifications.snackbar.md) | Interface for Snackbar configuration |
|
|
33
|
+
| [Toast](./foundation-notifications.toast.md) | Interface for Toast configuration |
|
|
34
|
+
|
|
35
|
+
## Variables
|
|
36
|
+
|
|
37
|
+
| Variable | Description |
|
|
38
|
+
| --- | --- |
|
|
39
|
+
| [getBannerAnchor](./foundation-notifications.getbanneranchor.md) | Get the banner anchor to attach the banner to |
|
|
40
|
+
| [getBannerBuilder](./foundation-notifications.getbannerbuilder.md) | Get banner builder instance |
|
|
41
|
+
| [getDialogBuilder](./foundation-notifications.getdialogbuilder.md) | Returns an instance of DialogBuilder |
|
|
42
|
+
| [getLoglevel](./foundation-notifications.getloglevel.md) | Retrieves the log level from an NotificationStructure object |
|
|
43
|
+
| [getNotificationBuilder](./foundation-notifications.getnotificationbuilder.md) | Returns a new NotificationBuilder instance |
|
|
44
|
+
| [getNotificationContainer](./foundation-notifications.getnotificationcontainer.md) | Get/Create the error container in the DOM |
|
|
45
|
+
| [getNotificationDetails](./foundation-notifications.getnotificationdetails.md) | Retrieves the notification details from an NotificationStructure object |
|
|
46
|
+
| [getSnackbarBuilder](./foundation-notifications.getsnackbarbuilder.md) | Get snackbar builder instance |
|
|
47
|
+
| [getToastBuilder](./foundation-notifications.gettoastbuilder.md) | Get notification builder instance |
|
|
48
|
+
| [showBanner](./foundation-notifications.showbanner.md) | Shows the notificationStructure dialog |
|
|
49
|
+
| [showNotification](./foundation-notifications.shownotification.md) | Shows the notificationStructure in the appropriate component |
|
|
50
|
+
|
|
51
|
+
## Type Aliases
|
|
52
|
+
|
|
53
|
+
| Type Alias | Description |
|
|
54
|
+
| --- | --- |
|
|
55
|
+
| [NotificationType](./foundation-notifications.notificationtype.md) | type for notification |
|
|
56
|
+
| [SnackbarType](./foundation-notifications.snackbartype.md) | type for snackbar type |
|
|
57
|
+
| [ToastPosition](./foundation-notifications.toastposition.md) | type for notification position |
|
|
58
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [NotificationBuilder](./foundation-notifications.notificationbuilder.md) > [build](./foundation-notifications.notificationbuilder.build.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.build() method
|
|
6
|
+
|
|
7
|
+
Build NotificationStructure
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
build(): NotificationStructure;
|
|
13
|
+
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
[NotificationStructure](./foundation-notifications.notificationstructure.md)
|
|
17
|
+
|
|
18
|
+
|
|
@@ -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) > [NotificationBuilder](./foundation-notifications.notificationbuilder.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder class
|
|
6
|
+
|
|
7
|
+
NotificationBuilder to build NotificationStructure
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare class NotificationBuilder
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Methods
|
|
16
|
+
|
|
17
|
+
| Method | Modifiers | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| [build()](./foundation-notifications.notificationbuilder.build.md) | | Build NotificationStructure |
|
|
20
|
+
| [withAlert(alert)](./foundation-notifications.notificationbuilder.withalert.md) | | Add alert to notification |
|
|
21
|
+
| [withBanner(banner)](./foundation-notifications.notificationbuilder.withbanner.md) | | Add banner to notification |
|
|
22
|
+
| [withBody(body)](./foundation-notifications.notificationbuilder.withbody.md) | | Add body details to notification |
|
|
23
|
+
| [withDialog(dialog)](./foundation-notifications.notificationbuilder.withdialog.md) | | Add dialog to notification |
|
|
24
|
+
| [withLogLevel(logLevel)](./foundation-notifications.notificationbuilder.withloglevel.md) | | Add log level to notification |
|
|
25
|
+
| [withSnackbar(snackbar)](./foundation-notifications.notificationbuilder.withsnackbar.md) | | Add snackbar to notification |
|
|
26
|
+
| [withTitle(title)](./foundation-notifications.notificationbuilder.withtitle.md) | | Add title to notification |
|
|
27
|
+
| [withToast(toast)](./foundation-notifications.notificationbuilder.withtoast.md) | | Add toast to notification |
|
|
28
|
+
|
|
@@ -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) > [NotificationBuilder](./foundation-notifications.notificationbuilder.md) > [withAlert](./foundation-notifications.notificationbuilder.withalert.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.withAlert() method
|
|
6
|
+
|
|
7
|
+
Add alert to notification
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withAlert(alert: boolean): NotificationBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| alert | boolean | boolean |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[NotificationBuilder](./foundation-notifications.notificationbuilder.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) > [NotificationBuilder](./foundation-notifications.notificationbuilder.md) > [withBanner](./foundation-notifications.notificationbuilder.withbanner.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.withBanner() method
|
|
6
|
+
|
|
7
|
+
Add banner to notification
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withBanner(banner: Banner): NotificationBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| banner | [Banner](./foundation-notifications.banner.md) | [Banner](./foundation-notifications.banner.md) |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[NotificationBuilder](./foundation-notifications.notificationbuilder.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) > [NotificationBuilder](./foundation-notifications.notificationbuilder.md) > [withBody](./foundation-notifications.notificationbuilder.withbody.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.withBody() method
|
|
6
|
+
|
|
7
|
+
Add body details to notification
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withBody(body: string): NotificationBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| body | string | string |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[NotificationBuilder](./foundation-notifications.notificationbuilder.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) > [NotificationBuilder](./foundation-notifications.notificationbuilder.md) > [withDialog](./foundation-notifications.notificationbuilder.withdialog.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.withDialog() method
|
|
6
|
+
|
|
7
|
+
Add dialog to notification
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withDialog(dialog: Dialog): NotificationBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| dialog | [Dialog](./foundation-notifications.dialog.md) | [Dialog](./foundation-notifications.dialog.md) |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[NotificationBuilder](./foundation-notifications.notificationbuilder.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) > [NotificationBuilder](./foundation-notifications.notificationbuilder.md) > [withLogLevel](./foundation-notifications.notificationbuilder.withloglevel.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.withLogLevel() method
|
|
6
|
+
|
|
7
|
+
Add log level to notification
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withLogLevel(logLevel: LogLevel): NotificationBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| logLevel | LogLevel | |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[NotificationBuilder](./foundation-notifications.notificationbuilder.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) > [NotificationBuilder](./foundation-notifications.notificationbuilder.md) > [withSnackbar](./foundation-notifications.notificationbuilder.withsnackbar.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.withSnackbar() method
|
|
6
|
+
|
|
7
|
+
Add snackbar to notification
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withSnackbar(snackbar: Snackbar): NotificationBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| snackbar | [Snackbar](./foundation-notifications.snackbar.md) | [Snackbar](./foundation-notifications.snackbar.md) |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[NotificationBuilder](./foundation-notifications.notificationbuilder.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) > [NotificationBuilder](./foundation-notifications.notificationbuilder.md) > [withTitle](./foundation-notifications.notificationbuilder.withtitle.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.withTitle() method
|
|
6
|
+
|
|
7
|
+
Add title to notification
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withTitle(title: string): NotificationBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| title | string | string |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[NotificationBuilder](./foundation-notifications.notificationbuilder.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) > [NotificationBuilder](./foundation-notifications.notificationbuilder.md) > [withToast](./foundation-notifications.notificationbuilder.withtoast.md)
|
|
4
|
+
|
|
5
|
+
## NotificationBuilder.withToast() method
|
|
6
|
+
|
|
7
|
+
Add toast to notification
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
withToast(toast: Toast): NotificationBuilder;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| toast | [Toast](./foundation-notifications.toast.md) | |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
[NotificationBuilder](./foundation-notifications.notificationbuilder.md)
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [NotificationEvent](./foundation-notifications.notificationevent.md)
|
|
4
|
+
|
|
5
|
+
## NotificationEvent enum
|
|
6
|
+
|
|
7
|
+
enum for different types of notification events
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare enum NotificationEvent
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Enumeration Members
|
|
16
|
+
|
|
17
|
+
| Member | Value | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| NOTIFICATION\_EVENT | <code>"notification-event"</code> | |
|
|
20
|
+
|
|
@@ -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) > [NotificationStructure](./foundation-notifications.notificationstructure.md) > [body](./foundation-notifications.notificationstructure.body.md)
|
|
4
|
+
|
|
5
|
+
## NotificationStructure.body property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly body: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [NotificationStructure](./foundation-notifications.notificationstructure.md) > [config](./foundation-notifications.notificationstructure.config.md)
|
|
4
|
+
|
|
5
|
+
## NotificationStructure.config property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly config?: {
|
|
11
|
+
readonly logLevel?: LogLevel;
|
|
12
|
+
readonly alert?: boolean;
|
|
13
|
+
readonly toast?: Toast;
|
|
14
|
+
readonly banner?: Banner;
|
|
15
|
+
readonly snackbar?: Snackbar;
|
|
16
|
+
readonly dialog?: Dialog;
|
|
17
|
+
};
|
|
18
|
+
```
|
|
@@ -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) > [NotificationStructure](./foundation-notifications.notificationstructure.md) > [logLevel](./foundation-notifications.notificationstructure.loglevel.md)
|
|
4
|
+
|
|
5
|
+
## NotificationStructure.logLevel property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly logLevel?: LogLevel;
|
|
11
|
+
```
|