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

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

package/docs/api/foundation-shell.defaultapp.md DELETED Viewed

@@ -1,412 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md)
-## DefaultApp class
-Default App implementation.
-**Signature:**
-```typescript
-export declare class DefaultApp implements App
-```
-**Implements:** [App](./foundation-shell.app.md)
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[elements](./foundation-shell.defaultapp.elements.md)
-</td><td>
-</td><td>
-[AppElement](./foundation-shell.appelement.md)<!-- -->\[\]
-</td><td>
-All [AppElement](./foundation-shell.appelement.md) tokens.
-</td></tr>
-<tr><td>
-[metadata](./foundation-shell.defaultapp.metadata.md)
-</td><td>
-</td><td>
-[AppMetadata](./foundation-shell.appmetadata.md)<!-- -->\[\]
-</td><td>
-All [AppMetadata](./foundation-shell.appmetadata.md) tokens.
-</td></tr>
-<tr><td>
-[registrations](./foundation-shell.defaultapp.registrations.md)
-</td><td>
-</td><td>
-[AppRegistration](./foundation-shell.appregistration.md)<!-- -->\[\]
-</td><td>
-All [AppRegistration](./foundation-shell.appregistration.md) tokens.
-</td></tr>
-<tr><td>
-[routes](./foundation-shell.defaultapp.routes.md)
-</td><td>
-</td><td>
-[AppRoute](./foundation-shell.approute.md)<!-- -->\[\]
-</td><td>
-All [AppRoute](./foundation-shell.approute.md) tokens.
-</td></tr>
-<tr><td>
-[stores](./foundation-shell.defaultapp.stores.md)
-</td><td>
-</td><td>
-[AppStore](./foundation-shell.appstore.md)<!-- -->\[\]
-</td><td>
-All [AppStore](./foundation-shell.appstore.md) tokens.
-</td></tr>
-<tr><td>
-[styles](./foundation-shell.defaultapp.styles.md)
-</td><td>
-</td><td>
-[AppStyle](./foundation-shell.appstyle.md)<!-- -->\[\]
-</td><td>
-All [AppStyle](./foundation-shell.appstyle.md) tokens.
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[deregisterAssets()](./foundation-shell.defaultapp.deregisterassets.md)
-</td><td>
-</td><td>
-Deregister assets.
-</td></tr>
-<tr><td>
-[deregisterElement(element)](./foundation-shell.defaultapp.deregisterelement.md)
-</td><td>
-</td><td>
-API for developers to deregister [AppElements](./foundation-shell.appelement.md)<!-- -->.
-</td></tr>
-<tr><td>
-[deregisterRoute(route)](./foundation-shell.defaultapp.deregisterroute.md)
-</td><td>
-</td><td>
-API for developers to deregister [AppRoutes](./foundation-shell.approute.md)<!-- -->.
-</td></tr>
-<tr><td>
-[deregisterStore(store)](./foundation-shell.defaultapp.deregisterstore.md)
-</td><td>
-</td><td>
-API for developers to deregister [AppStores](./foundation-shell.appstore.md)<!-- -->.
-</td></tr>
-<tr><td>
-[deregisterStyle(style)](./foundation-shell.defaultapp.deregisterstyle.md)
-</td><td>
-</td><td>
-API for developers to deregister [AppStyles](./foundation-shell.appstyle.md)<!-- -->.
-</td></tr>
-<tr><td>
-[hasAssets()](./foundation-shell.defaultapp.hasassets.md)
-</td><td>
-</td><td>
-Check if the App has registered assets.
-</td></tr>
-<tr><td>
-[isValid(context)](./foundation-shell.defaultapp.isvalid.md)
-</td><td>
-</td><td>
-Monitors metadata and other data points as assets are registered and deregistered for app validity.
-</td></tr>
-<tr><td>
-[registerAssets(assets)](./foundation-shell.defaultapp.registerassets.md)
-</td><td>
-</td><td>
-Register assets from either a globed dynamic import or some predefined AppAssets instance. This is a one time operation. Assets had be subsequently registered and deregistered using their individual APIs.
-</td></tr>
-<tr><td>
-[registerComponents(context)](./foundation-shell.defaultapp.registercomponents.md)
-</td><td>
-</td><td>
-API for Application and Seed authors to register dynamic components.
-</td></tr>
-<tr><td>
-[registerElement(element)](./foundation-shell.defaultapp.registerelement.md)
-</td><td>
-</td><td>
-API for developers to register [AppElements](./foundation-shell.appelement.md) lazily.
-</td></tr>
-<tr><td>
-[registerElementsTarget(targetId, predicate, repeatOptions)](./foundation-shell.defaultapp.registerelementstarget.md)
-</td><td>
-</td><td>
-API for Application and Seed authors to define dynamic [AppElement](./foundation-shell.appelement.md) integration points.
-</td></tr>
-<tr><td>
-[registerRoute(route)](./foundation-shell.defaultapp.registerroute.md)
-</td><td>
-</td><td>
-API for developers to register [AppRoutes](./foundation-shell.approute.md) lazily.
-</td></tr>
-<tr><td>
-[registerRouteCollection(routeCollection, predicate)](./foundation-shell.defaultapp.registerroutecollection.md)
-</td><td>
-</td><td>
-API for Application and Seed authors to register the main .
-</td></tr>
-<tr><td>
-[registerStore(store)](./foundation-shell.defaultapp.registerstore.md)
-</td><td>
-</td><td>
-API for developers to register [AppStores](./foundation-shell.appstore.md) lazily.
-</td></tr>
-<tr><td>
-[registerStoreRoot(storeRoot, predicate)](./foundation-shell.defaultapp.registerstoreroot.md)
-</td><td>
-</td><td>
-API for Application and Seed authors to register the .
-</td></tr>
-<tr><td>
-[registerStyle(style)](./foundation-shell.defaultapp.registerstyle.md)
-</td><td>
-</td><td>
-API for developers to register [AppStyles](./foundation-shell.appstyle.md) lazily.
-</td></tr>
-<tr><td>
-[registerStylesTarget(targetId, predicate)](./foundation-shell.defaultapp.registerstylestarget.md)
-</td><td>
-</td><td>
-API for Application and Seed authors to define dynamic [AppStyle](./foundation-shell.appstyle.md) integration points.
-</td></tr>
-</tbody></table>

