npm - @genesislcap/foundation-notifications - Versions diffs - 14.408.0 → 14.409.0 - Mend

@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.

Files changed (153) hide show

package/docs/api/foundation-notifications.notifycontainerconfig.stackthreshold.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotifyContainerConfig](./foundation-notifications.notifycontainerconfig.md) &gt; [stackThreshold](./foundation-notifications.notifycontainerconfig.stackthreshold.md)
-## NotifyContainerConfig.stackThreshold property
-The number of visible notifications that triggers the stack to auto-collapse.
-**Signature:**
-```typescript
-stackThreshold: number;
-```

package/docs/api/foundation-notifications.showbanner.md DELETED Viewed

@@ -1,87 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [showBanner](./foundation-notifications.showbanner.md)
-## showBanner() function
-Shows the notificationStructure dialog
-**Signature:**
-```typescript
-showBanner: (notificationStructure: NotificationStructure, tagName: String, notificationBoundary: HTMLElement) => void
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-notificationStructure
-</td><td>
-[NotificationStructure](./foundation-notifications.notificationstructure.md)
-</td><td>
-The NotificationStructure object
-</td></tr>
-<tr><td>
-tagName
-</td><td>
-String
-</td><td>
-The tag name to create prefix for the design system provider &amp; notificationStructure component
-</td></tr>
-<tr><td>
-notificationBoundary
-</td><td>
-HTMLElement
-</td><td>
-target listener for the notification
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-notifications.showloggerloglevel.md DELETED Viewed

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [showLoggerLogLevel](./foundation-notifications.showloggerloglevel.md)
-## showLoggerLogLevel() function
-Shows logger with log level from NotificationStructure object
-**Signature:**
-```typescript
-showLoggerLogLevel: (notificationStructure: NotificationStructure) => void
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-notificationStructure
-</td><td>
-[NotificationStructure](./foundation-notifications.notificationstructure.md)
-</td><td>
-The NotificationStructure object
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-notifications.shownotification.md DELETED Viewed

@@ -1,87 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [showNotification](./foundation-notifications.shownotification.md)
-## showNotification() function
-Shows the notificationStructure in the appropriate component
-**Signature:**
-```typescript
-showNotification: (notificationStructure: NotificationStructure, tagName: String, notificationBoundary?: HTMLElement) => void
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-notificationStructure
-</td><td>
-[NotificationStructure](./foundation-notifications.notificationstructure.md)
-</td><td>
-The NotificationStructure object
-</td></tr>
-<tr><td>
-tagName
-</td><td>
-String
-</td><td>
-The tag name to create prefix for the design system provider \*
-</td></tr>
-<tr><td>
-notificationBoundary
-</td><td>
-HTMLElement
-</td><td>
-_(Optional)_ The notificationStructure boundary element
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-notifications.shownotificationalert.md DELETED Viewed

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [showNotificationAlert](./foundation-notifications.shownotificationalert.md)
-## showNotificationAlert() function
-Shows the notification alert
-**Signature:**
-```typescript
-showNotificationAlert: (configuration: AlertStructure) => void
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-configuration
-</td><td>
-[AlertStructure](./foundation-notifications.alertstructure.md)
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-notifications.shownotificationbanner.md DELETED Viewed

@@ -1,82 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [showNotificationBanner](./foundation-notifications.shownotificationbanner.md)
-## showNotificationBanner() function
-Shows the notification banner
-**Signature:**
-```typescript
-showNotificationBanner: (configuration: BannerStructure, tagName: String, notificationBoundary?: HTMLElement) => void
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-configuration
-</td><td>
-[BannerStructure](./foundation-notifications.bannerstructure.md)
-</td><td>
-</td></tr>
-<tr><td>
-tagName
-</td><td>
-String
-</td><td>
-</td></tr>
-<tr><td>
-notificationBoundary
-</td><td>
-HTMLElement
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-notifications.shownotificationdialog.md DELETED Viewed

@@ -1,82 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [showNotificationDialog](./foundation-notifications.shownotificationdialog.md)
-## showNotificationDialog() function
-Shows the notification dialog
-**Signature:**
-```typescript
-showNotificationDialog: (configuration: DialogStructure, tagName: String, notificationBoundary?: HTMLElement) => void
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-configuration
-</td><td>
-[DialogStructure](./foundation-notifications.dialogstructure.md)
-</td><td>
-</td></tr>
-<tr><td>
-tagName
-</td><td>
-String
-</td><td>
-</td></tr>
-<tr><td>
-notificationBoundary
-</td><td>
-HTMLElement
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-notifications.shownotificationsnackbar.md DELETED Viewed

@@ -1,66 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [showNotificationSnackbar](./foundation-notifications.shownotificationsnackbar.md)
-## showNotificationSnackbar() function
-Shows the notification snackbar
-**Signature:**
-```typescript
-showNotificationSnackbar: (configuration: SnackbarStructure, tagName: String) => void
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-configuration
-</td><td>
-[SnackbarStructure](./foundation-notifications.snackbarstructure.md)
-</td><td>
-</td></tr>
-<tr><td>
-tagName
-</td><td>
-String
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-notifications.shownotificationtoast.md DELETED Viewed

@@ -1,82 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [showNotificationToast](./foundation-notifications.shownotificationtoast.md)
-## showNotificationToast() function
-Shows the notification toast
-**Signature:**
-```typescript
-showNotificationToast: (configuration: ToastStructure, tagName: String, notificationContainer?: HTMLElement) => void
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-configuration
-</td><td>
-[ToastStructure](./foundation-notifications.toaststructure.md)
-</td><td>
-</td></tr>
-<tr><td>
-tagName
-</td><td>
-String
-</td><td>
-</td></tr>
-<tr><td>
-notificationContainer
-</td><td>
-HTMLElement
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-notifications.snackbar.autoclose.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [Snackbar](./foundation-notifications.snackbar.md) &gt; [autoClose](./foundation-notifications.snackbar.autoclose.md)
-## Snackbar.autoClose property
-**Signature:**
-```typescript
-readonly autoClose?: boolean;
-```

package/docs/api/foundation-notifications.snackbar.closetimeout.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [Snackbar](./foundation-notifications.snackbar.md) &gt; [closeTimeout](./foundation-notifications.snackbar.closetimeout.md)
-## Snackbar.closeTimeout property
-**Signature:**
-```typescript
-readonly closeTimeout?: number;
-```

package/docs/api/foundation-notifications.snackbar.confirmingactions.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [Snackbar](./foundation-notifications.snackbar.md) &gt; [confirmingActions](./foundation-notifications.snackbar.confirmingactions.md)
-## Snackbar.confirmingActions property
-**Signature:**
-```typescript
-readonly confirmingActions?: Array<ConfirmingAction>;
-```