@sankhyalabs/core-docs 5.20.0-dev.4 → 5.20.0-dev.6

package/classes/FloatingManager.md

@@ -1,175 +1,150 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / FloatingManager
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.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)
-- [closeAll](FloatingManager.md#closeall)
-- [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()
+
+> **new FloatingManager**(): [`FloatingManager`](FloatingManager.md)
+
+#### Returns
 
-• **new FloatingManager**()
+[`FloatingManager`](FloatingManager.md)
 
 ## Properties
 
 ### DATA\_OLD\_ZINDEX\_ATTRIBUTE\_NAME
 
-▪ `Static` **DATA\_OLD\_ZINDEX\_ATTRIBUTE\_NAME**: `string` = `"data-old-zindex"`
+> `static` **DATA\_OLD\_ZINDEX\_ATTRIBUTE\_NAME**: `string` = `"data-old-zindex"`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:70
 
-___
+***
 
 ### MODAL\_DEFAULT\_CLASSNAME
 
-▪ `Static` **MODAL\_DEFAULT\_CLASSNAME**: `string` = `"FloatingManager__modal"`
+> `static` **MODAL\_DEFAULT\_CLASSNAME**: `string` = `"FloatingManager__modal"`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:67
 
-___
+***
 
 ### MODAL\_ELEMENT\_ID
 
-▪ `Static` **MODAL\_ELEMENT\_ID**: `string` = `"FloatingManager__overlay"`
+> `static` **MODAL\_ELEMENT\_ID**: `string` = `"FloatingManager__overlay"`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:68
 
-___
+***
 
 ### STYLE\_ELEMENT\_ID
 
-▪ `Static` **STYLE\_ELEMENT\_ID**: `string` = `"FloatingManager__style"`
+> `static` **STYLE\_ELEMENT\_ID**: `string` = `"FloatingManager__style"`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:69
 
-___
+***
 
 ### entries
 
-▪ `Static` `Private` **entries**: `FloatingEntry`[]
+> `static` `private` **entries**: `FloatingEntry`[]
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:73
 
-___
+***
 
 ### initialized
 
-▪ `Static` `Private` **initialized**: `boolean`
+> `static` `private` **initialized**: `boolean`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:72
 
-___
+***
 
 ### overlayElements
 
-▪ `Static` `Private` **overlayElements**: `HTMLElement`[] = `[]`
+> `static` `private` **overlayElements**: `HTMLElement`[] = `[]`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:74
 
 ## Methods
 
-### applyStyle
+### applyStyle()
 
-▸ `Static` `Private` **applyStyle**(`element`, `propertyName`, `value?`): `void`
+> `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. |
+• **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
+#### Source
 
 src/ui/FloatingManager.ts:179
 
-___
+***
 
-### close
+### close()
 
-▸ `Static` **close**(`id`): `void`
+> `static` **close**(`id`): `void`
 
 Fecha elemento flutuante da tela.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `id` | `number` | Índice do elemento desejado. |
+• **id**: `number`
+
+Índice do elemento desejado.
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:374
 
-___
+***
 
-### closeAll
+### closeAll()
 
-▸ `Static` **closeAll**(): `void`
+> `static` **closeAll**(): `void`
 
 Fecha todos os elemento flutuante da tela.
 
@@ -177,23 +152,23 @@ Fecha todos os elemento flutuante da tela.
 
 `void`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:383
 
-___
+***
 
-### createOrUpdatOverlay
+### createOrUpdatOverlay()
 
-▸ `Static` `Private` **createOrUpdatOverlay**(`className?`): `HTMLDivElement`
+> `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. |
+• **className**: `string`= `FloatingManager.MODAL_DEFAULT_CLASSNAME`
+
+Classe CSS que será adicionada ao modal.
 
 #### Returns
 
@@ -201,15 +176,15 @@ Cria ou atualiza o elemento de sobreposição.
 
 - O elemento atualizado.
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:297
 
-___
+***
 
-### createStyleElement
+### createStyleElement()
 
-▸ `Static` `Private` **createStyleElement**(): `void`
+> `static` `private` **createStyleElement**(): `void`
 
 Cria elemento de estilo.
 Elemento que define o estilo padrão do elemento de sobreposição.
@@ -218,50 +193,65 @@ Elemento que define o estilo padrão do elemento de sobreposição.
 
 `void`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:324
 
-___
+***
 
-### doClose
+### doClose()
 
-▸ `Static` `Private` **doClose**(`id`, `entry`, `target?`, `event?`): `void`
+> `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. |
+• **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
+#### Source
 
 src/ui/FloatingManager.ts:116
 
-___
+***
 
-### float
+### float()
 
-▸ `Static` **float**(`content`, `parent`, `options?`): `number`
+> `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. |
+• **content**: `HTMLElement`
+
+Elemento HTML que será criado.
+
+• **parent**: `HTMLElement`
+
+Elemento HTML que será o pai do item a ser criado.
+
+• **options**: `FloatingOptions`= `undefined`
+
+Opções de configuração a serem adicionadas.
 
 #### Returns
 
@@ -269,45 +259,47 @@ Cria e exibe um novo item no FloatingManager.
 
 - ID do novo item criado.
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:228
 
-___
+***
 
-### getCSSPropertyValue
+### getCSSPropertyValue()
 
-▸ `Static` `Private` **getCSSPropertyValue**(`element`, `property`): `string`
+> `static` `private` **getCSSPropertyValue**(`element`, `property`): `string`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `element` | `HTMLElement` |
-| `property` | `string` |
+• **element**: `HTMLElement`
+
+• **property**: `string`
 
 #### Returns
 
 `string`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:422
 
-___
+***
 
-### getFloatIndex
+### getFloatIndex()
 
-▸ `Static` `Private` **getFloatIndex**(`content`, `parent`): `number`
+> `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. |
+• **content**: `HTMLElement`
+
+Elemento a ser buscado.
+
+• **parent**: `HTMLElement`
+
+Elemento pai do content a ser buscado.
 
 #### Returns
 
@@ -315,73 +307,73 @@ Obtém o índice do FloatingManager do Elemento HMTL desejado.
 
 - Índice do elemento informado.
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:193
 
-___
+***
 
-### getHighestZIndex
+### getHighestZIndex()
 
-▸ `Static` `Private` **getHighestZIndex**(): `number`
+> `static` `private` **getHighestZIndex**(): `number`
 
 #### Returns
 
 `number`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:426
 
-___
+***
 
-### handleDocumentEvent
+### handleDocumentEvent()
 
-▸ `Static` `Private` **handleDocumentEvent**(`event`): `void`
+> `static` `private` **handleDocumentEvent**(`event`): `void`
 
 Fecha todas as FloatingManagers abertas.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `event` | `Event` | Evento ocorrido, como clique do mouse, por exemplo. |
+• **event**: `Event`
+
+Evento ocorrido, como clique do mouse, por exemplo.
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:143
 
-___
+***
 
-### handleKeyboardEvent
+### handleKeyboardEvent()
 
-▸ `Static` `Private` **handleKeyboardEvent**(`event`): `void`
+> `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. |
+• **event**: `KeyboardEvent`
+
+Evento de teclado.
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:157
 
-___
+***
 
-### hideOverlay
+### hideOverlay()
 
-▸ `Static` `Private` **hideOverlay**(): `void`
+> `static` `private` **hideOverlay**(): `void`
 
 Desfaz o desfoque/overlay dos elementos na tela.
 
@@ -389,15 +381,15 @@ Desfaz o desfoque/overlay dos elementos na tela.
 
 `void`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:274
 
-___
+***
 
-### init
+### init()
 
-▸ `Static` `Private` **init**(): `void`
+> `static` `private` **init**(): `void`
 
 Inicializa a classe FloatingManager.
 
@@ -405,46 +397,45 @@ Inicializa a classe FloatingManager.
 
 `void`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:82
 
-___
+***
 
-### innerClick
+### innerClick()
 
-▸ `Static` `Private` **innerClick**(`container`, `node`): `boolean`
+> `static` `private` **innerClick**(`container`, `node`): `boolean`
 
 Retorna se o elemento clicado possui elementos internos.
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `container` | `HTMLElement` |
-| `node` | `HTMLElement` |
+• **container**: `HTMLElement`
+
+• **node**: `HTMLElement`
 
 #### Returns
 
 `boolean`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:94
 
-___
+***
 
-### isFloating
+### isFloating()
 
-▸ `Static` **isFloating**(`id`): `boolean`
+> `static` **isFloating**(`id`): `boolean`
 
 Retorna se uma entrada flutuante existe.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `id` | `number` | Índice para ser verificado no FloatingManager. |
+• **id**: `number`
+
+Índice para ser verificado no FloatingManager.
 
 #### Returns
 
@@ -452,45 +443,45 @@ Retorna se uma entrada flutuante existe.
 
 - Verdadeiro se existir.
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:213
 
-___
+***
 
-### showOverlay
+### showOverlay()
 
-▸ `Static` `Private` **showOverlay**(`options`): `void`
+> `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. |
+• **options**: `FloatingOptions`
+
+Configurações que serão utilizadas no elemento.
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:262
 
-___
+***
 
-### subscribeOverlayControl
+### subscribeOverlayControl()
 
-▸ `Static` **subscribeOverlayControl**(`item`): `undefined` \| `number`
+> `static` **subscribeOverlayControl**(`item`): `undefined` \| `number`
 
 Controle a sobreposição do elemento
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `item` | `HTMLElement` | Elemento HTML que será manipulado |
+• **item**: `HTMLElement`
+
+Elemento HTML que será manipulado
 
 #### Returns
 
@@ -498,50 +489,56 @@ Controle a sobreposição do elemento
 
 - O ID do elemento na lista de controle
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:397
 
-___
+***
 
-### unsubscribeOverlayControl
+### unsubscribeOverlayControl()
 
-▸ `Static` **unsubscribeOverlayControl**(`identifier`): `void`
+> `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 |
+• **identifier**: `number` \| `HTMLElement`
+
+Elemento HTML ou ID do item que será removido do controle de sobreposição
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:412
 
-___
+***
 
-### updateFloatPosition
+### updateFloatPosition()
 
-▸ `Static` **updateFloatPosition**(`content`, `parent`, `options?`): `void`
+> `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. |
+• **content**: `HTMLElement`
+
+Elemento HTML que será atualizado.
+
+• **parent**: `HTMLElement`
+
+Elemento pai do content passado.
+
+• **options**: `FloatingOptions`= `undefined`
+
+Novas opções desejadas.
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/ui/FloatingManager.ts:356