@genesislcap/foundation-utils 14.311.0 → 14.312.0

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

@@ -0,0 +1,64 @@
+<!-- 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; [unregisterShortcut](./foundation-utils.shortcutmanager.unregistershortcut.md)
+
+## ShortcutManager.unregisterShortcut() method
+
+**Signature:**
+
+```typescript
+unregisterShortcut(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>
+
+
+</td></tr>
+<tr><td>
+
+id
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.shortcutmanager.unregistershortcutsbycontext.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; [unregisterShortcutsByContext](./foundation-utils.shortcutmanager.unregistershortcutsbycontext.md)
+
+## ShortcutManager.unregisterShortcutsByContext() method
+
+**Signature:**
+
+```typescript
+unregisterShortcutsByContext(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.shortcutregistrationresult.disabled.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; [ShortcutRegistrationResult](./foundation-utils.shortcutregistrationresult.md) &gt; [disabled](./foundation-utils.shortcutregistrationresult.disabled.md)
+
+## ShortcutRegistrationResult.disabled property
+
+**Signature:**
+
+```typescript
+disabled: () => boolean;
+```

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

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

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

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

@@ -0,0 +1,141 @@
+<!-- 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)
+
+## ShortcutRegistrationResult interface
+
+A result of registering a keyboard shortcut
+
+**Signature:**
+
+```typescript
+export interface ShortcutRegistrationResult 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[disabled](./foundation-utils.shortcutregistrationresult.disabled.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[id](./foundation-utils.shortcutregistrationresult.id.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[keyCombination](./foundation-utils.shortcutregistrationresult.keycombination.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[keyCombinationDisplay](./foundation-utils.shortcutregistrationresult.keycombinationdisplay.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[shortcut](./foundation-utils.shortcutregistrationresult.shortcut.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ShortcutDefinition](./foundation-utils.shortcutdefinition.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[tooltip](./foundation-utils.shortcutregistrationresult.tooltip.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; string \| undefined
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

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

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

package/docs/api-report.md.api.md

@@ -4,6 +4,7 @@
 
 ```ts
 
+import { BehaviorSubject } from 'rxjs';
 import { Binding } from '@microsoft/fast-element';
 import { CaptureType } from '@microsoft/fast-element';
 import { ComposableStyles } from '@microsoft/fast-element';
@@ -18,6 +19,7 @@ import type { JSONSchema7 } from 'json-schema';
 import { Logger as Logger_2 } from '@genesislcap/foundation-logger';
 import { LoggerOptions as LoggerOptions_2 } from '@genesislcap/foundation-logger';
 import { LogLevel } from '@genesislcap/foundation-logger';
+import { Observable } from 'rxjs';
 import { SyntheticViewTemplate } from '@microsoft/fast-element';
 import { Types } from '@genesislcap/expression-builder';
 
@@ -177,6 +179,50 @@ export class DefaultServerRowDTOMapper implements ServerRowDTOMapper {
     toDTO: (entity: ServerRowEntity) => ServerRowDTO;
 }
 
+// @public
+export class DefaultShortcutManager implements ShortcutManager {
+    // (undocumented)
+    clearActiveContext(): void;
+    // (undocumented)
+    executeShortcut(id: string): void;
+    // (undocumented)
+    executeShortcutByContext(context: string, id: string): void;
+    // (undocumented)
+    findShortcutByKeyCombination(key: string, ctrlKey?: boolean, altKey?: boolean, shiftKey?: boolean, metaKey?: boolean): ShortcutDefinition | undefined;
+    // (undocumented)
+    getActiveContext(): string | undefined;
+    // (undocumented)
+    getContexts(): string[];
+    // (undocumented)
+    getShortcuts(): ShortcutDefinition[];
+    // (undocumented)
+    getShortcutsByContext(context: string): ShortcutDefinition[];
+    // (undocumented)
+    getShortcutsByContextMap(): Map<string, Map<string, ShortcutDefinition>>;
+    // (undocumented)
+    get isPaused$(): Observable<boolean>;
+    // (undocumented)
+    get isPaused(): boolean;
+    // (undocumented)
+    get isPausedSubject(): BehaviorSubject<boolean>;
+    // (undocumented)
+    pause(): void;
+    // (undocumented)
+    registerContext(context: string): void;
+    // (undocumented)
+    registerShortcut(shortcut: ShortcutDefinition): ShortcutRegistrationResult;
+    // (undocumented)
+    registerShortcuts(shortcuts: ShortcutDefinition[]): void;
+    // (undocumented)
+    resume(): void;
+    // (undocumented)
+    setActiveContext(context: string): void;
+    // (undocumented)
+    unregisterShortcut(context: string, id: string): void;
+    // (undocumented)
+    unregisterShortcutsByContext(context: string): void;
+}
+
 // @public
 export const delay: (ms: number) => Promise<void>;
 
@@ -285,6 +331,16 @@ export type FoundationLayoutContainer = {
     _key: 'foundation-layout';
 };
 
