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.shortcutdefinition.ctrlkey.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; [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 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; [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 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; [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 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; [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 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; [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 DELETED Viewed

@@ -1,276 +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; [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 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; [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 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; [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 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; [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 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; [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 DELETED Viewed

@@ -1,16 +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; [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 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; [ShortcutManager](./foundation-utils.shortcutmanager.md) &gt; [clearActiveContext](./foundation-utils.shortcutmanager.clearactivecontext.md)
-## ShortcutManager.clearActiveContext() method
-**Signature:**
-```typescript
-clearActiveContext(): void;
-```
-**Returns:**
-void

package/docs/api/foundation-utils.shortcutmanager.executeshortcut.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; [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 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; [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 DELETED Viewed

@@ -1,114 +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; [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 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; [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 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; [ShortcutManager](./foundation-utils.shortcutmanager.md) &gt; [getContexts](./foundation-utils.shortcutmanager.getcontexts.md)
-## ShortcutManager.getContexts() method
-**Signature:**
-```typescript
-getContexts(): string[];
-```
-**Returns:**
-string\[\]