@genesislcap/foundation-notifications 14.226.0 → 14.226.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.
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [getBannerAnchor](./foundation-notifications.getbanneranchor.md)
4
4
 
5
- ## getBannerAnchor() function
5
+ ## getBannerAnchor variable
6
6
 
7
7
  Get the banner anchor to attach the banner to
8
8
 
@@ -11,15 +11,3 @@ Get the banner anchor to attach the banner to
11
11
  ```typescript
12
12
  getBannerAnchor: (element: any) => HTMLElement | null
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | element | any | The element to start searching from |
20
-
21
- **Returns:**
22
-
23
- HTMLElement \| null
24
-
25
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [getBannerBuilder](./foundation-notifications.getbannerbuilder.md)
4
4
 
5
- ## getBannerBuilder() function
5
+ ## getBannerBuilder variable
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
@@ -16,7 +16,3 @@ Get banner builder instance
16
16
  ```typescript
17
17
  getBannerBuilder: () => BannerBuilder
18
18
  ```
19
- **Returns:**
20
-
21
- [BannerBuilder](./foundation-notifications.bannerbuilder.md)
22
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [getDialogBuilder](./foundation-notifications.getdialogbuilder.md)
4
4
 
5
- ## getDialogBuilder() function
5
+ ## getDialogBuilder variable
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
@@ -16,7 +16,3 @@ Returns an instance of DialogBuilder
16
16
  ```typescript
17
17
  getDialogBuilder: () => DialogBuilder
18
18
  ```
19
- **Returns:**
20
-
21
- [DialogBuilder](./foundation-notifications.dialogbuilder.md)
22
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [getLoglevel](./foundation-notifications.getloglevel.md)
4
4
 
5
- ## getLoglevel() function
5
+ ## getLoglevel variable
6
6
 
7
7
  Retrieves the log level from an NotificationStructure object
8
8
 
@@ -11,16 +11,3 @@ Retrieves the log level from an NotificationStructure object
11
11
  ```typescript
12
12
  getLoglevel: (details: NotificationStructure) => LogLevel
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | details | [NotificationStructure](./foundation-notifications.notificationstructure.md) | The NotificationStructure object |
20
-
21
- **Returns:**
22
-
23
- LogLevel
24
-
25
- The log level or the default value (LogLevel.Debug) if not present
26
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [getNotificationBuilder](./foundation-notifications.getnotificationbuilder.md)
4
4
 
5
- ## getNotificationBuilder() function
5
+ ## getNotificationBuilder variable
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
@@ -16,7 +16,3 @@ Returns a new NotificationBuilder instance
16
16
  ```typescript
17
17
  getNotificationBuilder: () => NotificationBuilder
18
18
  ```
19
- **Returns:**
20
-
21
- [NotificationBuilder](./foundation-notifications.notificationbuilder.md)
22
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [getNotificationContainer](./foundation-notifications.getnotificationcontainer.md)
4
4
 
5
- ## getNotificationContainer() function
5
+ ## getNotificationContainer variable
6
6
 
7
7
  Get/Create the error container in the DOM
8
8
 
@@ -11,16 +11,3 @@ Get/Create the error container in the DOM
11
11
  ```typescript
12
12
  getNotificationContainer: (id: string, tagName: String) => HTMLElement
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | id | string | The id of the container |
20
- | tagName | String | The tag name to create prefix for the design system provider |
21
-
22
- **Returns:**
23
-
24
- HTMLElement
25
-
26
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [getNotificationDetails](./foundation-notifications.getnotificationdetails.md)
4
4
 
5
- ## getNotificationDetails() function
5
+ ## getNotificationDetails variable
6
6
 
7
7
  Retrieves the notification details from an NotificationStructure object
8
8
 
@@ -11,16 +11,3 @@ Retrieves the notification details from an NotificationStructure object
11
11
  ```typescript
12
12
  getNotificationDetails: (details: NotificationStructure) => string
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | details | [NotificationStructure](./foundation-notifications.notificationstructure.md) | The NotificationStructure object |
20
-
21
- **Returns:**
22
-
23
- string
24
-
25
- The title and body concatenated as a string, or default values ('Error: Something went wrong') if not present
26
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [getSnackbarBuilder](./foundation-notifications.getsnackbarbuilder.md)
4
4
 
