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

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

@@ -0,0 +1,58 @@
+<!-- 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; [executeShortcut](./foundation-utils.shortcutmanager.executeshortcut.md)
+
+## ShortcutManager.executeShortcut() method
+
+Execute a shortcut by its id
+
+**Signature:**
+
+```typescript
+executeShortcut(id: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+id
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The id of the shortcut to execute
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+
+## Remarks
+
+This method will execute the shortcut in the active context
+

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

@@ -0,0 +1,70 @@
+<!-- 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; [executeShortcutByContext](./foundation-utils.shortcutmanager.executeshortcutbycontext.md)
+
+## ShortcutManager.executeShortcutByContext() method
+
+Execute a shortcut by its id and context
+
+**Signature:**
+
+```typescript
+executeShortcutByContext(context: string, id: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The context of the shortcut to execute
+
+
+</td></tr>
+<tr><td>
+
+id
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The id of the shortcut to execute
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,114 @@
+<!-- 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; [findShortcutByKeyCombination](./foundation-utils.shortcutmanager.findshortcutbykeycombination.md)
+
+## ShortcutManager.findShortcutByKeyCombination() method
+
+**Signature:**
+
+```typescript
+findShortcutByKeyCombination(key: string, ctrlKey?: boolean, altKey?: boolean, shiftKey?: boolean, metaKey?: boolean): ShortcutDefinition | undefined;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+key
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ctrlKey
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+altKey
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+shiftKey
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+metaKey
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[ShortcutDefinition](./foundation-utils.shortcutdefinition.md) \| undefined
+

package/docs/api/foundation-utils.shortcutmanager.getactivecontext.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; [getActiveContext](./foundation-utils.shortcutmanager.getactivecontext.md)
+
+## ShortcutManager.getActiveContext() method
+
+**Signature:**
+
+```typescript
+getActiveContext(): string | undefined;
+```
+**Returns:**
+
+string \| undefined
+

package/docs/api/foundation-utils.shortcutmanager.getcontexts.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; [getContexts](./foundation-utils.shortcutmanager.getcontexts.md)
+
+## ShortcutManager.getContexts() method
+
+**Signature:**
+
+```typescript
+getContexts(): string[];
+```
+**Returns:**
+
+string\[\]
+

package/docs/api/foundation-utils.shortcutmanager.getshortcuts.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; [getShortcuts](./foundation-utils.shortcutmanager.getshortcuts.md)
+
+## ShortcutManager.getShortcuts() method
+
+**Signature:**
+
+```typescript
+getShortcuts(): ShortcutDefinition[];
+```
+**Returns:**
+
+[ShortcutDefinition](./foundation-utils.shortcutdefinition.md)<!-- -->\[\]
+

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

@@ -0,0 +1,50 @@
+<!-- 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; [getShortcutsByContext](./foundation-utils.shortcutmanager.getshortcutsbycontext.md)
+
+## ShortcutManager.getShortcutsByContext() method
+
+**Signature:**
+
+```typescript
+getShortcutsByContext(context: string): ShortcutDefinition[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[ShortcutDefinition](./foundation-utils.shortcutdefinition.md)<!-- -->\[\]
+

package/docs/api/foundation-utils.shortcutmanager.getshortcutsbycontextmap.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; [getShortcutsByContextMap](./foundation-utils.shortcutmanager.getshortcutsbycontextmap.md)
+
+## ShortcutManager.getShortcutsByContextMap() method
+
+**Signature:**
+
+```typescript
+getShortcutsByContextMap(): Map<string, Map<string, ShortcutDefinition>>;
+```
+**Returns:**
+
+Map&lt;string, Map&lt;string, [ShortcutDefinition](./foundation-utils.shortcutdefinition.md)<!-- -->&gt;&gt;
+

package/docs/api/foundation-utils.shortcutmanager.ispaused.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; [ShortcutManager](./foundation-utils.shortcutmanager.md) &gt; [isPaused](./foundation-utils.shortcutmanager.ispaused.md)
+
+## ShortcutManager.isPaused property
+
+**Signature:**
+
+```typescript
+isPaused: boolean;
+```

package/docs/api/foundation-utils.shortcutmanager.ispaused_.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; [ShortcutManager](./foundation-utils.shortcutmanager.md) &gt; [isPaused$](./foundation-utils.shortcutmanager.ispaused_.md)
+
+## ShortcutManager.isPaused$ property
+
+**Signature:**
+
+```typescript
+isPaused$: Observable<boolean>;
+```

package/docs/api/foundation-utils.shortcutmanager.ispausedsubject.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; [ShortcutManager](./foundation-utils.shortcutmanager.md) &gt; [isPausedSubject](./foundation-utils.shortcutmanager.ispausedsubject.md)
+
+## ShortcutManager.isPausedSubject property
+
+**Signature:**
+
+```typescript
+isPausedSubject: BehaviorSubject<boolean>;
+```

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

@@ -0,0 +1,13 @@
+<!-- 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)
+
+## ShortcutManager variable
+
+A dependency injection token for the ShortcutManager interface.
+
+**Signature:**
+
+```typescript
+ShortcutManager: import("@microsoft/fast-foundation").InterfaceSymbol<ShortcutManager>
+```

package/docs/api/foundation-utils.shortcutmanager.pause.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; [pause](./foundation-utils.shortcutmanager.pause.md)
+
+## ShortcutManager.pause() method
+
+**Signature:**
+
+```typescript
+pause(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,50 @@
+<!-- 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; [registerContext](./foundation-utils.shortcutmanager.registercontext.md)
+
+## ShortcutManager.registerContext() method
+
+**Signature:**
+
+```typescript
+registerContext(context: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,50 @@
+<!-- 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; [registerShortcut](./foundation-utils.shortcutmanager.registershortcut.md)
+
+## ShortcutManager.registerShortcut() method
+
+**Signature:**
+
+```typescript
+registerShortcut(shortcut: ShortcutDefinition): ShortcutRegistrationResult;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+shortcut
+
+
+</td><td>
+
+[ShortcutDefinition](./foundation-utils.shortcutdefinition.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[ShortcutRegistrationResult](./foundation-utils.shortcutregistrationresult.md)
+

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

@@ -0,0 +1,50 @@
+<!-- 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; [registerShortcuts](./foundation-utils.shortcutmanager.registershortcuts.md)
+
+## ShortcutManager.registerShortcuts() method
+
+**Signature:**
+
+```typescript
+registerShortcuts(shortcuts: ShortcutDefinition[]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+shortcuts
+
+
+</td><td>
+
+[ShortcutDefinition](./foundation-utils.shortcutdefinition.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.shortcutmanager.resume.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; [resume](./foundation-utils.shortcutmanager.resume.md)
+
+## ShortcutManager.resume() method
+
+**Signature:**
+
+```typescript
+resume(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,50 @@
+<!-- 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; [setActiveContext](./foundation-utils.shortcutmanager.setactivecontext.md)
+
+## ShortcutManager.setActiveContext() method
+
+**Signature:**
+
+```typescript
+setActiveContext(context: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+