@sankhyalabs/core-docs 2.3.6 → 2.4.0

package/classes/FloatingManager.md

@@ -2,6 +2,8 @@
 
 # Class: FloatingManager
 
+`FloatingManager`: Gerenciador de elementos flutuantes na tela.
+
 ## Table of contents
 
 ### Constructors
@@ -48,7 +50,7 @@
 
 #### Defined in
 
-src/ui/FloatingManager.ts:50
+src/ui/FloatingManager.ts:67
 
 ___
 
@@ -58,7 +60,7 @@ ___
 
 #### Defined in
 
-src/ui/FloatingManager.ts:51
+src/ui/FloatingManager.ts:68
 
 ___
 
@@ -68,7 +70,7 @@ ___
 
 #### Defined in
 
-src/ui/FloatingManager.ts:52
+src/ui/FloatingManager.ts:69
 
 ___
 
@@ -78,7 +80,7 @@ ___
 
 #### Defined in
 
-src/ui/FloatingManager.ts:55
+src/ui/FloatingManager.ts:72
 
 ___
 
@@ -88,7 +90,7 @@ ___
 
 #### Defined in
 
-src/ui/FloatingManager.ts:54
+src/ui/FloatingManager.ts:71
 
 ## Methods
 
@@ -96,13 +98,15 @@ src/ui/FloatingManager.ts:54
 
 ▸ `Static` `Private` **applyStyle**(`element`, `propertyName`, `value?`): `void`
 
+Adiciona uma propriedade CSS em um elemento HTML.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `element` | `HTMLElement` |
-| `propertyName` | `string` |
-| `value?` | `string` |
+| 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
 
@@ -110,7 +114,7 @@ src/ui/FloatingManager.ts:54
 
 #### Defined in
 
-src/ui/FloatingManager.ts:115
+src/ui/FloatingManager.ts:177
 
 ___
 
@@ -118,11 +122,13 @@ ___
 
 ▸ `Static` **close**(`id`): `void`
 
+Fecha elemento flutuante da tela.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `id` | `number` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `number` | Índice do elemento desejado. |
 
 #### Returns
 
@@ -130,7 +136,7 @@ ___
 
 #### Defined in
 
-src/ui/FloatingManager.ts:233
+src/ui/FloatingManager.ts:364
 
 ___
 
@@ -138,19 +144,23 @@ ___
 
 ▸ `Static` `Private` **createOrUpdatOverlay**(`className?`): `HTMLDivElement`
 
+Cria ou atualiza o elemento de sobreposição.
+
 #### Parameters
 
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `className` | `string` | `FloatingManager.MODAL_DEFAULT_CLASSNAME` |
+| 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:179
+src/ui/FloatingManager.ts:290
 
 ___
 