5
- ## getSnackbarBuilder() function
5
+ ## getSnackbarBuilder variable
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
@@ -16,7 +16,3 @@ Get snackbar builder instance
16
16
  ```typescript
17
17
  getSnackbarBuilder: () => SnackbarBuilder
18
18
  ```
19
- **Returns:**
20
-
21
- [SnackbarBuilder](./foundation-notifications.snackbarbuilder.md)
22
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [getToastBuilder](./foundation-notifications.gettoastbuilder.md)
4
4
 
5
- ## getToastBuilder() function
5
+ ## getToastBuilder variable
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
@@ -16,7 +16,3 @@ Get notification builder instance
16
16
  ```typescript
17
17
  getToastBuilder: () => ToastBuilder
18
18
  ```
19
- **Returns:**
20
-
21
- [ToastBuilder](./foundation-notifications.toastbuilder.md)
22
-
@@ -20,28 +20,6 @@
20
20
  | --- | --- |
21
21
  | [NotificationEvent](./foundation-notifications.notificationevent.md) | enum for different types of notification events |
22
22
 
23
- ## Functions
24
-
25
- | Function | Description |
26
- | --- | --- |
27
- | [getBannerAnchor(element)](./foundation-notifications.getbanneranchor.md) | Get the banner anchor to attach the banner to |
28
- | [getBannerBuilder()](./foundation-notifications.getbannerbuilder.md) | Get banner builder instance |
29
- | [getDialogBuilder()](./foundation-notifications.getdialogbuilder.md) | Returns an instance of DialogBuilder |
30
- | [getLoglevel(details)](./foundation-notifications.getloglevel.md) | Retrieves the log level from an NotificationStructure object |
31
- | [getNotificationBuilder()](./foundation-notifications.getnotificationbuilder.md) | Returns a new NotificationBuilder instance |
32
- | [getNotificationContainer(id, tagName)](./foundation-notifications.getnotificationcontainer.md) | Get/Create the error container in the DOM |
33
- | [getNotificationDetails(details)](./foundation-notifications.getnotificationdetails.md) | Retrieves the notification details from an NotificationStructure object |
34
- | [getSnackbarBuilder()](./foundation-notifications.getsnackbarbuilder.md) | Get snackbar builder instance |
35
- | [getToastBuilder()](./foundation-notifications.gettoastbuilder.md) | Get notification builder instance |
36
- | [showBanner(notificationStructure, tagName, notificationBoundary)](./foundation-notifications.showbanner.md) | Shows the notificationStructure dialog |
37
- | [showLoggerLogLevel(notificationStructure)](./foundation-notifications.showloggerloglevel.md) | Shows logger with log level from NotificationStructure object |
38
- | [showNotification(notificationStructure, tagName, notificationBoundary)](./foundation-notifications.shownotification.md) | Shows the notificationStructure in the appropriate component |
39
- | [showNotificationAlert(configuration)](./foundation-notifications.shownotificationalert.md) | Shows the notification alert |
40
- | [showNotificationBanner(configuration, tagName, notificationBoundary)](./foundation-notifications.shownotificationbanner.md) | Shows the notification banner |
41
- | [showNotificationDialog(configuration, tagName)](./foundation-notifications.shownotificationdialog.md) | Shows the notification dialog |
42
- | [showNotificationSnackbar(configuration, tagName)](./foundation-notifications.shownotificationsnackbar.md) | Shows the notification snackbar |
43
- | [showNotificationToast(configuration, tagName, notificationContainer)](./foundation-notifications.shownotificationtoast.md) | Shows the notification toast |
44
-
45
23
  ## Interfaces
46
24
 
47
25
  | Interface | Description |
@@ -61,6 +39,28 @@
61
39
  | [ToastButton](./foundation-notifications.toastbutton.md) | Interface for ToastButton |
62
40
  | [ToastStructure](./foundation-notifications.toaststructure.md) | Interface for Toast Structure |
63
41
 
