@genesislcap/foundation-errors 14.408.0 → 14.409.0

package/docs/api/foundation-errors.notificationbuilder.build.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [NotificationBuilder](./foundation-errors.notificationbuilder.md) &gt; [build](./foundation-errors.notificationbuilder.build.md)
-
-## NotificationBuilder.build() method
-
-Build notification
-
-**Signature:**
-
-```typescript
-build(): ErrorNotification;
-```
-**Returns:**
-
-[ErrorNotification](./foundation-errors.errornotification.md)
-
-ErrorNotification
-

package/docs/api/foundation-errors.notificationbuilder.md

@@ -1,104 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [NotificationBuilder](./foundation-errors.notificationbuilder.md)
-
-## NotificationBuilder class
-
-NotificationBuilder to build ErrorNotification
-
-**Signature:**
-
-```typescript
-export declare class NotificationBuilder 
-```
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[build()](./foundation-errors.notificationbuilder.build.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Build notification
-
-
-</td></tr>
-<tr><td>
-
-[withAutoClose(autoClose)](./foundation-errors.notificationbuilder.withautoclose.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Add auto close to notification
-
-
-</td></tr>
-<tr><td>
-
-[withCloseTimeout(closeTimeout)](./foundation-errors.notificationbuilder.withclosetimeout.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Add close timeout to notification
-
-
-</td></tr>
-<tr><td>
-
-[withPosition(position)](./foundation-errors.notificationbuilder.withposition.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Add position to notification
-
-
-</td></tr>
-<tr><td>
-
-[withType(type)](./foundation-errors.notificationbuilder.withtype.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Add type to notification, if the type is anything other than 'warning' or 'success' do not add it
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-errors.notificationbuilder.withautoclose.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [NotificationBuilder](./foundation-errors.notificationbuilder.md) &gt; [withAutoClose](./foundation-errors.notificationbuilder.withautoclose.md)
-
-## NotificationBuilder.withAutoClose() method
-
-Add auto close to notification
-
-**Signature:**
-
-```typescript
-withAutoClose(autoClose: boolean): NotificationBuilder;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-autoClose
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-boolean
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[NotificationBuilder](./foundation-errors.notificationbuilder.md)
-
-

package/docs/api/foundation-errors.notificationbuilder.withclosetimeout.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [NotificationBuilder](./foundation-errors.notificationbuilder.md) &gt; [withCloseTimeout](./foundation-errors.notificationbuilder.withclosetimeout.md)
-
-## NotificationBuilder.withCloseTimeout() method
-
-Add close timeout to notification
-
-**Signature:**
-
-```typescript
-withCloseTimeout(closeTimeout: number): NotificationBuilder;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-closeTimeout
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-number
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[NotificationBuilder](./foundation-errors.notificationbuilder.md)
-
-

package/docs/api/foundation-errors.notificationbuilder.withposition.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [NotificationBuilder](./foundation-errors.notificationbuilder.md) &gt; [withPosition](./foundation-errors.notificationbuilder.withposition.md)
-
-## NotificationBuilder.withPosition() method
-
-Add position to notification
-
-**Signature:**
-
-```typescript
-withPosition(position: ErrorNotificationPosition): NotificationBuilder;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-position
-
-
-</td><td>
-
-[ErrorNotificationPosition](./foundation-errors.errornotificationposition.md)
-
-
-</td><td>
-
-[ErrorNotificationPosition](./foundation-errors.errornotificationposition.md)
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[NotificationBuilder](./foundation-errors.notificationbuilder.md)
-
-

package/docs/api/foundation-errors.notificationbuilder.withtype.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [NotificationBuilder](./foundation-errors.notificationbuilder.md) &gt; [withType](./foundation-errors.notificationbuilder.withtype.md)
-
-## NotificationBuilder.withType() method
-
-Add type to notification, if the type is anything other than 'warning' or 'success' do not add it
-
-**Signature:**
-
-```typescript
-withType(type: ErrorNotificationType): NotificationBuilder;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-type
-
-
-</td><td>
-
-[ErrorNotificationType](./foundation-errors.errornotificationtype.md)
-
-
-</td><td>
-
-[ErrorNotificationType](./foundation-errors.errornotificationtype.md)
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[NotificationBuilder](./foundation-errors.notificationbuilder.md)
-
-

package/docs/api/foundation-errors.showbanner.md

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

package/docs/api/foundation-errors.showerror.md

@@ -1,87 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [showError](./foundation-errors.showerror.md)
-
-## showError() function
-
-Shows the error in the appropriate component
-
-**Signature:**
-
-```typescript
-showError: (error: ErrorStructure, tagName: String, errorBoundary?: HTMLElement) => void
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-error
-
-
-</td><td>
-
-[ErrorStructure](./foundation-errors.errorstructure.md)
-
-
-</td><td>
-
-The ErrorStructure 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>
-
-errorBoundary
-
-
-</td><td>
-
-HTMLElement
-
-
-</td><td>
-
-_(Optional)_ The error boundary element
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-

package/docs/api/foundation-errors.snackbar.confirmingactions.md

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

package/docs/api/foundation-errors.snackbar.md

@@ -1,81 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [Snackbar](./foundation-errors.snackbar.md)
-
-## Snackbar interface
-
-Interface for Error Snackbar configuration
-
-**Signature:**
-
-```typescript
-export interface Snackbar 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[confirmingActions?](./foundation-errors.snackbar.confirmingactions.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-Array&lt;[ConfirmingAction](./foundation-errors.confirmingaction.md)<!-- -->&gt;
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-[type?](./foundation-errors.snackbar.type.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-[SnackbarType](./foundation-errors.snackbartype.md)
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-errors.snackbar.type.md

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

package/docs/api/foundation-errors.snackbarbuilder.build.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [SnackbarBuilder](./foundation-errors.snackbarbuilder.md) &gt; [build](./foundation-errors.snackbarbuilder.build.md)
-
-## SnackbarBuilder.build() method
-
-Build snackbar
-
-**Signature:**
-
-```typescript
-build(): Snackbar;
-```
-**Returns:**
-
-[Snackbar](./foundation-errors.snackbar.md)
-
-Snackbar
-