@sankhyalabs/core-docs 5.15.5 → 5.16.0

package/classes/ObjectUtils.md

@@ -1,48 +1,40 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ObjectUtils
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: ObjectUtils
+***
 
-`ObjectUtils`: Utilizado para manipulação de objetos.
+[@sankhyalabs/core](../globals.md) / ObjectUtils
 
-## Table of contents
+# Class: ObjectUtils
 
-### Constructors
+`ObjectUtils`: Utilizado para manipulação de objetos.
 
-- [constructor](ObjectUtils.md#constructor)
+## Constructors
 
-### Methods
+### new ObjectUtils()
 
-- [copy](ObjectUtils.md#copy)
-- [objectToString](ObjectUtils.md#objecttostring)
-- [removeEmptyValues](ObjectUtils.md#removeemptyvalues)
-- [sortByProperty](ObjectUtils.md#sortbyproperty)
-- [stringToObject](ObjectUtils.md#stringtoobject)
+> **new ObjectUtils**(): [`ObjectUtils`](ObjectUtils.md)
 
-## Constructors
-
-### constructor
+#### Returns
 
-• **new ObjectUtils**()
+[`ObjectUtils`](ObjectUtils.md)
 
 ## Methods
 
-### copy
+### copy()
 
-▸ `Static` **copy**<`T`\>(`data`): `T`
+> `static` **copy**\<`T`\>(`data`): `T`
 
 Faz a cópia do objeto.
 
 #### Type parameters
 
-| Name |
-| :------ |
-| `T` |
+• **T**
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `data` | `Object` \| `Object`[] | Objeto a ser copiado. |
+• **data**: `Object` \| `Object`[]
+
+Objeto a ser copiado.
 
 #### Returns
 
@@ -50,27 +42,51 @@ Faz a cópia do objeto.
 
 - A cópia do objeto válido.
 
-#### Defined in
+#### Source
 
 src/utils/ObjectUtils.ts:13
 
-___
+***
 
-### objectToString
+### equals()
 
-▸ `Static` **objectToString**(`data`): `string`
+> `static` **equals**(`obj1`, `obj2`): `any`
 
-Converte um objeto em string/JSON.
+Compara se um objeto é igual a outro objeto.
 
-**`Example`**
+#### Parameters
 
-@Informado: ```{nome : "Sankhya", cidade: "Uberlandia"}``` | Obtenho: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"```
+• **obj1**: `any`
+
+Objeto a ser comparado.
+
+• **obj2**: `any`
+
+Objeto a ser comparado.
+
+#### Returns
+
+`any`
+
+- Se o objeto 1 é igual ao objeto 2.
+
+#### Source
+
+src/utils/ObjectUtils.ts:84
+
+***
+
+### objectToString()
+
+> `static` **objectToString**(`data`): `string`
+
+Converte um objeto em string/JSON.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `data` | `Object` \| `Object`[] | Objeto a ser convertido. |
+• **data**: `Object` \| `Object`[]
+
+Objeto a ser convertido.
 
 #### Returns
 
@@ -78,23 +94,25 @@ Converte um objeto em string/JSON.
 
 - Uma string JSON.
 
-#### Defined in
+#### Example
+
+@Informado: ```{nome : "Sankhya", cidade: "Uberlandia"}``` | Obtenho: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"```
+
+#### Source
 
 src/utils/ObjectUtils.ts:26
 
-___
+***
 
-### removeEmptyValues
+### removeEmptyValues()
 
-▸ `Static` **removeEmptyValues**(`obj`): `object`
+> `static` **removeEmptyValues**(`obj`): `object`
 
 Remove atributos nulos e indefinidos de um objeto.
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `obj` | `object` |
+• **obj**: `object`
 
 #### Returns
 
@@ -102,24 +120,27 @@ Remove atributos nulos e indefinidos de um objeto.
 
 - O objeto com as propriedades válidas.
 
-#### Defined in
+#### Source
 
 src/utils/ObjectUtils.ts:68
 
-___
+***
 
-### sortByProperty
+### sortByProperty()
 
-▸ `Static` **sortByProperty**(`data`, `property`): `any`
+> `static` **sortByProperty**(`data`, `property`): `any`
 
 Faz a ordenação de um objeto por uma propriedade.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `data` | `any` | Objeto a ser ordenado. |
-| `property` | `string` | Nome da propriedade a ser ordenada. |
+• **data**: `any`
+
+Objeto a ser ordenado.
+
+• **property**: `string`
+
+Nome da propriedade a ser ordenada.
 
 #### Returns
 
@@ -127,27 +148,23 @@ Faz a ordenação de um objeto por uma propriedade.
 
 - O objeto ordenado pela propriedade.
 
-#### Defined in
+#### Source
 
 src/utils/ObjectUtils.ts:50
 
-___
+***
 
-### stringToObject
+### stringToObject()
 
-▸ `Static` **stringToObject**(`data`): `Object` \| `Object`[]
+> `static` **stringToObject**(`data`): `Object` \| `Object`[]
 
 Converte uma string/JSON em objeto.
 
-**`Example`**
-
-Informado: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"``` | Obtenho: ```{nome : "Sankhya", cidade: "Uberlandia"}```
-
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `data` | `string` | String a ser convertida. |
+• **data**: `string`
+
+String a ser convertida.
 
 #### Returns
 
@@ -155,6 +172,10 @@ Informado: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"``` | Obtenho: ```{no
 
 - Um objeto válido.
 
-#### Defined in
+#### Example
+
+Informado: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"``` | Obtenho: ```{nome : "Sankhya", cidade: "Uberlandia"}```
+
+#### Source
 
 src/utils/ObjectUtils.ts:39

package/classes/OnboardingUtils.md

@@ -1,32 +1,22 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / OnboardingUtils
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: OnboardingUtils
-
-## Table of contents
-
-### Constructors
+***
 
-- [constructor](OnboardingUtils.md#constructor)
+[@sankhyalabs/core](../globals.md) / OnboardingUtils
 
-### Properties
-
-- [USER\_GUIDE\_TAG\_ID](OnboardingUtils.md#user_guide_tag_id)
-- [instance](OnboardingUtils.md#instance)
+# Class: OnboardingUtils
 
-### Methods
+## Constructors
 
-- [init](OnboardingUtils.md#init)
-- [injectScript](OnboardingUtils.md#injectscript)
-- [register](OnboardingUtils.md#register)
-- [getInstance](OnboardingUtils.md#getinstance)
+### new OnboardingUtils()
 
-## Constructors
+> `private` **new OnboardingUtils**(): [`OnboardingUtils`](OnboardingUtils.md)
 
-### constructor
+#### Returns
 
-• `Private` **new OnboardingUtils**()
+[`OnboardingUtils`](OnboardingUtils.md)
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:5
 
@@ -34,93 +24,88 @@ src/utils/OnboardingUtils.ts:5
 
 ### USER\_GUIDE\_TAG\_ID
 
-▪ `Static` `Private` `Readonly` **USER\_GUIDE\_TAG\_ID**: ``"userGuideSnippet"``
+> `static` `private` `readonly` **USER\_GUIDE\_TAG\_ID**: `"userGuideSnippet"` = `"userGuideSnippet"`
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:2
 
-___
+***
 
 ### instance
 
-▪ `Static` `Private` **instance**: [`OnboardingUtils`](OnboardingUtils.md)
+> `static` `private` **instance**: [`OnboardingUtils`](OnboardingUtils.md)
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:3
 
 ## Methods
 
-### init
+### init()
 
-▸ **init**(`apiKey`, `ctx`): `Promise`<`void`\>
+> **init**(`apiKey`, `ctx`): `Promise`\<`void`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `apiKey` | `string` |
-| `ctx` | `EnvironmentContext` |
+• **apiKey**: `string`
+
+• **ctx**: `EnvironmentContext`
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:14
 
-___
+***
 
-### injectScript
+### injectScript()
 
-▸ `Private` **injectScript**(`apiKey`): `void`
+> `private` **injectScript**(`apiKey`): `void`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `apiKey` | `string` |
+• **apiKey**: `string`
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:23
 
-___
+***
 
-### register
+### register()
 
-▸ `Private` **register**(`ctx`): `void`
+> `private` **register**(`ctx`): `void`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `ctx` | `EnvironmentContext` |
+• **ctx**: `EnvironmentContext`
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:34
 
-___
+***
 
-### getInstance
+### getInstance()
 
-▸ `Static` **getInstance**(): [`OnboardingUtils`](OnboardingUtils.md)
+> `static` **getInstance**(): [`OnboardingUtils`](OnboardingUtils.md)
 
 #### Returns
 
 [`OnboardingUtils`](OnboardingUtils.md)
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:7

package/classes/OverflowWatcher.md

@@ -0,0 +1,269 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OverflowWatcher
+
+# Class: OverflowWatcher
+
+## Constructors
+
+### new OverflowWatcher()
+
+> **new OverflowWatcher**(`element`, `callback`, `overFlowDirection`, `deltaSize`): [`OverflowWatcher`](OverflowWatcher.md)
+
+Cria uma instancia do OverflowWatcher
+
+#### Parameters
+
+• **element**: `HTMLElement`
+
+Elemento HTML que o overflow será observado.
+
+• **callback**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
+
+Função que sera chamada quando ocorrer overflow no elemento.
+
+• **overFlowDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md)= `OverflowDirection.HORIZONTAL`
+
+Indica direção que o overflow será monitorado.
+
+• **deltaSize**: `number`= `10`
+
+Variação de tamanho que será considerada como overflow.
+
+#### Returns
+
+[`OverflowWatcher`](OverflowWatcher.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:25
+
+## Properties
+
+### \_deltaSize
+
+> `private` **\_deltaSize**: `number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:15
+
+***
+
+### \_hiddenItems
+
+> `private` **\_hiddenItems**: `Element`[] = `[]`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:14
+
+***
+
+### \_lastContentRect
+
+> `private` **\_lastContentRect**: `undefined` \| `DOMRectReadOnly` = `undefined`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:11
+
+***
+
+### \_onResize
+
+> `private` **\_onResize**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:9
+
+***
+
+### \_propSize
+
+> `private` **\_propSize**: `string`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:13
+
+***
+
+### \_resizeObserver
+
+> `private` **\_resizeObserver**: `ResizeObserver`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:10
+
+***
+
+### \_scrollDirection
+
+> `private` **\_scrollDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md) = `OverflowDirection.HORIZONTAL`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:12
+
+## Methods
+
+### calcChildrenSize()
+
+> `private` **calcChildrenSize**(`children`): `number`
+
+#### Parameters
+
+• **children**: `Element`[]
+
+#### Returns
+
+`number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:126
+
+***
+
+### calcMarginSize()
+
+> `private` **calcMarginSize**(`el`): `number`
+
+#### Parameters
+
+• **el**: `Element`
+
+#### Returns
+
+`number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:141
+
+***
+
+### destroy()
+
+> **destroy**(): `void`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:37
+
+***
+
+### getPropSizeByDirection()
+
+> `private` **getPropSizeByDirection**(): `string`
+
+#### Returns
+
+`string`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:65
+
+***
+
+### handleResize()
+
+> `private` **handleResize**(`entries`): `void`
+
+#### Parameters
+
+• **entries**: `ResizeObserverEntry`[]
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:41
+
+***
+
+### isChangedSize()
+
+> `private` **isChangedSize**(`newContentRect`): `boolean`
+
+#### Parameters
+
+• **newContentRect**: `DOMRectReadOnly`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:57
+
+***
+
+### proccessElements()
+
+> `private` **proccessElements**(`elementSize`, `children`): `void`
+
+#### Parameters
+
+• **elementSize**: `number`
+
+• **children**: `Element`[]
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:73
+
+***
+
+### proccessElementsOverFlow()
+
+> `private` **proccessElementsOverFlow**(`children`, `diff`): `void`
+
+#### Parameters
+
+• **children**: `Element`[]
+
+• **diff**: `number`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:103
+
+***
+
+### proccessElementsWithoutOverFlow()
+
+> `private` **proccessElementsWithoutOverFlow**(`diff`): `void`
+
+#### Parameters
+
+• **diff**: `number`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:91