+// @public
+export class FoundationShortcutListener extends FASTElement {
+    // (undocumented)
+    connectedCallback(): void;
+    // (undocumented)
+    disconnectedCallback(): void;
+    // (undocumented)
+    shortcutManager: ShortcutManager;
+}
+
 // @public (undocumented)
 export namespace Genesis {
     const // (undocumented)
@@ -1290,6 +1346,103 @@ export type ServerRowEntity = {
     };
 };
 
+// @public
+export interface ShortcutDefinition {
+    // (undocumented)
+    action: () => void;
+    // (undocumented)
+    altKey?: boolean;
+    // (undocumented)
+    canExecute?: () => ShortcutExecutionStatus;
+    // (undocumented)
+    context: string;
+    // (undocumented)
+    ctrlKey?: boolean;
+    // (undocumented)
+    description: string;
+    // (undocumented)
+    elementRef?: HTMLElement;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    key: string;
+    // (undocumented)
+    metaKey?: boolean;
+    // (undocumented)
+    optionKey?: boolean;
+    // (undocumented)
+    priority?: number;
+    // (undocumented)
+    shiftKey?: boolean;
+}
+
+// @public
+export type ShortcutExecutionStatus = {
+    disabled?: boolean;
+    tooltip?: string;
+};
+
+// @public
+export interface ShortcutManager {
+    // (undocumented)
+    clearActiveContext(): void;
+    executeShortcut(id: string): void;
+    executeShortcutByContext(context: string, id: string): void;
+    // (undocumented)
+    findShortcutByKeyCombination(key: string, ctrlKey?: boolean, altKey?: boolean, shiftKey?: boolean, metaKey?: boolean): ShortcutDefinition | undefined;
+    // (undocumented)
+    getActiveContext(): string | undefined;
+    // (undocumented)
+    getContexts(): string[];
+    // (undocumented)
+    getShortcuts(): ShortcutDefinition[];
+    // (undocumented)
+    getShortcutsByContext(context: string): ShortcutDefinition[];
+    // (undocumented)
+    getShortcutsByContextMap(): Map<string, Map<string, ShortcutDefinition>>;
+    // (undocumented)
+    isPaused$: Observable<boolean>;
+    // (undocumented)
+    isPaused: boolean;
+    // (undocumented)
+    isPausedSubject: BehaviorSubject<boolean>;
+    // (undocumented)
+    pause(): void;
+    // (undocumented)
+    registerContext(context: string): void;
+    // (undocumented)
+    registerShortcut(shortcut: ShortcutDefinition): ShortcutRegistrationResult;
+    // (undocumented)
+    registerShortcuts(shortcuts: ShortcutDefinition[]): void;
+    // (undocumented)
+    resume(): void;
+    // (undocumented)
+    setActiveContext(context: string): void;
+    // (undocumented)
+    unregisterShortcut(context: string, id: string): void;
+    // (undocumented)
+    unregisterShortcutsByContext(context: string): void;
+}
+
+// @public
+export const ShortcutManager: InterfaceSymbol<ShortcutManager>;
+
+// @public
+export interface ShortcutRegistrationResult {
+    // (undocumented)
+    disabled: () => boolean;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    keyCombination: string;
+    // (undocumented)
+    keyCombinationDisplay: string;
+    // (undocumented)
+    shortcut: ShortcutDefinition;
+    // (undocumented)
+    tooltip: () => string | undefined;
+}
+
 // @public
 export class SlottedStyles extends FASTElement {
     styles: ElementStyles;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.311.0",
+  "version": "14.312.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -27,23 +27,24 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.311.0",
-    "@genesislcap/genx": "14.311.0",
-    "@genesislcap/rollup-builder": "14.311.0",
-    "@genesislcap/ts-builder": "14.311.0",
-    "@genesislcap/uvu-playwright-builder": "14.311.0",
-    "@genesislcap/vite-builder": "14.311.0",
-    "@genesislcap/webpack-builder": "14.311.0",
+    "@genesislcap/foundation-testing": "14.312.0",
+    "@genesislcap/genx": "14.312.0",
+    "@genesislcap/rollup-builder": "14.312.0",
+    "@genesislcap/ts-builder": "14.312.0",
+    "@genesislcap/uvu-playwright-builder": "14.312.0",
+    "@genesislcap/vite-builder": "14.312.0",
+    "@genesislcap/webpack-builder": "14.312.0",
     "@types/json-schema": "^7.0.11"
   },
   "dependencies": {
-    "@genesislcap/expression-builder": "14.311.0",
-    "@genesislcap/foundation-logger": "14.311.0",
+    "@genesislcap/expression-builder": "14.312.0",
+    "@genesislcap/foundation-logger": "14.312.0",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
     "lossless-json": "^2.0.11",
     "numeral": "2.0.6",
+    "rxjs": "^7.5.4",
     "uuid": "^8.3.2"
   },
   "repository": {
@@ -55,5 +56,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "2a02ca84136438cc9998c84175efc13fad71a1eb"
+  "gitHead": "44a1ea77c99b761fb37ee5f211ab7a954c9289d0"
 }