@sankhyalabs/core-docs 0.0.0-hotfix-ga-KB-4098.0

package/classes/FloatingManager.md

@@ -0,0 +1,530 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / FloatingManager
+
+# Class: FloatingManager
+
+`FloatingManager`: Gerenciador de elementos flutuantes na tela.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](FloatingManager.md#constructor)
+
+### Properties
+
+- [DATA\_OLD\_ZINDEX\_ATTRIBUTE\_NAME](FloatingManager.md#data_old_zindex_attribute_name)
+- [MODAL\_DEFAULT\_CLASSNAME](FloatingManager.md#modal_default_classname)
+- [MODAL\_ELEMENT\_ID](FloatingManager.md#modal_element_id)
+- [STYLE\_ELEMENT\_ID](FloatingManager.md#style_element_id)
+- [entries](FloatingManager.md#entries)
+- [initialized](FloatingManager.md#initialized)
+- [overlayElements](FloatingManager.md#overlayelements)
+
+### Methods
+
+- [applyStyle](FloatingManager.md#applystyle)
+- [close](FloatingManager.md#close)
+- [createOrUpdatOverlay](FloatingManager.md#createorupdatoverlay)
+- [createStyleElement](FloatingManager.md#createstyleelement)
+- [doClose](FloatingManager.md#doclose)
+- [float](FloatingManager.md#float)
+- [getCSSPropertyValue](FloatingManager.md#getcsspropertyvalue)
+- [getFloatIndex](FloatingManager.md#getfloatindex)
+- [getHighestZIndex](FloatingManager.md#gethighestzindex)
+- [handleDocumentEvent](FloatingManager.md#handledocumentevent)
+- [handleKeyboardEvent](FloatingManager.md#handlekeyboardevent)
+- [hideOverlay](FloatingManager.md#hideoverlay)
+- [init](FloatingManager.md#init)
+- [innerClick](FloatingManager.md#innerclick)
+- [isFloating](FloatingManager.md#isfloating)
+- [showOverlay](FloatingManager.md#showoverlay)
+- [subscribeOverlayControl](FloatingManager.md#subscribeoverlaycontrol)
+- [unsubscribeOverlayControl](FloatingManager.md#unsubscribeoverlaycontrol)
+- [updateFloatPosition](FloatingManager.md#updatefloatposition)
+
+## Constructors
+
+### constructor
+
+• **new FloatingManager**()
+
+## Properties
+
+### DATA\_OLD\_ZINDEX\_ATTRIBUTE\_NAME
+
+▪ `Static` **DATA\_OLD\_ZINDEX\_ATTRIBUTE\_NAME**: `string` = `"data-old-zindex"`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:70
+
+___
+
+### MODAL\_DEFAULT\_CLASSNAME
+
+▪ `Static` **MODAL\_DEFAULT\_CLASSNAME**: `string` = `"FloatingManager__modal"`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:67
+
+___
+
+### MODAL\_ELEMENT\_ID
+
+▪ `Static` **MODAL\_ELEMENT\_ID**: `string` = `"FloatingManager__overlay"`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:68
+
+___
+
+### STYLE\_ELEMENT\_ID
+
+▪ `Static` **STYLE\_ELEMENT\_ID**: `string` = `"FloatingManager__style"`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:69
+
+___
+
+### entries
+
+▪ `Static` `Private` **entries**: `FloatingEntry`[]
+
+#### Defined in
+
+src/ui/FloatingManager.ts:73
+
+___
+
+### initialized
+
+▪ `Static` `Private` **initialized**: `boolean`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:72
+
+___
+
+### overlayElements
+
+▪ `Static` `Private` **overlayElements**: `HTMLElement`[] = `[]`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:74
+
+## Methods
+
+### applyStyle
+
+▸ `Static` `Private` **applyStyle**(`element`, `propertyName`, `value?`): `void`
+
+Adiciona uma propriedade CSS em um elemento HTML.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `element` | `HTMLElement` | Elemento HTML que será modificado. |
+| `propertyName` | `string` | Nome da propriedade CSS que será adicionada. |
+| `value?` | `string` | Valor da propriedade adicionada. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:179
+
+___
+
+### close
+
+▸ `Static` **close**(`id`): `void`
+
+Fecha elemento flutuante da tela.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `number` | Índice do elemento desejado. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:374
+
+___
+
+### createOrUpdatOverlay
+
+▸ `Static` `Private` **createOrUpdatOverlay**(`className?`): `HTMLDivElement`
+
+Cria ou atualiza o elemento de sobreposição.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `className` | `string` | `FloatingManager.MODAL_DEFAULT_CLASSNAME` | Classe CSS que será adicionada ao modal. |
+
+#### Returns
+
+`HTMLDivElement`
+
+- O elemento atualizado.
+
+#### Defined in
+
+src/ui/FloatingManager.ts:297
+
+___
+
+### createStyleElement
+
+▸ `Static` `Private` **createStyleElement**(): `void`
+
+Cria elemento de estilo.
+Elemento que define o estilo padrão do elemento de sobreposição.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:324
+
+___
+
+### doClose
+
+▸ `Static` `Private` **doClose**(`id`, `entry`, `target?`, `event?`): `void`
+
+Fecha uma entrada flutuante (FloatingManager).
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `number` | Código da entrada que se deseja encerrar. |
+| `entry` | `FloatingEntry` | FloatingManager. |
+| `target?` | `HTMLElement` | Elemento HTML referente. |
+| `event?` | `Event` | Evento específico que será verificado, como clique do mouse. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:116
+
+___
+
+### float
+
+▸ `Static` **float**(`content`, `parent`, `options?`): `number`
+
+Cria e exibe um novo item no FloatingManager.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `content` | `HTMLElement` | Elemento HTML que será criado. |
+| `parent` | `HTMLElement` | Elemento HTML que será o pai do item a ser criado. |
+| `options` | `FloatingOptions` | Opções de configuração a serem adicionadas. |
+
+#### Returns
+
+`number`
+
+- ID do novo item criado.
+
+#### Defined in
+
+src/ui/FloatingManager.ts:228
+
+___
+
+### getCSSPropertyValue
+
+▸ `Static` `Private` **getCSSPropertyValue**(`element`, `property`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `element` | `HTMLElement` |
+| `property` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:410
+
+___
+
+### getFloatIndex
+
+▸ `Static` `Private` **getFloatIndex**(`content`, `parent`): `number`
+
+Obtém o índice do FloatingManager do Elemento HMTL desejado.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `content` | `HTMLElement` | Elemento a ser buscado. |
+| `parent` | `HTMLElement` | Elemento pai do content a ser buscado. |
+
+#### Returns
+
+`number`
+
+- Índice do elemento informado.
+
+#### Defined in
+
+src/ui/FloatingManager.ts:193
+
+___
+
+### getHighestZIndex
+
+▸ `Static` `Private` **getHighestZIndex**(): `number`
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:414
+
+___
+
+### handleDocumentEvent
+
+▸ `Static` `Private` **handleDocumentEvent**(`event`): `void`
+
+Fecha todas as FloatingManagers abertas.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `event` | `Event` | Evento ocorrido, como clique do mouse, por exemplo. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:143
+
+___
+
+### handleKeyboardEvent
+
+▸ `Static` `Private` **handleKeyboardEvent**(`event`): `void`
+
+Captura eventos de teclado para manipular os elementos flutuantes via eventos da tecla pressionada.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `event` | `KeyboardEvent` | Evento de teclado. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:157
+
+___
+
+### hideOverlay
+
+▸ `Static` `Private` **hideOverlay**(): `void`
+
+Desfaz o desfoque/overlay dos elementos na tela.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:274
+
+___
+
+### init
+
+▸ `Static` `Private` **init**(): `void`
+
+Inicializa a classe FloatingManager.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:82
+
+___
+
+### innerClick
+
+▸ `Static` `Private` **innerClick**(`container`, `node`): `boolean`
+
+Retorna se o elemento clicado possui elementos internos.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `container` | `HTMLElement` |
+| `node` | `HTMLElement` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:94
+
+___
+
+### isFloating
+
+▸ `Static` **isFloating**(`id`): `boolean`
+
+Retorna se uma entrada flutuante existe.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `number` | Índice para ser verificado no FloatingManager. |
+
+#### Returns
+
+`boolean`
+
+- Verdadeiro se existir.
+
+#### Defined in
+
+src/ui/FloatingManager.ts:213
+
+___
+
+### showOverlay
+
+▸ `Static` `Private` **showOverlay**(`options`): `void`
+
+Aplica o desfoque na página se o elemento possuir essa option ativada.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options` | `FloatingOptions` | Configurações que serão utilizadas no elemento. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:262
+
+___
+
+### subscribeOverlayControl
+
+▸ `Static` **subscribeOverlayControl**(`item`): `undefined` \| `number`
+
+Controle a sobreposição do elemento
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `item` | `HTMLElement` | Elemento HTML que será manipulado |
+
+#### Returns
+
+`undefined` \| `number`
+
+- O ID do elemento na lista de controle
+
+#### Defined in
+
+src/ui/FloatingManager.ts:385
+
+___
+
+### unsubscribeOverlayControl
+
+▸ `Static` **unsubscribeOverlayControl**(`identifier`): `void`
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `identifier` | `number` \| `HTMLElement` | Elemento HTML ou ID do item que será removido do controle de sobreposição |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:400
+
+___
+
+### updateFloatPosition
+
+▸ `Static` **updateFloatPosition**(`content`, `parent`, `options?`): `void`
+
+Atualiza posição de um elemento que já está em tela.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `content` | `HTMLElement` | Elemento HTML que será atualizado. |
+| `parent` | `HTMLElement` | Elemento pai do content passado. |
+| `options` | `FloatingOptions` | Novas opções desejadas. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:356

package/classes/HttpProvider.md

@@ -0,0 +1,96 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / HttpProvider
+
+# Class: HttpProvider
+
+Abstração do XMLHttpRequest. Este serviço é responsável por realizar as requisições
+ao backend. Todos os métodos são estáticos.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HttpProvider.md#constructor)
+
+### Methods
+
+- [dispatch](HttpProvider.md#dispatch)
+- [get](HttpProvider.md#get)
+- [post](HttpProvider.md#post)
+
+## Constructors
+
+### constructor
+
+• **new HttpProvider**()
+
+## Methods
+
+### dispatch
+
+▸ `Static` `Private` **dispatch**(`requestMetadata`, `payload?`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `requestMetadata` | [`RequestMetadata`](RequestMetadata.md) |
+| `payload?` | `Object` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+src/http/HttpProvider.ts:32
+
+___
+
+### get
+
+▸ `Static` **get**(`url`, `headers?`): `Promise`<`Object`\>
+
+Faz uma requisição usando o método GET do HTTP para uma URL específica.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `url` | `string` | A URL que deve ser chamada. |
+| `headers?` | `Header`[] | [Opcional] Cabeçalhos HTTP. |
+
+#### Returns
+
+`Promise`<`Object`\>
+
+Uma promessa de que a requisição será preenchida.
+
+#### Defined in
+
+src/http/HttpProvider.ts:16
+
+___
+
+### post
+
+▸ `Static` **post**(`url`, `payload`, `headers?`): `Promise`<`any`\>
+
+Faz uma requisição usando o método POST do HTTP para uma URL específica.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `url` | `string` | A URL que deve ser chamada. |
+| `payload` | `Object` | Informações a serem enviadas. |
+| `headers?` | `Header`[] | [Opcional] Cabeçalhos HTTP. |
+
+#### Returns
+
+`Promise`<`any`\>
+
+Uma promessa de que a requisição será preenchida.
+
+#### Defined in
+
+src/http/HttpProvider.ts:28

package/classes/JSUtils.md

@@ -0,0 +1,115 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / JSUtils
+
+# Class: JSUtils
+
+Classe com utiliários comuns para funções genéricas em JavaScript.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](JSUtils.md#constructor)
+
+### Methods
+
+- [debounce](JSUtils.md#debounce)
+- [generateUUID](JSUtils.md#generateuuid)
+- [isBase64](JSUtils.md#isbase64)
+- [isEllipsisActive](JSUtils.md#isellipsisactive)
+
+## Constructors
+
+### constructor
+
+• **new JSUtils**()
+
+## Methods
+
+### debounce
+
+▸ `Static` **debounce**(`callback`, `timeout?`): `any`
+
+Método responsável em criar um timer para processar uma determinada função.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `callback` | `any` | `undefined` | Função de callback para processar após o timer. |
+| `timeout` | `number` | `300` | Valor dos milissegundos desejados para processar a função (o padrão é 300). |
+
+#### Returns
+
+`any`
+
+- Retorna um método com controle de timer para processar a função de callback.
+
+#### Defined in
+
+src/utils/JSUtils.ts:16
+
+___
+
+### generateUUID
+
+▸ `Static` **generateUUID**(): `string`
+
+Método responsável em gerar um UUID.
+
+#### Returns
+
+`string`
+
+- Retorna um UUID.
+
+#### Defined in
+
+src/utils/JSUtils.ts:66
+
+___
+
+### isBase64
+
+▸ `Static` **isBase64**(`str`): `boolean`
+
+Método que verifica se uma string está encodada com base64.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `str` | `string` | String que será verificada. |
+
+#### Returns
+
+`boolean`
+
+- Retorna um valor booleando informando se a string está encodada com base64.
+
+#### Defined in
+
+src/utils/JSUtils.ts:51
+
+___
+
+### isEllipsisActive
+
+▸ `Static` **isEllipsisActive**(`element`): `boolean`
+
+Método responsável em validar se um elemento HTML está com o ellipsis ativo.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `element` | `any` | Elemento HTML que será verificado. |
+
+#### Returns
+
+`boolean`
+
+- Retorna um valor booleando informando se o elemento está com o ellipsis ativo.
+
+#### Defined in
+
+src/utils/JSUtils.ts:31