@genesislcap/foundation-notifications 14.50.2-alpha-f13a8e3.0

package/docs/api/foundation-notifications.notificationstructure.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationStructure](./foundation-notifications.notificationstructure.md)
+
+## NotificationStructure interface
+
+Interface for Structure
+
+**Signature:**
+
+```typescript
+export interface NotificationStructure 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [body](./foundation-notifications.notificationstructure.body.md) | <code>readonly</code> | string |  |
+|  [config?](./foundation-notifications.notificationstructure.config.md) | <code>readonly</code> | { readonly logLevel?: LogLevel; readonly alert?: boolean; readonly toast?: [Toast](./foundation-notifications.toast.md)<!-- -->; readonly banner?: [Banner](./foundation-notifications.banner.md)<!-- -->; readonly snackbar?: [Snackbar](./foundation-notifications.snackbar.md)<!-- -->; readonly dialog?: [Dialog](./foundation-notifications.dialog.md)<!-- -->; } | _(Optional)_ |
+|  [logLevel?](./foundation-notifications.notificationstructure.loglevel.md) | <code>readonly</code> | LogLevel | _(Optional)_ |
+|  [title](./foundation-notifications.notificationstructure.title.md) | <code>readonly</code> | string |  |
+

package/docs/api/foundation-notifications.notificationstructure.title.md

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

package/docs/api/foundation-notifications.notificationtype.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationType](./foundation-notifications.notificationtype.md)
+
+## NotificationType type
+
+type for notification
+
+**Signature:**
+
+```typescript
+export type NotificationType = 'error' | 'warning' | 'success';
+```

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

@@ -0,0 +1,13 @@
+<!-- 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 variable
+
+Shows the notificationStructure dialog
+
+**Signature:**
+
+```typescript
+showBanner: (notificationStructure: NotificationStructure, tagName: String, notificationBoundary: HTMLElement) => void
+```

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

@@ -0,0 +1,13 @@
+<!-- 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 variable
+
+Shows the notificationStructure in the appropriate component
+
+**Signature:**
+
+```typescript
+showNotification: (notificationStructure: NotificationStructure, tagName: String, notificationBoundary?: HTMLElement) => void
+```

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

@@ -0,0 +1,11 @@
+<!-- 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>;
+```

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

@@ -0,0 +1,21 @@
+<!-- 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)
+
+## Snackbar interface
+
+Interface for Snackbar configuration
+
+**Signature:**
+
+```typescript
+export interface Snackbar 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [confirmingActions?](./foundation-notifications.snackbar.confirmingactions.md) | <code>readonly</code> | Array&lt;[ConfirmingAction](./foundation-notifications.confirmingaction.md)<!-- -->&gt; | _(Optional)_ |
+|  [type?](./foundation-notifications.snackbar.type.md) | <code>readonly</code> | [SnackbarType](./foundation-notifications.snackbartype.md) | _(Optional)_ |
+

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

@@ -0,0 +1,11 @@
+<!-- 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; [type](./foundation-notifications.snackbar.type.md)
+
+## Snackbar.type property
+
+**Signature:**
+
+```typescript
+readonly type?: SnackbarType;
+```

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

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

package/docs/api/foundation-notifications.snackbarbuilder.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [SnackbarBuilder](./foundation-notifications.snackbarbuilder.md)
+
+## SnackbarBuilder class
+
+SnackbarBuilder to build Snackbar
+
+**Signature:**
+
+```typescript
+export declare class SnackbarBuilder 
+```
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [build()](./foundation-notifications.snackbarbuilder.build.md) |  | Build snackbar |
+|  [withConfirmingAction(confirmingAction)](./foundation-notifications.snackbarbuilder.withconfirmingaction.md) |  | Add confirming action to snackbar |
+|  [withType(type)](./foundation-notifications.snackbarbuilder.withtype.md) |  |  |
+

package/docs/api/foundation-notifications.snackbarbuilder.withconfirmingaction.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [SnackbarBuilder](./foundation-notifications.snackbarbuilder.md) &gt; [withConfirmingAction](./foundation-notifications.snackbarbuilder.withconfirmingaction.md)
+
+## SnackbarBuilder.withConfirmingAction() method
+
+Add confirming action to snackbar
+
+**Signature:**
+
+```typescript
+withConfirmingAction(confirmingAction: ConfirmingAction): SnackbarBuilder;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  confirmingAction | [ConfirmingAction](./foundation-notifications.confirmingaction.md) | [ConfirmingAction](./foundation-notifications.confirmingaction.md) |
+
+**Returns:**
+
+[SnackbarBuilder](./foundation-notifications.snackbarbuilder.md)
+
+

