@genesislcap/foundation-utils 14.310.2 → 14.311.1-alpha-3bdf18f.0

package/docs/api/foundation-utils.foundationshortcutlistener.md

@@ -0,0 +1,105 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [FoundationShortcutListener](./foundation-utils.foundationshortcutlistener.md)
+
+## FoundationShortcutListener class
+
+A custom element that listens for keyboard shortcuts.
+
+**Signature:**
+
+```typescript
+export declare class FoundationShortcutListener extends FASTElement 
+```
+**Extends:** FASTElement
+
+## Remarks
+
+Part of the ShortcutManager Service.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[shortcutManager](./foundation-utils.foundationshortcutlistener.shortcutmanager.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ShortcutManager](./foundation-utils.shortcutmanager.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[connectedCallback()](./foundation-utils.foundationshortcutlistener.connectedcallback.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[disconnectedCallback()](./foundation-utils.foundationshortcutlistener.disconnectedcallback.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-utils.foundationshortcutlistener.shortcutmanager.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [FoundationShortcutListener](./foundation-utils.foundationshortcutlistener.md) &gt; [shortcutManager](./foundation-utils.foundationshortcutlistener.shortcutmanager.md)
+
+## FoundationShortcutListener.shortcutManager property
+
+**Signature:**
+
+```typescript
+shortcutManager: ShortcutManager;
+```

package/docs/api/foundation-utils.md

@@ -37,6 +37,28 @@ Description
 The default `ServerRowDTOMapper`<!-- -->.
 
 
+</td></tr>
+<tr><td>
+
+[DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md)
+
+
+</td><td>
+
+Default implementation of the ShortcutManager interface
+
+
+</td></tr>
+<tr><td>
+
+[FoundationShortcutListener](./foundation-utils.foundationshortcutlistener.md)
+
+
+</td><td>
+
+A custom element that listens for keyboard shortcuts.
+
+
 </td></tr>
 <tr><td>
 
@@ -728,6 +750,39 @@ Represents an event observer that manages the subscription and publication of ev
 A mapper for converting between server row DTOs and entities. Provides methods to get/set a ServerRow DTO entity mapping.
 
 
+</td></tr>
+<tr><td>
+
+[ShortcutDefinition](./foundation-utils.shortcutdefinition.md)
+
+
+</td><td>
+
+A definition of a keyboard shortcut
+
+
+</td></tr>
+<tr><td>
+
+[ShortcutManager](./foundation-utils.shortcutmanager.md)
+
+
+</td><td>
+
+Interface of a manager for keyboard shortcuts
+
+
+</td></tr>
+<tr><td>
+
+[ShortcutRegistrationResult](./foundation-utils.shortcutregistrationresult.md)
+
+
+</td><td>
+
+A result of registering a keyboard shortcut
+
+
 </td></tr>
 <tr><td>
 
@@ -1112,6 +1167,17 @@ An object that defines two resource types: "local" and "remote".
 A DI token used to obtain a `ServerRowDTOMapper` instance.
 
 
+</td></tr>
+<tr><td>
+
+[ShortcutManager](./foundation-utils.shortcutmanager.md)
+
+
+</td><td>
+
+A dependency injection token for the ShortcutManager interface.
+
+
 </td></tr>
 <tr><td>
 
@@ -1331,6 +1397,17 @@ The data for a server row DTO.
 The data for a server row entity.
 
 
+</td></tr>
+<tr><td>
+
+[ShortcutExecutionStatus](./foundation-utils.shortcutexecutionstatus.md)
+
+
+</td><td>
+
+A type which represents the disabled status and tooltip of an item
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/foundation-utils.shortcutdefinition.action.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ShortcutDefinition](./foundation-utils.shortcutdefinition.md) &gt; [action](./foundation-utils.shortcutdefinition.action.md)
+
+## ShortcutDefinition.action property
+
+**Signature:**
+
+```typescript
+action: () => void;
+```

package/docs/api/foundation-utils.shortcutdefinition.altkey.md

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

package/docs/api/foundation-utils.shortcutdefinition.canexecute.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ShortcutDefinition](./foundation-utils.shortcutdefinition.md) &gt; [canExecute](./foundation-utils.shortcutdefinition.canexecute.md)
+
+## ShortcutDefinition.canExecute property
+
+**Signature:**
+
+```typescript
+canExecute?: () => ShortcutExecutionStatus;
+```

package/docs/api/foundation-utils.shortcutdefinition.context.md

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

package/docs/api/foundation-utils.shortcutdefinition.ctrlkey.md

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

package/docs/api/foundation-utils.shortcutdefinition.description.md

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

package/docs/api/foundation-utils.shortcutdefinition.elementref.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ShortcutDefinition](./foundation-utils.shortcutdefinition.md) &gt; [elementRef](./foundation-utils.shortcutdefinition.elementref.md)
+
+## ShortcutDefinition.elementRef property
+
+**Signature:**
+
+```typescript
+elementRef?: HTMLElement;
+```

package/docs/api/foundation-utils.shortcutdefinition.id.md

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

package/docs/api/foundation-utils.shortcutdefinition.key.md

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

package/docs/api/foundation-utils.shortcutdefinition.md

@@ -0,0 +1,276 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ShortcutDefinition](./foundation-utils.shortcutdefinition.md)
+
+## ShortcutDefinition interface
+
+A definition of a keyboard shortcut
+
+**Signature:**
+
+```typescript
+export interface ShortcutDefinition 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[action](./foundation-utils.shortcutdefinition.action.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; void
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[altKey?](./foundation-utils.shortcutdefinition.altkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[canExecute?](./foundation-utils.shortcutdefinition.canexecute.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; [ShortcutExecutionStatus](./foundation-utils.shortcutexecutionstatus.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[context](./foundation-utils.shortcutdefinition.context.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[ctrlKey?](./foundation-utils.shortcutdefinition.ctrlkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[description](./foundation-utils.shortcutdefinition.description.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[elementRef?](./foundation-utils.shortcutdefinition.elementref.md)
+
+
+</td><td>
+
+
+</td><td>
+
+HTMLElement
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[id](./foundation-utils.shortcutdefinition.id.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[key](./foundation-utils.shortcutdefinition.key.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[metaKey?](./foundation-utils.shortcutdefinition.metakey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[optionKey?](./foundation-utils.shortcutdefinition.optionkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[priority?](./foundation-utils.shortcutdefinition.priority.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[shiftKey?](./foundation-utils.shortcutdefinition.shiftkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-utils.shortcutdefinition.metakey.md

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

package/docs/api/foundation-utils.shortcutdefinition.optionkey.md

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

package/docs/api/foundation-utils.shortcutdefinition.priority.md

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

package/docs/api/foundation-utils.shortcutdefinition.shiftkey.md

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

package/docs/api/foundation-utils.shortcutexecutionstatus.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ShortcutExecutionStatus](./foundation-utils.shortcutexecutionstatus.md)
+
+## ShortcutExecutionStatus type
+
+A type which represents the disabled status and tooltip of an item
+
+**Signature:**
+
+```typescript
+export type ShortcutExecutionStatus = {
+    disabled?: boolean;
+    tooltip?: string;
+};
+```

package/docs/api/foundation-utils.shortcutmanager.clearactivecontext.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ShortcutManager](./foundation-utils.shortcutmanager.md) &gt; [clearActiveContext](./foundation-utils.shortcutmanager.clearactivecontext.md)
+
+## ShortcutManager.clearActiveContext() method
+
+**Signature:**
+
+```typescript
+clearActiveContext(): void;
+```
+**Returns:**
+
+void
+