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

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

package/docs/api/foundation-utils.shortcutregistrationresult.tooltip.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-utils](./foundation-utils.md) &gt; [ShortcutRegistrationResult](./foundation-utils.shortcutregistrationresult.md) &gt; [tooltip](./foundation-utils.shortcutregistrationresult.tooltip.md)
-## ShortcutRegistrationResult.tooltip property
-**Signature:**
-```typescript
-tooltip: () => string | undefined;
-```

package/docs/api/foundation-utils.slottedstyles.md DELETED Viewed

@@ -1,93 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [SlottedStyles](./foundation-utils.slottedstyles.md)
-## SlottedStyles class
-A custom element that encapsulates a set of styles that can be applied to slotted elements.
-**Signature:**
-```typescript
-export declare class SlottedStyles 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>
-[styles](./foundation-utils.slottedstyles.styles.md)
-</td><td>
-</td><td>
-ElementStyles
-</td><td>
-The styles to apply to slotted elements.
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[stylesChanged(prev, next)](./foundation-utils.slottedstyles.styleschanged.md)
-</td><td>
-</td><td>
-Called when the `styles` property changes. Removes the previous styles from the parent element's FAST controller and adds the new styles.
-</td></tr>
-</tbody></table>

package/docs/api/foundation-utils.slottedstyles.styles.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-utils](./foundation-utils.md) &gt; [SlottedStyles](./foundation-utils.slottedstyles.md) &gt; [styles](./foundation-utils.slottedstyles.styles.md)
-## SlottedStyles.styles property
-The styles to apply to slotted elements.
-**Signature:**
-```typescript
-styles: ElementStyles;
-```

package/docs/api/foundation-utils.slottedstyles.styleschanged.md DELETED Viewed

@@ -1,70 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [SlottedStyles](./foundation-utils.slottedstyles.md) &gt; [stylesChanged](./foundation-utils.slottedstyles.styleschanged.md)
-## SlottedStyles.stylesChanged() method
-Called when the `styles` property changes. Removes the previous styles from the parent element's FAST controller and adds the new styles.
-**Signature:**
-```typescript
-stylesChanged(prev: ElementStyles, next: ElementStyles): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-prev
-</td><td>
-ElementStyles
-</td><td>
-The previous value of the `styles` property.
-</td></tr>
-<tr><td>
-next
-</td><td>
-ElementStyles
-</td><td>
-The new value of the `styles` property.
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-utils.socket_ext.md DELETED Viewed

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [SOCKET\_EXT](./foundation-utils.socket_ext.md)
-## SOCKET\_EXT variable
-The sub-path used for WebSocket connections when API\_HOST is not set
-**Signature:**
-```typescript
-_SOCKET_EXT: string
-```
-## Remarks
-Optional.
-## Example
-If `API_HOST` is not set, `SOCKET_EXT` is set to `/custom` and UI is served on `https://localhost:1234` API host URL will be `wss://localhost:1234/custom`

package/docs/api/foundation-utils.sso_list_url.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-utils](./foundation-utils.md) &gt; [SSO\_LIST\_URL](./foundation-utils.sso_list_url.md)
-## SSO\_LIST\_URL variable
-**Signature:**
-```typescript
-SSO_LIST_URL: string
-```

package/docs/api/foundation-utils.sso_login_url.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-utils](./foundation-utils.md) &gt; [SSO\_LOGIN\_URL](./foundation-utils.sso_login_url.md)
-## SSO\_LOGIN\_URL variable
-**Signature:**
-```typescript
-SSO_LOGIN_URL: string
-```

package/docs/api/foundation-utils.stringarrayconverter.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [stringArrayConverter](./foundation-utils.stringarrayconverter.md)
-## stringArrayConverter variable
-A  that converts between comma-separated string attributes and `string | string[]` properties.
-**Signature:**
-```typescript
-stringArrayConverter: ValueConverter
-```
-## Remarks
-- fromView: "A,B,C" → \["A","B","C"\], "A" → "A", "" → undefined - toView: \["A","B","C"\] → "A,B,C", "A" → "A", undefined → ""

