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

package/classes/OverflowWatcher.md

@@ -0,0 +1,533 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OverflowWatcher
+
+# Class: OverflowWatcher
+
+## Constructors
+
+### new OverflowWatcher()
+
+> **new OverflowWatcher**(`__namedParameters`): [`OverflowWatcher`](OverflowWatcher.md)
+
+Cria uma instancia do OverflowWatcher
+
+#### Parameters
+
+• **\_\_namedParameters**: [`OverFlowWatcherParams`](../interfaces/OverFlowWatcherParams.md)
+
+#### Returns
+
+[`OverflowWatcher`](OverflowWatcher.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:35
+
+## Properties
+
+### DATA\_ELEMENT\_ID
+
+> `readonly` **DATA\_ELEMENT\_ID**: `"data-element-id"` = `'data-element-id'`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:23
+
+***
+
+### \_deltaSize
+
+> `private` **\_deltaSize**: `number`
+
+#### 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
+
+***
+
+### \_lastContainerSize
+
+> `private` **\_lastContainerSize**: `undefined` \| `number` = `undefined`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:14
+
+***
+
+### \_notOverFlow
+
+> `private` **\_notOverFlow**: `string`[] = `[]`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:21
+
+***
+
+### \_notOverFlowPros
+
+> `private` **\_notOverFlowPros**: `Map`\<`string`, `SizeProps`\>
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:19
+
+***
+
+### \_onResize
+
+> `private` **\_onResize**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:12
+
+***
+
+### \_propSize
+
+> `private` **\_propSize**: `string`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:17
+
+***
+
+### \_resizeObserver
+
+> `private` **\_resizeObserver**: `ResizeObserver`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:13
+
+***
+
+### \_scrollDirection
+
+> `private` **\_scrollDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md) = `OverflowDirection.HORIZONTAL`
+
+#### Source
+
+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`
+
+#### Parameters
+
+• **children**: `Element`[]
+
+#### Returns
+
+`number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:205
+
+***
+
+### calcElementSize()
+
+> `private` **calcElementSize**(`el`): `number`
+
+#### Parameters
+
+• **el**: `Element`
+
+#### Returns
+
+`number`
+
+#### Source
+
+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
+
+***
+
+### destroy()
+
+> **destroy**(): `void`
+
+#### Returns
+
+`void`
+
+#### Source
+
+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
+
+***
+
+### getDataElementId()
+
+> `private` **getDataElementId**(`element`): `string`
+
+#### Parameters
+
+• **element**: `Element`
+
+#### Returns
+
+`string`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:162
+
+***
+
+### getElementSizeProps()
+
+> `private` **getElementSizeProps**(`element`): `SizeProps`
+
+#### Parameters
+
+• **element**: `Element`
+
+#### Returns
+
+`SizeProps`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:197
+
+***
+
+### handleResize()
+
+> `private` **handleResize**(`entries`): `void`
+
+#### Parameters
+
+• **entries**: `ResizeObserverEntry`[]
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:68
+
+***
+
+### hasChangedSize()
+
+> `private` **hasChangedSize**(`elementSize`): `boolean`
+
+#### Parameters
+
+• **elementSize**: `number`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+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
+
+***
+
+### proccessElements()
+
+> `private` **proccessElements**(`elementSize`, `children`): `void`
+
+#### Parameters
+
+• **elementSize**: `number`
+
+• **children**: `Element`[]
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:112
+
+***
+
+### proccessElementsOverFlow()
+
+> `private` **proccessElementsOverFlow**(`allElements`, `avaliableSize`): `void`
+
+#### Parameters
+
+• **allElements**: `Element`[]
+
+• **avaliableSize**: `number`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:131
+
+***
+
+### registerElementSize()
+
+> `private` **registerElementSize**(`element`): `void`
+
+#### Parameters
+
+• **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
+
+`void`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:80

package/classes/PromiseSync.md

@@ -1,50 +1,33 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PromiseSync
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: PromiseSync<T\>
+***
+
+[@sankhyalabs/core](../globals.md) / PromiseSync
+
+# Class: PromiseSync\<T\>
 
 O intuito desta classe é organizar a finalização de várias
 promessas executando determinada ação (callback) com o resultado.
 
 ## Type parameters
 
-| Name |
-| :------ |
-| `T` |
-
-## Table of contents
-
-### Constructors
-
-- [constructor](PromiseSync.md#constructor)
-
-### Properties
-
-- [\_callBack](PromiseSync.md#_callback)
-- [\_promises](PromiseSync.md#_promises)
-
-### Methods
-
-- [add](PromiseSync.md#add)
+• **T**
 
 ## Constructors
 
-### constructor
+### new PromiseSync()
 
-• **new PromiseSync**<`T`\>(`callBack`)
+> **new PromiseSync**\<`T`\>(`callBack`): [`PromiseSync`](PromiseSync.md)\<`T`\>
 
-#### Type parameters
+#### Parameters
 
-| Name |
-| :------ |
-| `T` |
+• **callBack**: [`PromiseSyncCallback`](../interfaces/PromiseSyncCallback.md)\<`T`\>
 
-#### Parameters
+#### Returns
 
-| Name | Type |
-| :------ | :------ |
-| `callBack` | [`PromiseSyncCallback`](../interfaces/PromiseSyncCallback.md)<`T`\> |
+[`PromiseSync`](PromiseSync.md)\<`T`\>
 
-#### Defined in
+#### Source
 
 src/async/PromiseSync.ts:13
 
@@ -52,40 +35,40 @@ src/async/PromiseSync.ts:13
 
 ### \_callBack
 
-• **\_callBack**: [`PromiseSyncCallback`](../interfaces/PromiseSyncCallback.md)<`T`\>
+> **\_callBack**: [`PromiseSyncCallback`](../interfaces/PromiseSyncCallback.md)\<`T`\>
 
-#### Defined in
+#### Source
 
 src/async/PromiseSync.ts:8
 
-___
+***
 
 ### \_promises
 
-• **\_promises**: `Promise`<`T`\>[]
+> **\_promises**: `Promise`\<`T`\>[]
 
-#### Defined in
+#### Source
 
 src/async/PromiseSync.ts:7
 
 ## Methods
 
-### add
+### add()
 
-▸ **add**(`promise`): `void`
+> **add**(`promise`): `void`
 
 Adiciona na lista de promises pendentes. Isso faz com que criemos uma nova espera.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `promise` | `Promise`<`T`\> | Entrará na lista aguardada. |
+• **promise**: `Promise`\<`T`\>
+
+Entrará na lista aguardada.
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/async/PromiseSync.ts:23