42
+ ## Variables
43
+
44
+ | Variable | Description |
45
+ | --- | --- |
46
+ | [getBannerAnchor](./foundation-notifications.getbanneranchor.md) | Get the banner anchor to attach the banner to |
47
+ | [getBannerBuilder](./foundation-notifications.getbannerbuilder.md) | Get banner builder instance |
48
+ | [getDialogBuilder](./foundation-notifications.getdialogbuilder.md) | Returns an instance of DialogBuilder |
49
+ | [getLoglevel](./foundation-notifications.getloglevel.md) | Retrieves the log level from an NotificationStructure object |
50
+ | [getNotificationBuilder](./foundation-notifications.getnotificationbuilder.md) | Returns a new NotificationBuilder instance |
51
+ | [getNotificationContainer](./foundation-notifications.getnotificationcontainer.md) | Get/Create the error container in the DOM |
52
+ | [getNotificationDetails](./foundation-notifications.getnotificationdetails.md) | Retrieves the notification details from an NotificationStructure object |
53
+ | [getSnackbarBuilder](./foundation-notifications.getsnackbarbuilder.md) | Get snackbar builder instance |
54
+ | [getToastBuilder](./foundation-notifications.gettoastbuilder.md) | Get notification builder instance |
55
+ | [showBanner](./foundation-notifications.showbanner.md) | Shows the notificationStructure dialog |
56
+ | [showLoggerLogLevel](./foundation-notifications.showloggerloglevel.md) | Shows logger with log level from NotificationStructure object |
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 |
63
+
64
64
  ## Type Aliases
65
65
 
66
66
  | Type Alias | Description |
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [showBanner](./foundation-notifications.showbanner.md)
4
4
 
5
- ## showBanner() function
5
+ ## showBanner variable
6
6
 
7
7
  Shows the notificationStructure dialog
8
8
 
@@ -11,17 +11,3 @@ Shows the notificationStructure dialog
11
11
  ```typescript
12
12
  showBanner: (notificationStructure: NotificationStructure, tagName: String, notificationBoundary: HTMLElement) => void
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | notificationStructure | [NotificationStructure](./foundation-notifications.notificationstructure.md) | The NotificationStructure object |
20
- | tagName | String | The tag name to create prefix for the design system provider & notificationStructure component |
21
- | notificationBoundary | HTMLElement | target listener for the notification |
22
-
23
- **Returns:**
24
-
25
- void
26
-
27
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [showLoggerLogLevel](./foundation-notifications.showloggerloglevel.md)
4
4
 
5
- ## showLoggerLogLevel() function
5
+ ## showLoggerLogLevel variable
6
6
 
7
7
  Shows logger with log level from NotificationStructure object
8
8
 
@@ -11,14 +11,3 @@ Shows logger with log level from NotificationStructure object
11
11
  ```typescript
12
12
  showLoggerLogLevel: (notificationStructure: NotificationStructure) => void
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | notificationStructure | [NotificationStructure](./foundation-notifications.notificationstructure.md) | The NotificationStructure object |
20
-
21
- **Returns:**
22
-
23
- void
24
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [showNotification](./foundation-notifications.shownotification.md)
4
4
 
5
- ## showNotification() function
5
+ ## showNotification variable
6
6
 
7
7
  Shows the notificationStructure in the appropriate component
8
8
 
@@ -11,17 +11,3 @@ Shows the notificationStructure in the appropriate component
11
11
  ```typescript
12
12
  showNotification: (notificationStructure: NotificationStructure, tagName: String, notificationBoundary?: HTMLElement) => void
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | notificationStructure | [NotificationStructure](./foundation-notifications.notificationstructure.md) | The NotificationStructure object |
20
- | tagName | String | The tag name to create prefix for the design system provider \* |
21
- | notificationBoundary | HTMLElement | _(Optional)_ The notificationStructure boundary element |
22
-
23
- **Returns:**
24
-
25
- void
26
-
27
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [showNotificationAlert](./foundation-notifications.shownotificationalert.md)
4
4
 
5
- ## showNotificationAlert() function
5
+ ## showNotificationAlert variable
6
6
 
7
7
  Shows the notification alert
8
8
 
@@ -11,14 +11,3 @@ Shows the notification alert
11
11
  ```typescript
12
12
  showNotificationAlert: (configuration: AlertStructure) => void
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | configuration | [AlertStructure](./foundation-notifications.alertstructure.md) | |
20
-
21
- **Returns:**
22
-
23
- void
24
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [showNotificationBanner](./foundation-notifications.shownotificationbanner.md)
4
4
 
5
- ## showNotificationBanner() function
5
+ ## showNotificationBanner variable
6
6
 
7
7
  Shows the notification banner