@@ -158,13 +168,16 @@ ___
 
 ▸ `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:198
+src/ui/FloatingManager.ts:314
 
 ___
 
@@ -172,14 +185,16 @@ ___
 
 ▸ `Static` `Private` **doClose**(`id`, `entry`, `target?`, `event?`): `void`
 
+Fecha uma entrada flutuante (FloatingManager).
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `id` | `number` |
-| `entry` | `FloatingEntry` |
-| `target?` | `HTMLElement` |
-| `event?` | `Event` |
+| 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
 
@@ -187,7 +202,7 @@ ___
 
 #### Defined in
 
-src/ui/FloatingManager.ts:76
+src/ui/FloatingManager.ts:114
 
 ___
 
@@ -195,21 +210,25 @@ ___
 
 ▸ `Static` **float**(`content`, `parent`, `options?`): `number`
 
+Cria e exibe um novo item no FloatingManager.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `content` | `HTMLElement` |
-| `parent` | `HTMLElement` |
-| `options` | `FloatingOptions` |
+| 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:136
+src/ui/FloatingManager.ts:226
 
 ___
 
@@ -217,20 +236,24 @@ ___
 
 ▸ `Static` `Private` **getFloatIndex**(`content`, `parent`): `number`
 
+Obtém o índice do FloatingManager do Elemento HMTL desejado.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `content` | `HTMLElement` |
-| `parent` | `HTMLElement` |
+| 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:121
+src/ui/FloatingManager.ts:191
 
 ___
 
@@ -238,11 +261,13 @@ ___
 
 ▸ `Static` `Private` **handleDocumentEvent**(`event`): `void`
 
+Fecha todas as FloatingManagers abertas.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `event` | `Event` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `event` | `Event` | Evento ocorrido, como clique do mouse, por exemplo. |
 
 #### Returns
 
@@ -250,7 +275,7 @@ ___
 
 #### Defined in
 
-src/ui/FloatingManager.ts:96
+src/ui/FloatingManager.ts:141
 
 ___
 
@@ -258,11 +283,13 @@ ___
 
 ▸ `Static` `Private` **handleKeyboardEvent**(`event`): `void`
 
+Captura eventos de teclado para manipular os elementos flutuantes via eventos da tecla pressionada.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `event` | `KeyboardEvent` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `event` | `KeyboardEvent` | Evento de teclado. |
 
 #### Returns
 
@@ -270,7 +297,7 @@ ___
 
 #### Defined in
 
-src/ui/FloatingManager.ts:103
+src/ui/FloatingManager.ts:155
 
 ___
 
@@ -278,13 +305,15 @@ ___
 
 ▸ `Static` `Private` **hideOverlay**(): `void`
 
+Desfaz o desfoque/overlay dos elementos na tela.
+
 #### Returns
 
 `void`
 
 #### Defined in
 
-src/ui/FloatingManager.ts:167
+src/ui/FloatingManager.ts:270
 
 ___
 
@@ -292,13 +321,15 @@ ___
 
 ▸ `Static` `Private` **init**(): `void`
 
+Inicializa a classe FloatingManager.
+
 #### Returns
 
 `void`
 
 #### Defined in
 
-src/ui/FloatingManager.ts:57
+src/ui/FloatingManager.ts:80
 
 ___
 
@@ -306,6 +337,8 @@ ___
 
 ▸ `Static` `Private` **innerClick**(`container`, `node`): `boolean`
 
+Retorna se o elemento clicado possui elementos internos.
+
 #### Parameters
 
 | Name | Type |
@@ -319,7 +352,7 @@ ___
 
 #### Defined in
 
-src/ui/FloatingManager.ts:64
+src/ui/FloatingManager.ts:92
 
 ___
 
@@ -327,19 +360,23 @@ ___
 
 ▸ `Static` **isFloating**(`id`): `boolean`
 
+Retorna se uma entrada flutuante existe.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `id` | `number` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `number` | Índice para ser verificado no FloatingManager. |
 
 #### Returns
 
 `boolean`
 
+- Verdadeiro se existir.
+
 #### Defined in
 
-src/ui/FloatingManager.ts:132
+src/ui/FloatingManager.ts:211
 
 ___
 
@@ -347,11 +384,13 @@ ___
 
 ▸ `Static` `Private` **showOverlay**(`options`): `void`
 
+Aplica o desfoque na página se o elemento possuir essa option ativada.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `options` | `FloatingOptions` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options` | `FloatingOptions` | Configurações que serão utilizadas no elemento. |
 
 #### Returns
 
@@ -359,7 +398,7 @@ ___
 
 #### Defined in
 
-src/ui/FloatingManager.ts:161
+src/ui/FloatingManager.ts:258
 
 ___
 
@@ -367,13 +406,15 @@ ___
 
 ▸ `Static` **updateFloatPosition**(`content`, `parent`, `options?`): `void`
 
+Atualiza posição de um elemento que já está em tela.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `content` | `HTMLElement` |
-| `parent` | `HTMLElement` |
-| `options` | `FloatingOptions` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `content` | `HTMLElement` | Elemento HTML que será atualizado. |
+| `parent` | `HTMLElement` | Elemento pai do content passado. |
+| `options` | `FloatingOptions` | Novas opções desejadas. |
 
 #### Returns
 
@@ -381,4 +422,4 @@ ___
 
 #### Defined in
 
-src/ui/FloatingManager.ts:222
+src/ui/FloatingManager.ts:346

package/classes/MaskFormatter-1.md

@@ -3,7 +3,7 @@
 # Class: MaskFormatter
 
 `MaskFormatter` é usado para formatar strings. Seu comportamento
