@genesislcap/foundation-notifications 14.408.0 → 14.409.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 +6 -121
- package/package.json +12 -12
- package/docs/api/foundation-notifications.alertstructure.body.md +0 -11
- package/docs/api/foundation-notifications.alertstructure.loglevel.md +0 -11
- package/docs/api/foundation-notifications.alertstructure.md +0 -98
- package/docs/api/foundation-notifications.alertstructure.title.md +0 -11
- package/docs/api/foundation-notifications.banner.confirmingactions.md +0 -11
- package/docs/api/foundation-notifications.banner.dismissingaction.md +0 -11
- package/docs/api/foundation-notifications.banner.md +0 -81
- package/docs/api/foundation-notifications.bannerbuilder.build.md +0 -24
- package/docs/api/foundation-notifications.bannerbuilder.md +0 -81
- package/docs/api/foundation-notifications.bannerbuilder.withconfirmingaction.md +0 -60
- package/docs/api/foundation-notifications.bannerbuilder.withdismissingaction.md +0 -60
- package/docs/api/foundation-notifications.bannerstructure.banner.md +0 -11
- package/docs/api/foundation-notifications.bannerstructure.body.md +0 -11
- package/docs/api/foundation-notifications.bannerstructure.loglevel.md +0 -11
- package/docs/api/foundation-notifications.bannerstructure.md +0 -100
- package/docs/api/foundation-notifications.configurenotifications.md +0 -52
- package/docs/api/foundation-notifications.confirmingaction.action.md +0 -11
- package/docs/api/foundation-notifications.confirmingaction.label.md +0 -11
- package/docs/api/foundation-notifications.confirmingaction.md +0 -77
- package/docs/api/foundation-notifications.dialog.confirmingactions.md +0 -11
- package/docs/api/foundation-notifications.dialog.dismissingaction.md +0 -11
- package/docs/api/foundation-notifications.dialog.md +0 -81
- package/docs/api/foundation-notifications.dialogbuilder.build.md +0 -24
- package/docs/api/foundation-notifications.dialogbuilder.md +0 -81
- package/docs/api/foundation-notifications.dialogbuilder.withconfirmingaction.md +0 -60
- package/docs/api/foundation-notifications.dialogbuilder.withdismissingaction.md +0 -60
- package/docs/api/foundation-notifications.dialogstructure.body.md +0 -11
- package/docs/api/foundation-notifications.dialogstructure.dialog.md +0 -11
- package/docs/api/foundation-notifications.dialogstructure.loglevel.md +0 -11
- package/docs/api/foundation-notifications.dialogstructure.md +0 -119
- package/docs/api/foundation-notifications.dialogstructure.title.md +0 -11
- package/docs/api/foundation-notifications.dismissingaction.action.md +0 -11
- package/docs/api/foundation-notifications.dismissingaction.label.md +0 -11
- package/docs/api/foundation-notifications.dismissingaction.md +0 -79
- package/docs/api/foundation-notifications.getbanneranchor.md +0 -55
- package/docs/api/foundation-notifications.getbannerbuilder.md +0 -22
- package/docs/api/foundation-notifications.getdialogbuilder.md +0 -22
- package/docs/api/foundation-notifications.getloglevel.md +0 -56
- package/docs/api/foundation-notifications.getnotificationbuilder.md +0 -22
- package/docs/api/foundation-notifications.getnotificationcontainer.md +0 -71
- package/docs/api/foundation-notifications.getnotificationdetails.md +0 -56
- package/docs/api/foundation-notifications.getsnackbarbuilder.md +0 -22
- package/docs/api/foundation-notifications.gettoastbuilder.md +0 -22
- package/docs/api/foundation-notifications.md +0 -570
- package/docs/api/foundation-notifications.notificationbuilder.build.md +0 -23
- package/docs/api/foundation-notifications.notificationbuilder.md +0 -179
- package/docs/api/foundation-notifications.notificationbuilder.withalert.md +0 -60
- package/docs/api/foundation-notifications.notificationbuilder.withbanner.md +0 -60
- package/docs/api/foundation-notifications.notificationbuilder.withbody.md +0 -60
- package/docs/api/foundation-notifications.notificationbuilder.withcreatedat.md +0 -60
- package/docs/api/foundation-notifications.notificationbuilder.withdialog.md +0 -60
- package/docs/api/foundation-notifications.notificationbuilder.withloglevel.md +0 -58
- package/docs/api/foundation-notifications.notificationbuilder.withsnackbar.md +0 -60
- package/docs/api/foundation-notifications.notificationbuilder.withtitle.md +0 -60
- package/docs/api/foundation-notifications.notificationbuilder.withtoast.md +0 -58
- package/docs/api/foundation-notifications.notificationdatarow.alert_id.md +0 -11
- package/docs/api/foundation-notifications.notificationdatarow.created_at.md +0 -11
- package/docs/api/foundation-notifications.notificationdatarow.details.md +0 -14
- package/docs/api/foundation-notifications.notificationdatarow.expiry.md +0 -11
- package/docs/api/foundation-notifications.notificationdatarow.header.md +0 -11
- package/docs/api/foundation-notifications.notificationdatarow.md +0 -230
- package/docs/api/foundation-notifications.notificationdatarow.message.md +0 -11
- package/docs/api/foundation-notifications.notificationdatarow.notify_severity.md +0 -11
- package/docs/api/foundation-notifications.notificationdatarow.sender.md +0 -11
- package/docs/api/foundation-notifications.notificationdatarow.table_entity_id.md +0 -11
- package/docs/api/foundation-notifications.notificationdatarow.topic.md +0 -11
- package/docs/api/foundation-notifications.notificationdatarow.user_name.md +0 -11
- package/docs/api/foundation-notifications.notificationevent.md +0 -48
- package/docs/api/foundation-notifications.notificationseverity.md +0 -13
- package/docs/api/foundation-notifications.notificationstructure.body.md +0 -11
- package/docs/api/foundation-notifications.notificationstructure.config.md +0 -18
- package/docs/api/foundation-notifications.notificationstructure.createdat.md +0 -11
- package/docs/api/foundation-notifications.notificationstructure.iconname.md +0 -11
- package/docs/api/foundation-notifications.notificationstructure.loglevel.md +0 -11
- package/docs/api/foundation-notifications.notificationstructure.md +0 -163
- package/docs/api/foundation-notifications.notificationstructure.title.md +0 -11
- package/docs/api/foundation-notifications.notificationtype.md +0 -13
- package/docs/api/foundation-notifications.notifycontainer.allowcloseall.md +0 -11
- package/docs/api/foundation-notifications.notifycontainer.allowmanualcollapse.md +0 -11
- package/docs/api/foundation-notifications.notifycontainer.designsystemprefix.md +0 -11
- package/docs/api/foundation-notifications.notifycontainer.disconnectedcallback.md +0 -15
- package/docs/api/foundation-notifications.notifycontainer.md +0 -244
- package/docs/api/foundation-notifications.notifycontainer.notificationinterval.md +0 -11
- package/docs/api/foundation-notifications.notifycontainer.position.md +0 -11
- package/docs/api/foundation-notifications.notifycontainer.showcount.md +0 -11
- package/docs/api/foundation-notifications.notifycontainer.slottednodes.md +0 -11
- package/docs/api/foundation-notifications.notifycontainer.sortfn.md +0 -11
- package/docs/api/foundation-notifications.notifycontainer.stackcollapsed.md +0 -11
- package/docs/api/foundation-notifications.notifycontainer.stackthreshold.md +0 -11
- package/docs/api/foundation-notifications.notifycontainerconfig.allowcloseall.md +0 -13
- package/docs/api/foundation-notifications.notifycontainerconfig.allowmanualcollapse.md +0 -13
- package/docs/api/foundation-notifications.notifycontainerconfig.designsystemprefix.md +0 -13
- package/docs/api/foundation-notifications.notifycontainerconfig.md +0 -191
- package/docs/api/foundation-notifications.notifycontainerconfig.notificationinterval.md +0 -15
- package/docs/api/foundation-notifications.notifycontainerconfig.position.md +0 -13
- package/docs/api/foundation-notifications.notifycontainerconfig.showcount.md +0 -13
- package/docs/api/foundation-notifications.notifycontainerconfig.sortfn.md +0 -13
- package/docs/api/foundation-notifications.notifycontainerconfig.stackthreshold.md +0 -13
- package/docs/api/foundation-notifications.showbanner.md +0 -87
- package/docs/api/foundation-notifications.showloggerloglevel.md +0 -54
- package/docs/api/foundation-notifications.shownotification.md +0 -87
- package/docs/api/foundation-notifications.shownotificationalert.md +0 -52
- package/docs/api/foundation-notifications.shownotificationbanner.md +0 -82
- package/docs/api/foundation-notifications.shownotificationdialog.md +0 -82
- package/docs/api/foundation-notifications.shownotificationsnackbar.md +0 -66
- package/docs/api/foundation-notifications.shownotificationtoast.md +0 -82
- package/docs/api/foundation-notifications.snackbar.autoclose.md +0 -11
- package/docs/api/foundation-notifications.snackbar.closetimeout.md +0 -11
- package/docs/api/foundation-notifications.snackbar.confirmingactions.md +0 -11
- package/docs/api/foundation-notifications.snackbar.md +0 -123
- package/docs/api/foundation-notifications.snackbar.type.md +0 -11
- package/docs/api/foundation-notifications.snackbarbuilder.build.md +0 -24
- package/docs/api/foundation-notifications.snackbarbuilder.md +0 -79
- package/docs/api/foundation-notifications.snackbarbuilder.withconfirmingaction.md +0 -60
- package/docs/api/foundation-notifications.snackbarbuilder.withtype.md +0 -58
- package/docs/api/foundation-notifications.snackbarstructure.body.md +0 -11
- package/docs/api/foundation-notifications.snackbarstructure.loglevel.md +0 -11
- package/docs/api/foundation-notifications.snackbarstructure.md +0 -100
- package/docs/api/foundation-notifications.snackbarstructure.snackbar.md +0 -11
- package/docs/api/foundation-notifications.snackbartype.md +0 -13
- package/docs/api/foundation-notifications.sortnotificationbyseverity.md +0 -73
- package/docs/api/foundation-notifications.toast.autoclose.md +0 -11
- package/docs/api/foundation-notifications.toast.buttons.md +0 -11
- package/docs/api/foundation-notifications.toast.closetimeout.md +0 -11
- package/docs/api/foundation-notifications.toast.details.md +0 -11
- package/docs/api/foundation-notifications.toast.md +0 -165
- package/docs/api/foundation-notifications.toast.position.md +0 -11
- package/docs/api/foundation-notifications.toast.type.md +0 -11
- package/docs/api/foundation-notifications.toastbuilder.build.md +0 -24
- package/docs/api/foundation-notifications.toastbuilder.md +0 -135
- package/docs/api/foundation-notifications.toastbuilder.withautoclose.md +0 -60
- package/docs/api/foundation-notifications.toastbuilder.withbuttons.md +0 -60
- package/docs/api/foundation-notifications.toastbuilder.withclosetimeout.md +0 -60
- package/docs/api/foundation-notifications.toastbuilder.withdetails.md +0 -60
- package/docs/api/foundation-notifications.toastbuilder.withposition.md +0 -60
- package/docs/api/foundation-notifications.toastbuilder.withtype.md +0 -60
- package/docs/api/foundation-notifications.toastbutton.action.md +0 -54
- package/docs/api/foundation-notifications.toastbutton.appearance.md +0 -11
- package/docs/api/foundation-notifications.toastbutton.condition.md +0 -54
- package/docs/api/foundation-notifications.toastbutton.md +0 -110
- package/docs/api/foundation-notifications.toastbutton.placeholder.md +0 -11
- package/docs/api/foundation-notifications.toastposition.md +0 -13
- package/docs/api/foundation-notifications.toaststructure.body.md +0 -11
- package/docs/api/foundation-notifications.toaststructure.createdat.md +0 -11
- package/docs/api/foundation-notifications.toaststructure.iconname.md +0 -11
- package/docs/api/foundation-notifications.toaststructure.loglevel.md +0 -11
- package/docs/api/foundation-notifications.toaststructure.md +0 -161
- package/docs/api/foundation-notifications.toaststructure.title.md +0 -11
- package/docs/api/foundation-notifications.toaststructure.toast.md +0 -11
- package/docs/api/index.md +0 -30
- package/docs/api-report.md.api.md +0 -428
package/README.md
CHANGED
|
@@ -1,140 +1,25 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @genesislcap/foundation-notifications
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[](https://www.typescriptlang.org/)
|
|
3
|
+
Documentation for this package is published on the Genesis docs site:
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
* The App need to create notification-listener at top of the component tree.
|
|
9
|
-
|
|
10
|
-
* Any child under notification-listener component can dispatch custom NotificationEvent event
|
|
11
|
-
|
|
12
|
-
* The custom event is handled by notification-listener component and based on event payload
|
|
13
|
-
it displays notification component according to payload
|
|
14
|
-
|
|
15
|
-
### Current Implementation support following Notification Components
|
|
16
|
-
|
|
17
|
-
* Alert
|
|
18
|
-
* Toast
|
|
19
|
-
* Banner
|
|
20
|
-
* Snack bar
|
|
21
|
-
* Dialog
|
|
22
|
-
|
|
23
|
-
### Creating and dispatching Notification Events
|
|
24
|
-
|
|
25
|
-
Creating and dispatching Notification event with payload to show in Toast component
|
|
26
|
-
|
|
27
|
-
```javascript
|
|
28
|
-
$emit(
|
|
29
|
-
NotificationEvent.NOTIFICATION_EVENT,
|
|
30
|
-
{
|
|
31
|
-
title: 'Important message',
|
|
32
|
-
body: 'Lorem ipsum',
|
|
33
|
-
config: {
|
|
34
|
-
toast: {
|
|
35
|
-
autoClose: true,
|
|
36
|
-
closeTimeout: notificationCloseTimeout,
|
|
37
|
-
type: 'warning',
|
|
38
|
-
},
|
|
39
|
-
},
|
|
40
|
-
} as NotificationStructure,
|
|
41
|
-
)
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
### Creating individual notifications of various types
|
|
45
|
-
|
|
46
|
-
To create individual notifications of various types, there are functions that will allow you to display and provide the structure.
|
|
47
|
-
|
|
48
|
-
```javascript
|
|
49
|
-
showNotificationAlert({ title: 'Important message', body: 'Lorem ipsum' });
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
```javascript
|
|
53
|
-
showNotificationBanner(
|
|
54
|
-
{
|
|
55
|
-
body: 'Lorem ipsum',
|
|
56
|
-
banner: {
|
|
57
|
-
confirmingActions: [{ label: 'Confirm', action: () => console.log('Lorem ipsum') }],
|
|
58
|
-
dismissingAction: {
|
|
59
|
-
label: 'Dismiss',
|
|
60
|
-
action: () => console.log('Lorem ipsum'),
|
|
61
|
-
},
|
|
62
|
-
},
|
|
63
|
-
},
|
|
64
|
-
'zero',
|
|
65
|
-
);
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
```javascript
|
|
69
|
-
showNotificationDialog(
|
|
70
|
-
{
|
|
71
|
-
title: 'Important message',
|
|
72
|
-
body: 'Lorem ipsum',
|
|
73
|
-
dialog: {
|
|
74
|
-
confirmingActions: [{ label: 'Confirm', action: () => console.log('Lorem ipsum') }],
|
|
75
|
-
dismissingAction: {
|
|
76
|
-
label: 'Dismiss',
|
|
77
|
-
action: () => console.log('Lorem ipsum'),
|
|
78
|
-
},
|
|
79
|
-
},
|
|
80
|
-
},
|
|
81
|
-
'zero',
|
|
82
|
-
);
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
```javascript
|
|
86
|
-
showNotificationSnackbar(
|
|
87
|
-
{
|
|
88
|
-
body: 'Lorem ipsum',
|
|
89
|
-
snackbar: {
|
|
90
|
-
confirmingActions: [
|
|
91
|
-
{ label: 'Confirm', action: () => console.log('Lorem ipsum') },
|
|
92
|
-
],
|
|
93
|
-
type: 'error',
|
|
94
|
-
},
|
|
95
|
-
},
|
|
96
|
-
'zero',
|
|
97
|
-
);
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
```javascript
|
|
101
|
-
showNotificationToast(
|
|
102
|
-
{
|
|
103
|
-
title: 'Important message',
|
|
104
|
-
body: 'Lorem ipsum',
|
|
105
|
-
toast: {
|
|
106
|
-
autoClose: true,
|
|
107
|
-
closeTimeout: 3000,
|
|
108
|
-
type: 'success',
|
|
109
|
-
},
|
|
110
|
-
},
|
|
111
|
-
'zero',
|
|
112
|
-
);
|
|
113
|
-
```
|
|
5
|
+
**Docs: [Toast notifications](https://docs.genesis.global/docs/develop/client-capabilities/toast-notifications/)**
|
|
114
6
|
|
|
115
7
|
## Installation
|
|
116
8
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
1. Add `@genesislcap/foundation-notifications` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
|
|
9
|
+
Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
|
|
120
10
|
|
|
121
11
|
```json
|
|
122
12
|
{
|
|
123
|
-
...
|
|
124
13
|
"dependencies": {
|
|
125
|
-
...
|
|
126
14
|
"@genesislcap/foundation-notifications": "latest"
|
|
127
|
-
|
|
128
|
-
},
|
|
129
|
-
...
|
|
15
|
+
}
|
|
130
16
|
}
|
|
131
17
|
```
|
|
132
18
|
|
|
133
|
-
## [API Docs](./docs/api/index.md)
|
|
134
|
-
|
|
135
19
|
## License
|
|
136
20
|
|
|
137
21
|
Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
|
|
138
22
|
|
|
139
23
|
### Licensed components
|
|
24
|
+
|
|
140
25
|
Genesis low-code platform
|
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.409.0",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -51,18 +51,18 @@
|
|
|
51
51
|
}
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
|
-
"@genesislcap/foundation-testing": "14.
|
|
55
|
-
"@genesislcap/genx": "14.
|
|
56
|
-
"@genesislcap/rollup-builder": "14.
|
|
57
|
-
"@genesislcap/ts-builder": "14.
|
|
58
|
-
"@genesislcap/uvu-playwright-builder": "14.
|
|
59
|
-
"@genesislcap/vite-builder": "14.
|
|
60
|
-
"@genesislcap/webpack-builder": "14.
|
|
54
|
+
"@genesislcap/foundation-testing": "14.409.0",
|
|
55
|
+
"@genesislcap/genx": "14.409.0",
|
|
56
|
+
"@genesislcap/rollup-builder": "14.409.0",
|
|
57
|
+
"@genesislcap/ts-builder": "14.409.0",
|
|
58
|
+
"@genesislcap/uvu-playwright-builder": "14.409.0",
|
|
59
|
+
"@genesislcap/vite-builder": "14.409.0",
|
|
60
|
+
"@genesislcap/webpack-builder": "14.409.0"
|
|
61
61
|
},
|
|
62
62
|
"dependencies": {
|
|
63
|
-
"@genesislcap/foundation-logger": "14.
|
|
64
|
-
"@genesislcap/foundation-utils": "14.
|
|
65
|
-
"@genesislcap/web-core": "14.
|
|
63
|
+
"@genesislcap/foundation-logger": "14.409.0",
|
|
64
|
+
"@genesislcap/foundation-utils": "14.409.0",
|
|
65
|
+
"@genesislcap/web-core": "14.409.0"
|
|
66
66
|
},
|
|
67
67
|
"repository": {
|
|
68
68
|
"type": "git",
|
|
@@ -72,5 +72,5 @@
|
|
|
72
72
|
"publishConfig": {
|
|
73
73
|
"access": "public"
|
|
74
74
|
},
|
|
75
|
-
"gitHead": "
|
|
75
|
+
"gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
|
|
76
76
|
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [AlertStructure](./foundation-notifications.alertstructure.md) > [body](./foundation-notifications.alertstructure.body.md)
|
|
4
|
-
|
|
5
|
-
## AlertStructure.body property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
readonly body: string;
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [AlertStructure](./foundation-notifications.alertstructure.md) > [logLevel](./foundation-notifications.alertstructure.loglevel.md)
|
|
4
|
-
|
|
5
|
-
## AlertStructure.logLevel property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
readonly logLevel?: LogLevel;
|
|
11
|
-
```
|
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [AlertStructure](./foundation-notifications.alertstructure.md)
|
|
4
|
-
|
|
5
|
-
## AlertStructure interface
|
|
6
|
-
|
|
7
|
-
Interface for Alert Structure
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export interface AlertStructure
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Properties
|
|
16
|
-
|
|
17
|
-
<table><thead><tr><th>
|
|
18
|
-
|
|
19
|
-
Property
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
</th><th>
|
|
23
|
-
|
|
24
|
-
Modifiers
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Type
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th><th>
|
|
33
|
-
|
|
34
|
-
Description
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
</th></tr></thead>
|
|
38
|
-
<tbody><tr><td>
|
|
39
|
-
|
|
40
|
-
[body](./foundation-notifications.alertstructure.body.md)
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
`readonly`
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
</td><td>
|
|
49
|
-
|
|
50
|
-
string
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
</td><td>
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
</td></tr>
|
|
57
|
-
<tr><td>
|
|
58
|
-
|
|
59
|
-
[logLevel?](./foundation-notifications.alertstructure.loglevel.md)
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
</td><td>
|
|
63
|
-
|
|
64
|
-
`readonly`
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
</td><td>
|
|
68
|
-
|
|
69
|
-
LogLevel
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
</td><td>
|
|
73
|
-
|
|
74
|
-
_(Optional)_
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
</td></tr>
|
|
78
|
-
<tr><td>
|
|
79
|
-
|
|
80
|
-
[title](./foundation-notifications.alertstructure.title.md)
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
</td><td>
|
|
84
|
-
|
|
85
|
-
`readonly`
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
</td><td>
|
|
89
|
-
|
|
90
|
-
string
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
</td><td>
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
</td></tr>
|
|
97
|
-
</tbody></table>
|
|
98
|
-
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [AlertStructure](./foundation-notifications.alertstructure.md) > [title](./foundation-notifications.alertstructure.title.md)
|
|
4
|
-
|
|
5
|
-
## AlertStructure.title property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
readonly title: string;
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [Banner](./foundation-notifications.banner.md) > [confirmingActions](./foundation-notifications.banner.confirmingactions.md)
|
|
4
|
-
|
|
5
|
-
## Banner.confirmingActions property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
readonly confirmingActions?: Array<ConfirmingAction>;
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [Banner](./foundation-notifications.banner.md) > [dismissingAction](./foundation-notifications.banner.dismissingaction.md)
|
|
4
|
-
|
|
5
|
-
## Banner.dismissingAction property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
readonly dismissingAction?: DismissingAction;
|
|
11
|
-
```
|
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [Banner](./foundation-notifications.banner.md)
|
|
4
|
-
|
|
5
|
-
## Banner interface
|
|
6
|
-
|
|
7
|
-
Interface for Banner configuration
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export interface Banner
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Properties
|
|
16
|
-
|
|
17
|
-
<table><thead><tr><th>
|
|
18
|
-
|
|
19
|
-
Property
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
</th><th>
|
|
23
|
-
|
|
24
|
-
Modifiers
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Type
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th><th>
|
|
33
|
-
|
|
34
|
-
Description
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
</th></tr></thead>
|
|
38
|
-
<tbody><tr><td>
|
|
39
|
-
|
|
40
|
-
[confirmingActions?](./foundation-notifications.banner.confirmingactions.md)
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
`readonly`
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
</td><td>
|
|
49
|
-
|
|
50
|
-
Array<[ConfirmingAction](./foundation-notifications.confirmingaction.md)<!-- -->>
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
</td><td>
|
|
54
|
-
|
|
55
|
-
_(Optional)_
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
</td></tr>
|
|
59
|
-
<tr><td>
|
|
60
|
-
|
|
61
|
-
[dismissingAction?](./foundation-notifications.banner.dismissingaction.md)
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
</td><td>
|
|
65
|
-
|
|
66
|
-
`readonly`
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
</td><td>
|
|
70
|
-
|
|
71
|
-
[DismissingAction](./foundation-notifications.dismissingaction.md)
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
</td><td>
|
|
75
|
-
|
|
76
|
-
_(Optional)_
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
</td></tr>
|
|
80
|
-
</tbody></table>
|
|
81
|
-
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [BannerBuilder](./foundation-notifications.bannerbuilder.md) > [build](./foundation-notifications.bannerbuilder.build.md)
|
|
4
|
-
|
|
5
|
-
## BannerBuilder.build() method
|
|
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
|
-
|
|
12
|
-
Build Banner
|
|
13
|
-
|
|
14
|
-
**Signature:**
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
build(): Banner;
|
|
18
|
-
```
|
|
19
|
-
**Returns:**
|
|
20
|
-
|
|
21
|
-
[Banner](./foundation-notifications.banner.md)
|
|
22
|
-
|
|
23
|
-
Banner
|
|
24
|
-
|
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [BannerBuilder](./foundation-notifications.bannerbuilder.md)
|
|
4
|
-
|
|
5
|
-
## BannerBuilder class
|
|
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
|
-
|
|
12
|
-
BannerBuilder
|
|
13
|
-
|
|
14
|
-
**Signature:**
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
export declare class BannerBuilder
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
## Methods
|
|
21
|
-
|
|
22
|
-
<table><thead><tr><th>
|
|
23
|
-
|
|
24
|
-
Method
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Modifiers
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th><th>
|
|
33
|
-
|
|
34
|
-
Description
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
</th></tr></thead>
|
|
38
|
-
<tbody><tr><td>
|
|
39
|
-
|
|
40
|
-
[build()](./foundation-notifications.bannerbuilder.build.md)
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
</td><td>
|
|
47
|
-
|
|
48
|
-
Build Banner
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
</td></tr>
|
|
52
|
-
<tr><td>
|
|
53
|
-
|
|
54
|
-
[withConfirmingAction(confirmingAction)](./foundation-notifications.bannerbuilder.withconfirmingaction.md)
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
</td><td>
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
</td><td>
|
|
61
|
-
|
|
62
|
-
Add confirming action to Banner
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
</td></tr>
|
|
66
|
-
<tr><td>
|
|
67
|
-
|
|
68
|
-
[withDismissingAction(dismissingAction)](./foundation-notifications.bannerbuilder.withdismissingaction.md)
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
</td><td>
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
</td><td>
|
|
75
|
-
|
|
76
|
-
Add dismissing action to Banner
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
</td></tr>
|
|
80
|
-
</tbody></table>
|
|
81
|
-
|
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [BannerBuilder](./foundation-notifications.bannerbuilder.md) > [withConfirmingAction](./foundation-notifications.bannerbuilder.withconfirmingaction.md)
|
|
4
|
-
|
|
5
|
-
## BannerBuilder.withConfirmingAction() method
|
|
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
|
-
|
|
12
|
-
Add confirming action to Banner
|
|
13
|
-
|
|
14
|
-
**Signature:**
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
withConfirmingAction(confirmingAction: ConfirmingAction): BannerBuilder;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
## Parameters
|
|
21
|
-
|
|
22
|
-
<table><thead><tr><th>
|
|
23
|
-
|
|
24
|
-
Parameter
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Type
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th><th>
|
|
33
|
-
|
|
34
|
-
Description
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
</th></tr></thead>
|
|
38
|
-
<tbody><tr><td>
|
|
39
|
-
|
|
40
|
-
confirmingAction
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
[ConfirmingAction](./foundation-notifications.confirmingaction.md)
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
</td><td>
|
|
49
|
-
|
|
50
|
-
[ConfirmingAction](./foundation-notifications.confirmingaction.md)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
</td></tr>
|
|
54
|
-
</tbody></table>
|
|
55
|
-
|
|
56
|
-
**Returns:**
|
|
57
|
-
|
|
58
|
-
[BannerBuilder](./foundation-notifications.bannerbuilder.md)
|
|
59
|
-
|
|
60
|
-
|
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [BannerBuilder](./foundation-notifications.bannerbuilder.md) > [withDismissingAction](./foundation-notifications.bannerbuilder.withdismissingaction.md)
|
|
4
|
-
|
|
5
|
-
## BannerBuilder.withDismissingAction() method
|
|
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
|
-
|
|
12
|
-
Add dismissing action to Banner
|
|
13
|
-
|
|
14
|
-
**Signature:**
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
withDismissingAction(dismissingAction: DismissingAction): BannerBuilder;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
## Parameters
|
|
21
|
-
|
|
22
|
-
<table><thead><tr><th>
|
|
23
|
-
|
|
24
|
-
Parameter
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Type
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th><th>
|
|
33
|
-
|
|
34
|
-
Description
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
</th></tr></thead>
|
|
38
|
-
<tbody><tr><td>
|
|
39
|
-
|
|
40
|
-
dismissingAction
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
[DismissingAction](./foundation-notifications.dismissingaction.md)
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
</td><td>
|
|
49
|
-
|
|
50
|
-
[DismissingAction](./foundation-notifications.dismissingaction.md)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
</td></tr>
|
|
54
|
-
</tbody></table>
|
|
55
|
-
|
|
56
|
-
**Returns:**
|
|
57
|
-
|
|
58
|
-
[BannerBuilder](./foundation-notifications.bannerbuilder.md)
|
|
59
|
-
|
|
60
|
-
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [BannerStructure](./foundation-notifications.bannerstructure.md) > [banner](./foundation-notifications.bannerstructure.banner.md)
|
|
4
|
-
|
|
5
|
-
## BannerStructure.banner property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
readonly banner?: Banner;
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [BannerStructure](./foundation-notifications.bannerstructure.md) > [body](./foundation-notifications.bannerstructure.body.md)
|
|
4
|
-
|
|
5
|
-
## BannerStructure.body property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
readonly body: string;
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [BannerStructure](./foundation-notifications.bannerstructure.md) > [logLevel](./foundation-notifications.bannerstructure.loglevel.md)
|
|
4
|
-
|
|
5
|
-
## BannerStructure.logLevel property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
readonly logLevel?: LogLevel;
|
|
11
|
-
```
|