8
8
 
@@ -11,16 +11,3 @@ Shows the notification banner
11
11
  ```typescript
12
12
  showNotificationBanner: (configuration: BannerStructure, tagName: String, notificationBoundary?: HTMLElement) => void
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | configuration | [BannerStructure](./foundation-notifications.bannerstructure.md) | |
20
- | tagName | String | |
21
- | notificationBoundary | HTMLElement | _(Optional)_ |
22
-
23
- **Returns:**
24
-
25
- void
26
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [showNotificationDialog](./foundation-notifications.shownotificationdialog.md)
4
4
 
5
- ## showNotificationDialog() function
5
+ ## showNotificationDialog variable
6
6
 
7
7
  Shows the notification dialog
8
8
 
@@ -11,15 +11,3 @@ Shows the notification dialog
11
11
  ```typescript
12
12
  showNotificationDialog: (configuration: DialogStructure, tagName: String) => void
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | configuration | [DialogStructure](./foundation-notifications.dialogstructure.md) | |
20
- | tagName | String | |
21
-
22
- **Returns:**
23
-
24
- void
25
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [showNotificationSnackbar](./foundation-notifications.shownotificationsnackbar.md)
4
4
 
5
- ## showNotificationSnackbar() function
5
+ ## showNotificationSnackbar variable
6
6
 
7
7
  Shows the notification snackbar
8
8
 
@@ -11,15 +11,3 @@ Shows the notification snackbar
11
11
  ```typescript
12
12
  showNotificationSnackbar: (configuration: SnackbarStructure, tagName: String) => void
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | configuration | [SnackbarStructure](./foundation-notifications.snackbarstructure.md) | |
20
- | tagName | String | |
21
-
22
- **Returns:**
23
-
24
- void
25
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-notifications](./foundation-notifications.md) > [showNotificationToast](./foundation-notifications.shownotificationtoast.md)
4
4
 
5
- ## showNotificationToast() function
5
+ ## showNotificationToast variable
6
6
 
7
7
  Shows the notification toast
8
8
 
@@ -11,16 +11,3 @@ Shows the notification toast
11
11
  ```typescript
12
12
  showNotificationToast: (configuration: ToastStructure, tagName: String, notificationContainer?: HTMLElement) => void
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | configuration | [ToastStructure](./foundation-notifications.toaststructure.md) | |
20
- | tagName | String | |
21
- | notificationContainer | HTMLElement | _(Optional)_ |
22
-
23
- **Returns:**
24
-
25
- void
26
-
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.226.0",
4
+ "version": "14.226.1",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -49,18 +49,18 @@
49
49
  }
50
50
  },
51
51
  "devDependencies": {
52
- "@genesislcap/foundation-testing": "14.226.0",
53
- "@genesislcap/genx": "14.226.0",
54
- "@genesislcap/rollup-builder": "14.226.0",
55
- "@genesislcap/ts-builder": "14.226.0",
56
- "@genesislcap/uvu-playwright-builder": "14.226.0",
57
- "@genesislcap/vite-builder": "14.226.0",
58
- "@genesislcap/webpack-builder": "14.226.0",
52
+ "@genesislcap/foundation-testing": "14.226.1",
53
+ "@genesislcap/genx": "14.226.1",
54
+ "@genesislcap/rollup-builder": "14.226.1",
55
+ "@genesislcap/ts-builder": "14.226.1",
56
+ "@genesislcap/uvu-playwright-builder": "14.226.1",
57
+ "@genesislcap/vite-builder": "14.226.1",
58
+ "@genesislcap/webpack-builder": "14.226.1",
59
59
  "rimraf": "^5.0.0"
60
60
  },
61
61
  "dependencies": {
62
- "@genesislcap/foundation-logger": "14.226.0",
63
- "tslib": "2.8.1"
62
+ "@genesislcap/foundation-logger": "14.226.1",
63
+ "tslib": "^2.3.1"
64
64
  },
65
65
  "repository": {
66
66
  "type": "git",
@@ -70,5 +70,5 @@
70
70
  "publishConfig": {
71
71
  "access": "public"
72
72
  },
73
- "gitHead": "92b4d205bf702945dbed4e9c998c4fd000d99e4b"
73
+ "gitHead": "e691c1741d135edca5271f338f62df8154efb99c"
74
74
  }
File without changes