@sankhyalabs/core-docs 5.20.0-dev.14 → 5.20.0-dev.17

package/classes/OverflowWatcher.md

@@ -10,37 +10,33 @@
 
 ### new OverflowWatcher()
 
-> **new OverflowWatcher**(`element`, `callback`, `overFlowDirection`, `deltaSize`): [`OverflowWatcher`](OverflowWatcher.md)
+> **new OverflowWatcher**(`__namedParameters`): [`OverflowWatcher`](OverflowWatcher.md)
 
 Cria uma instancia do OverflowWatcher
 
 #### Parameters
 
-• **element**: `HTMLElement`
+• **\_\_namedParameters**: [`OverFlowWatcherParams`](../interfaces/OverFlowWatcherParams.md)
 
-Elemento HTML que o overflow será observado.
-
-• **callback**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
-
-Função que sera chamada quando ocorrer overflow no elemento.
+#### Returns
 
-• **overFlowDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md)= `OverflowDirection.HORIZONTAL`
+[`OverflowWatcher`](OverflowWatcher.md)
 
-Indica direção que o overflow será monitorado.
+#### Source
 
-• **deltaSize**: `number`= `10`
+src/utils/OverflowWatcher/index.ts:35
 
-Variação de tamanho que será considerada como overflow.
+## Properties
 
-#### Returns
+### DATA\_ELEMENT\_ID
 
-[`OverflowWatcher`](OverflowWatcher.md)
+> `readonly` **DATA\_ELEMENT\_ID**: `"data-element-id"` = `'data-element-id'`
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:25
+src/utils/OverflowWatcher/index.ts:23
 
-## Properties
+***
 
 ### \_deltaSize
 
@@ -48,13 +44,33 @@ src/utils/OverflowWatcher/index.ts:25
 
 #### Source
 
+src/utils/OverflowWatcher/index.ts:20
+
+***
+
+### \_hiddenItemsProps
+
+> `private` **\_hiddenItemsProps**: `Map`\<`Element`, `SizeProps`\>
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:18
+
+***
+
+### \_lastContainerInstance
+
+> `private` **\_lastContainerInstance**: `undefined` \| `HTMLElement` = `undefined`
+
+#### Source
+
 src/utils/OverflowWatcher/index.ts:15
 
 ***
 
-### \_hiddenItems
+### \_lastContainerSize
 
-> `private` **\_hiddenItems**: `Element`[] = `[]`
+> `private` **\_lastContainerSize**: `undefined` \| `number` = `undefined`
 
 #### Source
 
@@ -62,13 +78,23 @@ src/utils/OverflowWatcher/index.ts:14
 
 ***
 
-### \_lastContentRect
+### \_notOverFlow
+
+> `private` **\_notOverFlow**: `string`[] = `[]`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:21
+
+***
+
+### \_notOverFlowPros
 
-> `private` **\_lastContentRect**: `undefined` \| `DOMRectReadOnly` = `undefined`
+> `private` **\_notOverFlowPros**: `Map`\<`string`, `SizeProps`\>
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:11
+src/utils/OverflowWatcher/index.ts:19
 
 ***
 
@@ -78,7 +104,7 @@ src/utils/OverflowWatcher/index.ts:11
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:9
+src/utils/OverflowWatcher/index.ts:12
 
 ***
 
@@ -88,7 +114,7 @@ src/utils/OverflowWatcher/index.ts:9
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:13
+src/utils/OverflowWatcher/index.ts:17
 
 ***
 
@@ -98,7 +124,7 @@ src/utils/OverflowWatcher/index.ts:13
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:10
+src/utils/OverflowWatcher/index.ts:13
 
 ***
 
@@ -108,10 +134,28 @@ src/utils/OverflowWatcher/index.ts:10
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:12
+src/utils/OverflowWatcher/index.ts:16
 
 ## Methods
 
+### addNotOverFlowElement()
+
+> **addNotOverFlowElement**(`elementId`): `void`
+
+#### Parameters
+
+• **elementId**: `string`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:52
+
+***
+
 ### calcChildrenSize()
 
 > `private` **calcChildrenSize**(`children`): `number`
