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

@genesislcap/foundation-alerts 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 (31) hide show

package/docs/api/foundation-alerts.foundationalerts.md DELETED Viewed

@@ -1,351 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md)
-## FoundationAlerts class
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Foundation alerts component for handle alerts rules list Allow creating, disabling and deleting alerts
-**Signature:**
-```typescript
-export declare class FoundationAlerts extends FASTElement
-```
-**Extends:** FASTElement
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[alertConfig](./foundation-alerts.foundationalerts.alertconfig.md)
-</td><td>
-</td><td>
-[AlertConfig](./foundation-alerts.alertconfig.md)
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[alertEditItemData](./foundation-alerts.foundationalerts.alertedititemdata.md)
-</td><td>
-</td><td>
-AlertRule
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[connect](./foundation-alerts.foundationalerts.connect.md)
-</td><td>
-</td><td>
-Connect
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[criteriaFromFilters](./foundation-alerts.foundationalerts.criteriafromfilters.md)
-</td><td>
-</td><td>
-Map&lt;string, string&gt;
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[datasource](./foundation-alerts.foundationalerts.datasource.md)
-</td><td>
-</td><td>
-Datasource
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[dataSubscription](./foundation-alerts.foundationalerts.datasubscription.md)
-</td><td>
-</td><td>
-Subscription
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[displayState](./foundation-alerts.foundationalerts.displaystate.md)
-</td><td>
-</td><td>
-displayState
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[filters](./foundation-alerts.foundationalerts.filters.md)
-</td><td>
-</td><td>
-{ name: string; callback: () =&gt; void; icon: { name: string; }; }\[\]
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[items](./foundation-alerts.foundationalerts.items.md)
-</td><td>
-</td><td>
-AlertRule\[\]
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[ready](./foundation-alerts.foundationalerts.ready.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-**_(BETA)_**
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[connectedCallback()](./foundation-alerts.foundationalerts.connectedcallback.md)
-</td><td>
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[criteriaFromFiltersChanged()](./foundation-alerts.foundationalerts.criteriafromfilterschanged.md)
-</td><td>
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[delete(id)](./foundation-alerts.foundationalerts.delete.md)
-</td><td>
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[disconnectedCallback()](./foundation-alerts.foundationalerts.disconnectedcallback.md)
-</td><td>
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[handleAddAlertAction()](./foundation-alerts.foundationalerts.handleaddalertaction.md)
-</td><td>
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[handleEditAlertAction(item)](./foundation-alerts.foundationalerts.handleeditalertaction.md)
-</td><td>
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[toogleStatus({ RULE\_STATUS, DYNAMIC\_NOTIFY\_RULE\_ID: ID, })](./foundation-alerts.foundationalerts.tooglestatus.md)
-</td><td>
-</td><td>
-**_(BETA)_**
-</td></tr>
-</tbody></table>

package/docs/api/foundation-alerts.foundationalerts.ready.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [ready](./foundation-alerts.foundationalerts.ready.md)
-## FoundationAlerts.ready property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-ready: boolean;
-```

package/docs/api/foundation-alerts.foundationalerts.tooglestatus.md DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [toogleStatus](./foundation-alerts.foundationalerts.tooglestatus.md)
-## FoundationAlerts.toogleStatus() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-toogleStatus({ RULE_STATUS, DYNAMIC_NOTIFY_RULE_ID: ID, }: AlertRuleRow): Promise<Message>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-{ RULE\_STATUS, DYNAMIC\_NOTIFY\_RULE\_ID: ID, }
-</td><td>
-AlertRuleRow
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;Message&gt;

package/docs/api/foundation-alerts.foundationalertsstyles.md DELETED Viewed

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlertsStyles](./foundation-alerts.foundationalertsstyles.md)
-## FoundationAlertsStyles variable
-**Signature:**
-```typescript
-FoundationAlertsStyles: import("@microsoft/fast-element").ElementStyles
-```

package/docs/api/foundation-alerts.foundationalertstemplate.md DELETED Viewed

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlertsTemplate](./foundation-alerts.foundationalertstemplate.md)
-## FoundationAlertsTemplate variable
-**Signature:**
-```typescript
-FoundationAlertsTemplate: import("@microsoft/fast-element").ViewTemplate<FoundationAlerts, any>
-```

package/docs/api/foundation-alerts.md DELETED Viewed

@@ -1,141 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md)
-## foundation-alerts package
-## Classes
-<table><thead><tr><th>
-Class
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[FoundationAlerts](./foundation-alerts.foundationalerts.md)
-</td><td>
-**_(BETA)_** Foundation alerts component for handle alerts rules list Allow creating, disabling and deleting alerts
-</td></tr>
-<tr><td>
-[ZeroAlerts](./foundation-alerts.zeroalerts.md)
-</td><td>
-ZeroAlerts.
-</td></tr>
-</tbody></table>
-## Functions
-<table><thead><tr><th>
-Function
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[configure(config)](./foundation-alerts.configure.md)
-</td><td>
-configure.
-</td></tr>
-</tbody></table>
-## Interfaces
-<table><thead><tr><th>
-Interface
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[AlertConfig](./foundation-alerts.alertconfig.md)
-</td><td>
-AlertConfig DI interface.
-</td></tr>
-</tbody></table>
-## Variables
-<table><thead><tr><th>
-Variable
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[defaultAlertConfig](./foundation-alerts.defaultalertconfig.md)
-</td><td>
-Default AlertConfig DI implementation.
-</td></tr>
-<tr><td>
-[FoundationAlertsStyles](./foundation-alerts.foundationalertsstyles.md)
-</td><td>
-</td></tr>
-<tr><td>
-[FoundationAlertsTemplate](./foundation-alerts.foundationalertstemplate.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-alerts.zeroalerts.md DELETED Viewed

@@ -1,39 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [ZeroAlerts](./foundation-alerts.zeroalerts.md)
-## ZeroAlerts class
-ZeroAlerts.
-**Signature:**
-```typescript
-export declare class ZeroAlerts extends FoundationAlerts
-```
-**Extends:** [FoundationAlerts](./foundation-alerts.foundationalerts.md)
-## Remarks
-A zero version that pre-registers zero components and uses the zero design system. ZeroAlerts and its components won't bloat the core bundle as these are only loaded on-demand when in use.
-## Example 1
-```ts
-import { ZeroAlerts } from '@genesislcap/foundation-alerts';
-...
-ZeroAlerts
-```
-## Example 2
-Load the micro frontend on-demand
-```ts
-  const { ZeroAlerts } = await import('@genesislcap/foundation-alerts');
-  return ZeroAlerts;
-},
-```

package/docs/api/index.md DELETED Viewed

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md)
-## API Reference
-## Packages
-<table><thead><tr><th>
-Package
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[@genesislcap/foundation-alerts](./foundation-alerts.md)
-</td><td>
-</td></tr>
-</tbody></table>