@sankhyalabs/core-docs 5.11.5 → 5.12.0-dev.1

package/classes/JSUtils.md

@@ -13,6 +13,7 @@ Classe com utiliários comuns para funções genéricas em JavaScript.
 ### Methods
 
 - [debounce](JSUtils.md#debounce)
+- [debounceLeading](JSUtils.md#debounceleading)
 - [generateUUID](JSUtils.md#generateuuid)
 - [isBase64](JSUtils.md#isbase64)
 - [isEllipsisActive](JSUtils.md#isellipsisactive)
@@ -50,6 +51,32 @@ src/utils/JSUtils.ts:16
 
 ___
 
+### debounceLeading
+
+▸ `Static` **debounceLeading**(`callback`, `timeout?`, `context?`): `VoidFunction`
+
+Método responsável por executar uma função e ignorar as outras posteriores até o tempo especificado.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `callback` | `Function` | `undefined` | Função a ser invocada |
+| `timeout` | `number` | `300` | Quantidade de tempo para aguardar antes de invocar novamente |
+| `context?` | `any` | `undefined` | O contexto atual |
+
+#### Returns
+
+`VoidFunction`
+
+A função com o debounce
+
+#### Defined in
+
+src/utils/JSUtils.ts:32
+
+___
+
 ### generateUUID
 
 ▸ `Static` **generateUUID**(): `string`
@@ -64,7 +91,7 @@ Método responsável em gerar um UUID.
 
 #### Defined in
 
-src/utils/JSUtils.ts:66
+src/utils/JSUtils.ts:90
 
 ___
 
@@ -88,7 +115,7 @@ Método que verifica se uma string está encodada com base64.
 
 #### Defined in
 
-src/utils/JSUtils.ts:51
+src/utils/JSUtils.ts:75
 
 ___
 
@@ -112,4 +139,4 @@ Método responsável em validar se um elemento HTML está com o ellipsis ativo.
 
 #### Defined in
 
-src/utils/JSUtils.ts:31
+src/utils/JSUtils.ts:55

package/classes/KeyboardManager.md

@@ -0,0 +1,233 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / KeyboardManager
+
+# Class: KeyboardManager
+
+`KeyboardManager` é reponsável por gerenciar eventos de teclado.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](KeyboardManager.md#constructor)
+
+### Properties
+
+- [\_mappedElements](KeyboardManager.md#_mappedelements)
+- [\_options](KeyboardManager.md#_options)
+
+### Accessors
+
+- [mappedKeys](KeyboardManager.md#mappedkeys)
+
+### Methods
+
+- [bind](KeyboardManager.md#bind)
+- [checkModifiersIsApplied](KeyboardManager.md#checkmodifiersisapplied)
+- [handleListenerEvent](KeyboardManager.md#handlelistenerevent)
+- [keyAppliedWithModifiers](KeyboardManager.md#keyappliedwithmodifiers)
+- [unbind](KeyboardManager.md#unbind)
+- [verifyAndStopPropagation](KeyboardManager.md#verifyandstoppropagation)
+
+## Constructors
+
+### constructor
+
+• **new KeyboardManager**(`options?`)
+
+Construtor para a classe Keyboard.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options?` | `Partial`<`IKeyboardOptions`\> | opções para o gerenciamento de eventos de teclado. |
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:19
+
+## Properties
+
+### \_mappedElements
+
+• `Private` **\_mappedElements**: `IKeyboardMappedKeysElements` = `{}`
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:12
+
+___
+
+### \_options
+
+• `Private` **\_options**: `IKeyboardOptions`
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:11
+
+## Accessors
+
+### mappedKeys
+
+• `get` **mappedKeys**(): `IGetMappedKeys`[]
+
+Obtém as chaves mapeadas.
+
+#### Returns
+
+`IGetMappedKeys`[]
+
+chaves mapeadas com descrições
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:97
+
+## Methods
+
+### bind
+
+▸ **bind**(`keyMap`, `callback`, `options?`): [`KeyboardManager`](KeyboardManager.md)
+
+Associa um evento de teclado com uma função
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `keyMap` | `string` | Chave de mapeamento de teclado. |
+| `callback` | `VoidFunction` | Função a ser executada quando o evento de teclado for disparado. |
+| `options?` | `Partial`<`IKeyboardOptions`\> | Configurações dos eventos de teclado. |
+
+#### Returns
+
+[`KeyboardManager`](KeyboardManager.md)
+
+O objeto `KeyboardManager`
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:37
+
+___
+
+### checkModifiersIsApplied
+
+▸ `Private` **checkModifiersIsApplied**(`event`, `modifiedList`): `boolean`
+
+Verifica se todas as teclas modificadoras foram aplicadas ao evento
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `event` | `KeyboardEvent` | O evento de teclado |
+| `modifiedList` | `string`[] | As teclas modificadoras |
+
+#### Returns
+
+`boolean`
+
+Retorna se todas as teclas modificadoras foram aplicadas
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:166
+
+___
+
+### handleListenerEvent
+
+▸ `Private` **handleListenerEvent**(`keyMap`, `callback`, `propagate`, `event`): `void`
+
+Executa uma função quando um evento de teclado for disparado
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `keyMap` | `string` | Chave de mapeamento de teclado |
+| `callback` | `VoidFunction` | Função a ser executada |
+| `propagate` | `boolean` | Se o evento de teclado deve ser propagado |
+| `event` | `KeyboardEvent` | O evento de teclado |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:113
+
+___
+
+### keyAppliedWithModifiers
+
+▸ `Private` **keyAppliedWithModifiers**(`keyMap`, `pressedKeyCode`): `IKeyAppliedResponse`
+
+Verifica se um evento de teclado foi disparado
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `keyMap` | `string` | Chave de mapeamento de teclado |
+| `pressedKeyCode` | `number` | Código do evento de teclado pressionado |
+
+#### Returns
+
+`IKeyAppliedResponse`
+
+Retorna se o evento de teclado foi disparado e as teclas modificadoras aplicadas ao evento
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:129
+
+___
+
+### unbind
+
+▸ **unbind**(`keyMap`): [`KeyboardManager`](KeyboardManager.md)
+
+Remove um evento de teclado
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `keyMap` | `string` | Chave de mapeamento de teclado. |
+
+#### Returns
+
+[`KeyboardManager`](KeyboardManager.md)
+
+- O objeto `KeyboardManager`
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:73
+
+___
+
+### verifyAndStopPropagation
+
+▸ `Private` **verifyAndStopPropagation**(`event`, `propagate`): `void`
+
+Verifica e impede que o evento de teclado seja propagado
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `event` | `KeyboardEvent` | O evento de teclado |
+| `propagate` | `boolean` | Se o evento de teclado deve ser propagado |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:202

package/classes/SelectionInfo.md

@@ -45,7 +45,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1851
+src/dataunit/DataUnit.ts:1867
 
 ## Properties
 
@@ -55,7 +55,7 @@ src/dataunit/DataUnit.ts:1851
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1845
+src/dataunit/DataUnit.ts:1861
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1847
+src/dataunit/DataUnit.ts:1863
 
 ___
 
@@ -75,7 +75,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1848
+src/dataunit/DataUnit.ts:1864
 
 ___
 
@@ -85,7 +85,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1846
+src/dataunit/DataUnit.ts:1862
 
 ___
 
@@ -95,7 +95,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1849
+src/dataunit/DataUnit.ts:1865
 
 ## Accessors
 
@@ -109,7 +109,7 @@ src/dataunit/DataUnit.ts:1849
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1876
+src/dataunit/DataUnit.ts:1892
 
 ___
 
@@ -123,7 +123,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1866
+src/dataunit/DataUnit.ts:1882
 
 ___
 
@@ -137,7 +137,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1859
+src/dataunit/DataUnit.ts:1875
 
 ## Methods
 
@@ -151,7 +151,7 @@ src/dataunit/DataUnit.ts:1859
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1883
+src/dataunit/DataUnit.ts:1899
 
 ___
 
@@ -165,4 +165,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1887
+src/dataunit/DataUnit.ts:1903

package/classes/StringUtils.md

@@ -17,8 +17,11 @@
 - [formatBytes](StringUtils.md#formatbytes)
 - [generateUUID](StringUtils.md#generateuuid)
 - [getBooleanValue](StringUtils.md#getbooleanvalue)
+- [getOppositeCase](StringUtils.md#getoppositecase)
 - [hashCode](StringUtils.md#hashcode)
+- [isCaseable](StringUtils.md#iscaseable)
 - [isEmpty](StringUtils.md#isempty)
+- [isLowerCase](StringUtils.md#islowercase)
 - [padEnd](StringUtils.md#padend)
 - [padStart](StringUtils.md#padstart)
 - [prettyPrecision](StringUtils.md#prettyprecision)
@@ -97,7 +100,7 @@ ___
 
 ▸ `Static` **formatBytes**(`bytes`): `string`
 
-Utilitário para formatar bytes em string legível, convertendo para 
+Utilitário para formatar bytes em string legível, convertendo para
 múltiplos maiores caso necessário.
 
 #### Parameters
@@ -168,6 +171,30 @@ src/utils/StringUtils.ts:164
 
 ___
 
+### getOppositeCase
+
+▸ `Static` **getOppositeCase**(`original`): `string`
+
+Inverte uma string de minúsculas para maiúsculas e vice-versa
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `original` | `string` | A string a ser invertida |
+
+#### Returns
+
+`string`
+
+A string invertida
+
+#### Defined in
+
+src/utils/StringUtils.ts:400
+
+___
+
 ### hashCode
 
 ▸ `Static` **hashCode**(`value`): `string`
@@ -198,6 +225,30 @@ src/utils/StringUtils.ts:143
 
 ___
 
+### isCaseable
+
+▸ `Static` **isCaseable**(`original`): `boolean`
+
+Checa se uma string pode ser convertida para letras maiúsculas ou minúsculas
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `original` | `string` | A string a ser verificada |
+
+#### Returns
+
+`boolean`
+
+Se a string pode ser convertida
+
+#### Defined in
+
+src/utils/StringUtils.ts:375
+
+___
+
 ### isEmpty
 
 ▸ `Static` **isEmpty**(`value`): `Boolean`
@@ -223,6 +274,30 @@ src/utils/StringUtils.ts:16
 
 ___
 
+### isLowerCase
+
+▸ `Static` **isLowerCase**(`original`): `boolean`
+
+Checa se uma string é minúscula
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `original` | `string` | A string a ser verificada |
+
+#### Returns
+
+`boolean`
+
+Se a string é minúscula
+
+#### Defined in
+
+src/utils/StringUtils.ts:388
+
+___
+
 ### padEnd
 
 ▸ `Static` **padEnd**(`str`, `len`, `pad?`): `string`

package/enums/ChangeOperation.md

@@ -19,7 +19,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1731
+src/dataunit/DataUnit.ts:1747
 
 ___
 
@@ -29,7 +29,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1733
+src/dataunit/DataUnit.ts:1749
 
 ___
 
@@ -39,7 +39,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1730
+src/dataunit/DataUnit.ts:1746
 
 ___
 
@@ -49,4 +49,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1732
+src/dataunit/DataUnit.ts:1748

package/enums/SelectionMode.md

@@ -17,7 +17,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1839
+src/dataunit/DataUnit.ts:1855
 
 ___
 
@@ -27,4 +27,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1840
+src/dataunit/DataUnit.ts:1856

package/interfaces/DUActionInterceptor.md

@@ -26,4 +26,4 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1714
+src/dataunit/DataUnit.ts:1730

package/interfaces/PageRequest.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1819
+src/dataunit/DataUnit.ts:1835
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1820
+src/dataunit/DataUnit.ts:1836
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1821
+src/dataunit/DataUnit.ts:1837

package/interfaces/QuickFilter.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1826
+src/dataunit/DataUnit.ts:1842
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1827
+src/dataunit/DataUnit.ts:1843
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1825
+src/dataunit/DataUnit.ts:1841

package/interfaces/Record.md

@@ -29,7 +29,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1721
+src/dataunit/DataUnit.ts:1737
 
 ___
 
@@ -39,7 +39,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1720
+src/dataunit/DataUnit.ts:1736
 
 ___
 
@@ -49,7 +49,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1718
+src/dataunit/DataUnit.ts:1734
 
 ___
 
@@ -59,4 +59,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1719
+src/dataunit/DataUnit.ts:1735

package/interfaces/SavedRecord.md

@@ -26,7 +26,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1726
+src/dataunit/DataUnit.ts:1742
 
 ___
 
@@ -40,7 +40,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1721
+src/dataunit/DataUnit.ts:1737
 
 ___
 
@@ -54,7 +54,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1720
+src/dataunit/DataUnit.ts:1736
 
 ___
 
@@ -68,7 +68,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1718
+src/dataunit/DataUnit.ts:1734
 
 ___
 
@@ -82,4 +82,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1719
+src/dataunit/DataUnit.ts:1735

package/interfaces/WaitingChange.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1814
+src/dataunit/DataUnit.ts:1830
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1815
+src/dataunit/DataUnit.ts:1831
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1813
+src/dataunit/DataUnit.ts:1829

package/modules.md

@@ -37,6 +37,7 @@
 - [HttpProvider](classes/HttpProvider.md)
 - [IDBRepository](classes/IDBRepository.md)
 - [JSUtils](classes/JSUtils.md)
+- [KeyboardManager](classes/KeyboardManager.md)
 - [MaskFormatter](classes/MaskFormatter-1.md)
 - [NumberUtils](classes/NumberUtils.md)
 - [ObjectUtils](classes/ObjectUtils.md)