@@ -126,13 +170,13 @@ src/utils/OverflowWatcher/index.ts:12
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:126
+src/utils/OverflowWatcher/index.ts:205
 
 ***
 
-### calcMarginSize()
+### calcElementSize()
 
-> `private` **calcMarginSize**(`el`): `number`
+> `private` **calcElementSize**(`el`): `number`
 
 #### Parameters
 
@@ -144,7 +188,93 @@ src/utils/OverflowWatcher/index.ts:126
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:141
+src/utils/OverflowWatcher/index.ts:212
+
+***
+
+### calculateVariation()
+
+> `private` **calculateVariation**(`elementIdsToCalculate`): `number`
+
+#### Parameters
+
+• **elementIdsToCalculate**: `string`[]
+
+#### Returns
+
+`number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:177
+
+***
+
+### canNotOverFlowNotIncludedIds()
+
+> `private` **canNotOverFlowNotIncludedIds**(`elements`): `string`[]
+
+#### Parameters
+
+• **elements**: `Element`[]
+
+#### Returns
+
+`string`[]
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:187
+
+***
+
+### canNotRegisterNotOverFlow()
+
+> `private` **canNotRegisterNotOverFlow**(`id`): `boolean`
+
+#### Parameters
+
+• **id**: `string`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:96
+
+***
+
+### canOverFlowElement()
+
+> `private` **canOverFlowElement**(`element`): `boolean`
+
+#### Parameters
+
+• **element**: `Element`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:157
+
+***
+
+### clearOverFlow()
+
+> `private` **clearOverFlow**(): `void`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:126
 
 ***
 
@@ -158,13 +288,53 @@ src/utils/OverflowWatcher/index.ts:141
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:37
+src/utils/OverflowWatcher/index.ts:58
+
+***
+
+### exceedsAvaliableSize()
+
+> `private` **exceedsAvaliableSize**(`sumElementsSize`, `elements`, `avaliableSize`): `boolean`
+
+#### Parameters
+
+• **sumElementsSize**: `number`
+
+• **elements**: `Element`[]
+
+• **avaliableSize**: `number`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:166
+
+***
+
+### forceUpdate()
+
+> **forceUpdate**(): `void`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:62
 
 ***
 
-### getPropSizeByDirection()
+### getDataElementId()
+
+> `private` **getDataElementId**(`element`): `string`
+
+#### Parameters
 
-> `private` **getPropSizeByDirection**(): `string`
+• **element**: `Element`
 
 #### Returns
 
@@ -172,7 +342,25 @@ src/utils/OverflowWatcher/index.ts:37
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:65
+src/utils/OverflowWatcher/index.ts:162
+
+***
+
+### getElementSizeProps()
+
+> `private` **getElementSizeProps**(`element`): `SizeProps`
+
+#### Parameters
+
+• **element**: `Element`
+
+#### Returns
+
+`SizeProps`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:197
 
 ***
 
@@ -190,17 +378,17 @@ src/utils/OverflowWatcher/index.ts:65
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:41
+src/utils/OverflowWatcher/index.ts:68
 
 ***
 
-### isChangedSize()
+### hasChangedSize()
 
-> `private` **isChangedSize**(`newContentRect`): `boolean`
+> `private` **hasChangedSize**(`elementSize`): `boolean`
 
 #### Parameters
 
-• **newContentRect**: `DOMRectReadOnly`
+• **elementSize**: `number`
 
 #### Returns
 
@@ -208,7 +396,45 @@ src/utils/OverflowWatcher/index.ts:41
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:57
+src/utils/OverflowWatcher/index.ts:100
+
+***
+
+### isElementOverFlowing()
+
+> `private` **isElementOverFlowing**(`elementsThatFit`, `element`): `boolean`
+
+#### Parameters
+
+• **elementsThatFit**: `Element`[]
+
+• **element**: `Element`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:153
+
+***
+
+### isOverFlowed()
+
+> `private` **isOverFlowed**(`el`): `boolean`
+
+#### Parameters
+
+• **el**: `Element`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:226
 
 ***
 
@@ -228,19 +454,19 @@ src/utils/OverflowWatcher/index.ts:57
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:73
+src/utils/OverflowWatcher/index.ts:112
 
 ***
 
 ### proccessElementsOverFlow()
 
-> `private` **proccessElementsOverFlow**(`children`, `diff`): `void`
+> `private` **proccessElementsOverFlow**(`allElements`, `avaliableSize`): `void`
 
 #### Parameters
 
-• **children**: `Element`[]
+• **allElements**: `Element`[]
 
-• **diff**: `number`
+• **avaliableSize**: `number`
 
 #### Returns
 
@@ -248,17 +474,55 @@ src/utils/OverflowWatcher/index.ts:73
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:103
+src/utils/OverflowWatcher/index.ts:131
 
 ***
 
-### proccessElementsWithoutOverFlow()
+### registerElementSize()
 
-> `private` **proccessElementsWithoutOverFlow**(`diff`): `void`
+> `private` **registerElementSize**(`element`): `void`
 
 #### Parameters
 
-• **diff**: `number`
+• **element**: `Element`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:192
+
+***
+
+### registerNotOverflowProps()
+
+> `private` **registerNotOverflowProps**(`children`): `void`
+
+#### Parameters
+
+• **children**: `Element`[]
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:88
+
+***
+
+### updateOverFlowedItems()
+
+> `private` **updateOverFlowedItems**(`container`, `containerSize`): `void`
+
+#### Parameters
+
+• **container**: `HTMLElement`
+
+• **containerSize**: `number`
 
 #### Returns
 
@@ -266,4 +530,4 @@ src/utils/OverflowWatcher/index.ts:103
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:91
+src/utils/OverflowWatcher/index.ts:80

package/globals.md

@@ -71,6 +71,7 @@
 - [IRepositoryIndex](interfaces/IRepositoryIndex.md)
 - [LoadDataRequest](interfaces/LoadDataRequest.md)
 - [LoadDataResponse](interfaces/LoadDataResponse.md)
+- [OverFlowWatcherParams](interfaces/OverFlowWatcherParams.md)
 - [PageRequest](interfaces/PageRequest.md)
 - [PaginationInfo](interfaces/PaginationInfo.md)
 - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
@@ -86,6 +87,10 @@
 
 - [OnOverflowCallBack](type-aliases/OnOverflowCallBack.md)
 
+## Variables
+
+- [OVERFLOWED\_CLASS\_NAME](variables/OVERFLOWED_CLASS_NAME.md)
+
 ## Functions
 
 - [defaultDataLoader](functions/defaultDataLoader.md)

package/interfaces/OverFlowWatcherParams.md

@@ -0,0 +1,67 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OverFlowWatcherParams
+
+# Interface: OverFlowWatcherParams
+
+## Properties
+
+### callback
+
+> **callback**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:233
+
+***
+
+### debounce?
+
+> `optional` **debounce**: `number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:236
+
+***
+
+### deltaSize?
+
+> `optional` **deltaSize**: `number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:235
+
+***
+
+### element
+
+> **element**: `HTMLElement`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:232
+
+***
+
+### notOverFlow?
+
+> `optional` **notOverFlow**: `string`[]
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:237
+
+***
+
+### overFlowDirection?
+
+> `optional` **overFlowDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:234

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sankhyalabs/core-docs",
-    "version": "5.20.0-dev.14",
+    "version": "5.20.0-dev.17",
     "description": "Documentação da biblioteca de componentes Sankhya.",
     "main": "",
     "files": [

package/variables/OVERFLOWED_CLASS_NAME.md

@@ -0,0 +1,13 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OVERFLOWED\_CLASS\_NAME
+
+# Variable: OVERFLOWED\_CLASS\_NAME
+
+> `const` **OVERFLOWED\_CLASS\_NAME**: `"overflowed"` = `'overflowed'`
+
+## Source
+
+src/utils/OverflowWatcher/index.ts:9