package/docs/api/foundation-utils.subscribe.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Subscribe](./foundation-utils.subscribe.md)
-## Subscribe type
-Subscribes a listener function to receive events of a specific type.
-**Signature:**
-```typescript
-export type Subscribe<EventType> = (listener: Listener<EventType>) => () => void;
-```
-**References:** [Listener](./foundation-utils.listener.md)

package/docs/api/foundation-utils.sync.md DELETED Viewed

@@ -1,100 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [sync](./foundation-utils.sync.md)
-## sync() function
-Creates a synchronization directive that binds a data source to an HTML element,
-**Signature:**
-```typescript
-export declare function sync<TSource = any, TReturn = any>(binding: Binding<TSource, TReturn>, conversionType?: ConversionType, eventName?: EventName, keyAttr?: string): CaptureType<TSource>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-binding
-</td><td>
-Binding&lt;TSource, TReturn&gt;
-</td><td>
-</td></tr>
-<tr><td>
-conversionType
-</td><td>
-[ConversionType](./foundation-utils.conversiontype.md)
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-eventName
-</td><td>
-[EventName](./foundation-utils.eventname.md)
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-keyAttr
-</td><td>
-string
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>
-**Returns:**
-CaptureType&lt;TSource&gt;

package/docs/api/foundation-utils.toelementstyles.md DELETED Viewed

@@ -1,58 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [toElementStyles](./foundation-utils.toelementstyles.md)
-## toElementStyles() function
-toElementStyles.
-**Signature:**
-```typescript
-export declare function toElementStyles(styles: ComposableStyles | ComposableStyles[]): ElementStyles;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-styles
-</td><td>
-ComposableStyles \| ComposableStyles\[\]
-</td><td>
-ComposableStyles or a ComposableStyles array.
-</td></tr>
-</tbody></table>
-**Returns:**
-ElementStyles
-## Remarks
-Converts  or a ComposableStyles array to .

package/docs/api/foundation-utils.typerampvalues.md DELETED Viewed

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [TypeRampValues](./foundation-utils.typerampvalues.md)
-## TypeRampValues variable
-An object containing type ramp values.
-**Signature:**
-```typescript
-TypeRampValues: {
-    readonly minusOne: -1;
-    readonly minusTwo: -2;
-    readonly plusOne: 1;
-    readonly plusTwo: 2;
-    readonly plusThree: 3;
-    readonly plusFour: 4;
-    readonly plusFive: 5;
-    readonly plusSix: 6;
-}
-```

package/docs/api/foundation-utils.uuid.createid.md DELETED Viewed

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [UUID](./foundation-utils.uuid.md) &gt; [createId](./foundation-utils.uuid.createid.md)
-## UUID.createId() method
-Generates a new UUID.
-**Signature:**
-```typescript
-createId(withLogging?: boolean): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-withLogging
-</td><td>
-boolean
-</td><td>
-_(Optional)_ Optional. Whether to log the generated UUID to the console. Defaults to false.
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-The generated UUID.

package/docs/api/foundation-utils.uuid.createremoteid.md DELETED Viewed

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [UUID](./foundation-utils.uuid.md) &gt; [createRemoteId](./foundation-utils.uuid.createremoteid.md)
-## UUID.createRemoteId() method
-Generates a new UUID for a remote object.
-**Signature:**
-```typescript
-createRemoteId(withLogging?: boolean): Promise<string>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-withLogging
-</td><td>
-boolean
-</td><td>
-_(Optional)_ Optional. Whether to log the generated UUID to the console. Defaults to false.
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;string&gt;
-A promise that resolves to the generated UUID.

package/docs/api/foundation-utils.uuid.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-utils](./foundation-utils.md) &gt; [UUID](./foundation-utils.uuid.md)
-## UUID variable
-A dependency injection token for the UUID interface.
-**Signature:**
-```typescript
-UUID: import("@microsoft/fast-foundation").InterfaceSymbol<UUID>
-```

package/docs/api/foundation-utils.uuidconfig.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-utils](./foundation-utils.md) &gt; [UUIDConfig](./foundation-utils.uuidconfig.md)
-## UUIDConfig interface
-A configuration object for customizing UUID generation.
-**Signature:**
-```typescript
-export interface UUIDConfig
-```