package/docs/api/foundation-notifications.snackbarbuilder.withtype.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [SnackbarBuilder](./foundation-notifications.snackbarbuilder.md) &gt; [withType](./foundation-notifications.snackbarbuilder.withtype.md)
+
+## SnackbarBuilder.withType() method
+
+**Signature:**
+
+```typescript
+withType(type: SnackbarType): SnackbarBuilder;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  type | [SnackbarType](./foundation-notifications.snackbartype.md) | [SnackbarType](./foundation-notifications.snackbartype.md) |
+
+**Returns:**
+
+[SnackbarBuilder](./foundation-notifications.snackbarbuilder.md)
+
+

package/docs/api/foundation-notifications.snackbartype.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [SnackbarType](./foundation-notifications.snackbartype.md)
+
+## SnackbarType type
+
+type for snackbar type
+
+**Signature:**
+
+```typescript
+export type SnackbarType = 'error';
+```

package/docs/api/foundation-notifications.toast.autoclose.md

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

package/docs/api/foundation-notifications.toast.closetimeout.md

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

package/docs/api/foundation-notifications.toast.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [Toast](./foundation-notifications.toast.md)
+
+## Toast interface
+
+Interface for Toast configuration
+
+**Signature:**
+
+```typescript
+export interface Toast 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [autoClose?](./foundation-notifications.toast.autoclose.md) | <code>readonly</code> | boolean | _(Optional)_ |
+|  [closeTimeout?](./foundation-notifications.toast.closetimeout.md) | <code>readonly</code> | number | _(Optional)_ |
+|  [position?](./foundation-notifications.toast.position.md) | <code>readonly</code> | [ToastPosition](./foundation-notifications.toastposition.md) | _(Optional)_ |
+|  [type?](./foundation-notifications.toast.type.md) | <code>readonly</code> | [NotificationType](./foundation-notifications.notificationtype.md) | _(Optional)_ |
+

package/docs/api/foundation-notifications.toast.position.md

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

package/docs/api/foundation-notifications.toast.type.md

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

package/docs/api/foundation-notifications.toastbuilder.build.md

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

package/docs/api/foundation-notifications.toastbuilder.md

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

package/docs/api/foundation-notifications.toastbuilder.withautoclose.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ToastBuilder](./foundation-notifications.toastbuilder.md) &gt; [withAutoClose](./foundation-notifications.toastbuilder.withautoclose.md)
+
+## ToastBuilder.withAutoClose() method
+
+Add auto close to notification
+
+**Signature:**
+
+```typescript
+withAutoClose(autoClose: boolean): ToastBuilder;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  autoClose | boolean | boolean |
+
+**Returns:**
+
+[ToastBuilder](./foundation-notifications.toastbuilder.md)
+
+

package/docs/api/foundation-notifications.toastbuilder.withclosetimeout.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ToastBuilder](./foundation-notifications.toastbuilder.md) &gt; [withCloseTimeout](./foundation-notifications.toastbuilder.withclosetimeout.md)
+
+## ToastBuilder.withCloseTimeout() method
+
+Add close timeout to notification
+
+**Signature:**
+
+```typescript
+withCloseTimeout(closeTimeout: number): ToastBuilder;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  closeTimeout | number | number |
+
+**Returns:**
+
+[ToastBuilder](./foundation-notifications.toastbuilder.md)
+
+

package/docs/api/foundation-notifications.toastbuilder.withposition.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ToastBuilder](./foundation-notifications.toastbuilder.md) &gt; [withPosition](./foundation-notifications.toastbuilder.withposition.md)
+
+## ToastBuilder.withPosition() method
+
+Add position to toast
+
+**Signature:**
+
+```typescript
+withPosition(position: ToastPosition): ToastBuilder;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  position | [ToastPosition](./foundation-notifications.toastposition.md) | [ToastPosition](./foundation-notifications.toastposition.md) |
+
+**Returns:**
+
+[ToastBuilder](./foundation-notifications.toastbuilder.md)
+
+

package/docs/api/foundation-notifications.toastbuilder.withtype.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ToastBuilder](./foundation-notifications.toastbuilder.md) &gt; [withType](./foundation-notifications.toastbuilder.withtype.md)
+
+## ToastBuilder.withType() method
+
+Add type to notification, if the type is anything other than 'warning' or 'success' do not add it
+
+**Signature:**
+
+```typescript
+withType(type: NotificationType): ToastBuilder;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  type | [NotificationType](./foundation-notifications.notificationtype.md) | [NotificationType](./foundation-notifications.notificationtype.md) |
+
+**Returns:**
+
+[ToastBuilder](./foundation-notifications.toastbuilder.md)
+
+

package/docs/api/foundation-notifications.toastposition.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ToastPosition](./foundation-notifications.toastposition.md)
+
+## ToastPosition type
+
+type for notification position
+
+**Signature:**
+
+```typescript
+export type ToastPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+```

package/docs/api/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [@genesislcap/foundation-notifications](./foundation-notifications.md) |  |
+