@sankhyalabs/core-docs 5.20.0-dev.7 → 5.20.0-dev.9

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

package/enumerations/OverflowDirection.md

@@ -0,0 +1,29 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OverflowDirection
+
+# Enumeration: OverflowDirection
+
+Define em qual direção o overflow será observado
+
+## Enumeration Members
+
+### HORIZONTAL
+
+> **HORIZONTAL**: `1`
+
+#### Source
+
+src/utils/OverflowWatcher/types/overflow-direction.ts:6
+
+***
+
+### VERTICAL
+
+> **VERTICAL**: `0`
+
+#### Source
+
+src/utils/OverflowWatcher/types/overflow-direction.ts:5

package/globals.md

@@ -14,6 +14,7 @@
 - [ChangeOperation](enumerations/ChangeOperation.md)
 - [DataType](enumerations/DataType.md)
 - [DependencyType](enumerations/DependencyType.md)
+- [OverflowDirection](enumerations/OverflowDirection.md)
 - [SelectionMode](enumerations/SelectionMode.md)
 - [SortMode](enumerations/SortMode.md)
 - [UserInterface](enumerations/UserInterface.md)
@@ -42,6 +43,7 @@
 - [NumberUtils](classes/NumberUtils.md)
 - [ObjectUtils](classes/ObjectUtils.md)
 - [OnboardingUtils](classes/OnboardingUtils.md)
+- [OverflowWatcher](classes/OverflowWatcher.md)
 - [PromiseSync](classes/PromiseSync.md)
 - [ReadyUtil](classes/ReadyUtil.md)
 - [RequestMetadata](classes/RequestMetadata.md)
@@ -80,6 +82,10 @@
 - [UnitMetadata](interfaces/UnitMetadata.md)
 - [WaitingChange](interfaces/WaitingChange.md)
 
+## Type Aliases
+
+- [OnOverflowCallBack](type-aliases/OnOverflowCallBack.md)
+
 ## Functions
 
 - [defaultDataLoader](functions/defaultDataLoader.md)

package/package.json

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

package/type-aliases/OnOverflowCallBack.md

@@ -0,0 +1,25 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OnOverflowCallBack
+
+# Type alias: OnOverflowCallBack()
+
+> **OnOverflowCallBack**: (`elementsOverFlow`) => `void`
+
+Callback que será chamado quando o overflow de um elemento for alterado.
+
+## Parameters
+
+• **elementsOverFlow**: `Element`[]
+
+Conjunto de elementos filhos que estão causando overflow no elemento pai.
+
+## Returns
+
+`void`
+
+## Source
+
+src/utils/OverflowWatcher/types/overflow-callback.ts:6