-é controlado pela formato do atributo `mask` que especifica quais
+é controlado pelo formato do atributo `mask` que especifica quais
 caracteres são válidos e onde devem estar posicionados, intercalando-os
 com eventuais caracteres literais expressados no padrão informado.
 Sua implementação é inspirada pela implementação em Java do [MaskFormatter](https://docs.oracle.com/javase/7/docs/api/javax/swing/text/MaskFormatter.html).
@@ -14,7 +14,7 @@ Para o padrão da máscara podem ser usados os seguintes caracteres especiais:
 |:---------:|-------------------------------------------------------------------------------------------------------------|
 | #         | Qualquer número                                                                                             |
 | '         | "Escapa" o caractere que vem na sequência. Útil quando desejamos converter um caractere especial em literal.|
-| U         | Qualquer letra. Transforma letras maiúsculas em maiúsculas.                                                 |
+| U         | Qualquer letra. Transforma letras minúsculas em maiúsculas.                                                 |
 | L         | Qualquer letra. Transforma letras maiúsculas em minúsculas.                                                 |
 | A         | Qualquer letra ou número.                                                                                   |
 | ?         | Qualquer letra. Preserva maiúsculas e minúsculas.                                                           |
@@ -23,12 +23,12 @@ Para o padrão da máscara podem ser usados os seguintes caracteres especiais:
 Os demais caracteres presentes no padrão serão tratados como literais, isto é,
 serão apenas inseridos naquela posição.
 
-Quando o o valor a ser formatado é menor que a máscara um 'placeHolder'
+Quando o valor a ser formatado é menor que a máscara, um 'placeHolder'
 será inserido em cada posição ausente, completando a formatação.
-Por padrão será usado um espaço em branco como 'placeHolder' mas
+Por padrão será usado um espaço em branco como 'placeHolder', mas
 esse valor pode ser alterado.
 
-For por exemplo:
+Por exemplo:
 '''
    const formatter: MaskFormatter = new MaskFormatter("###-####");
    formatter.placeholder = '_';
@@ -122,8 +122,8 @@ ___
 
 • **placeholder**: `string` = `' '`
 
-Determina qual caractere será usado dos caracteres não presentes no valor
-ou seja, aqueles que o usuário ainda não informou. Por padrão usamos um espaço
+Determina qual caractere será usado dos caracteres não presentes no valor,
+ou seja, aqueles que o usuário ainda não informou. Por padrão usamos um espaço.
 
 #### Defined in
 
@@ -157,7 +157,7 @@ ___
 
 #### Defined in
 
-src/utils/MaskFormatter.ts:303
+src/utils/MaskFormatter.ts:367
 
 ___
 
@@ -177,7 +177,7 @@ ___
 
 #### Defined in
 
-src/utils/MaskFormatter.ts:311
+src/utils/MaskFormatter.ts:381
 
 ___
 
@@ -197,7 +197,7 @@ ___
 
 #### Defined in
 
-src/utils/MaskFormatter.ts:271
+src/utils/MaskFormatter.ts:292
 
 ___
 
@@ -227,7 +227,7 @@ ___
 
 #### Defined in
 
-src/utils/MaskFormatter.ts:252
+src/utils/MaskFormatter.ts:273
 
 ___
 
@@ -237,7 +237,7 @@ ___
 
 #### Defined in
 
-src/utils/MaskFormatter.ts:292
+src/utils/MaskFormatter.ts:344
 
 ___
 
@@ -257,7 +257,7 @@ ___
 
 #### Defined in
 
-src/utils/MaskFormatter.ts:282
+src/utils/MaskFormatter.ts:321
 
 ## Accessors
 
@@ -265,7 +265,7 @@ src/utils/MaskFormatter.ts:282
 
 • `get` **mask**(): `string`
 
-Getter para mask
+Getter para mask.
 
 #### Returns
 
@@ -307,13 +307,13 @@ Formata a string passada baseada na máscara definda pelo atributo mask.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `value` | `string` | Valor a ser formatado |
+| `value` | `string` | Valor a ser formatado. |
 
 #### Returns
 
 `string`
 
-O valor processado de acordo com o padrão
+O valor processado de acordo com o padrão.
 
 #### Defined in
 
@@ -325,7 +325,7 @@ ___
 
 ▸ `Private` **updateInternalMask**(): `void`
 
-Preparamos a formatação internamente de acordo com o padrão.
+Prepara a formatação internamente de acordo com o padrão.
 
 #### Returns