package/docs/api/foundation-shell.defaultapp.metadata.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-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [metadata](./foundation-shell.defaultapp.metadata.md)
-## DefaultApp.metadata property
-All [AppMetadata](./foundation-shell.appmetadata.md) tokens.
-**Signature:**
-```typescript
-metadata: AppMetadata[];
-```

package/docs/api/foundation-shell.defaultapp.registerassets.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-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerAssets](./foundation-shell.defaultapp.registerassets.md)
-## DefaultApp.registerAssets() method
-Register assets from either a globed dynamic import or some predefined AppAssets instance. This is a one time operation. Assets had be subsequently registered and deregistered using their individual APIs.
-**Signature:**
-```typescript
-registerAssets(assets: any): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-assets
-</td><td>
-any
-</td><td>
-[AppAssets](./foundation-shell.appassets.md)<!-- -->.
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-shell.defaultapp.registercomponents.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-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerComponents](./foundation-shell.defaultapp.registercomponents.md)
-## DefaultApp.registerComponents() method
-API for Application and Seed authors to register dynamic components.
-**Signature:**
-```typescript
-registerComponents(context: any): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-context
-</td><td>
-any
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-shell.defaultapp.registerelement.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-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerElement](./foundation-shell.defaultapp.registerelement.md)
-## DefaultApp.registerElement() method
-API for developers to register [AppElements](./foundation-shell.appelement.md) lazily.
-**Signature:**
-```typescript
-registerElement(element: any): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-element
-</td><td>
-any
-</td><td>
-The [AppElement](./foundation-shell.appelement.md) to register.
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-shell.defaultapp.registerelementstarget.md DELETED Viewed

@@ -1,88 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerElementsTarget](./foundation-shell.defaultapp.registerelementstarget.md)
-## DefaultApp.registerElementsTarget() method
-API for Application and Seed authors to define dynamic [AppElement](./foundation-shell.appelement.md) integration points.
-**Signature:**
-```typescript
-registerElementsTarget(targetId: any, predicate: any, repeatOptions?: import("@microsoft/fast-element").RepeatOptions): import("@microsoft/fast-element").ViewTemplate<any, any>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-targetId
-</td><td>
-any
-</td><td>
-[AppTargetId](./foundation-shell.apptargetid.md)<!-- -->.
-</td></tr>
-<tr><td>
-predicate
-</td><td>
-any
-</td><td>
-Optional [AppElementPredicate](./foundation-shell.appelementpredicate.md)<!-- -->.
-</td></tr>
-<tr><td>
-repeatOptions
-</td><td>
-import("@microsoft/fast-element").RepeatOptions
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>
-**Returns:**
-import("@microsoft/fast-element").ViewTemplate&lt;any, any&gt;
-A  fragment that will stay in sync as elements are registered and deregistered.

package/docs/api/foundation-shell.defaultapp.registerroute.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-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerRoute](./foundation-shell.defaultapp.registerroute.md)
-## DefaultApp.registerRoute() method
-API for developers to register [AppRoutes](./foundation-shell.approute.md) lazily.
-**Signature:**
-```typescript
-registerRoute(route: any): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-route
-</td><td>
-any
-</td><td>
-The [AppRoute](./foundation-shell.approute.md) to register.
-</td></tr>
-</tbody></table>
-**Returns:**
-void