@sankhyalabs/core-docs 5.20.0-dev.8 → 5.20.0-dev.80

package/classes/ObjectUtils.md

@@ -76,6 +76,195 @@ src/utils/ObjectUtils.ts:84
 
 ***
 
+### getComparableProp()
+
+> `static` `private` **getComparableProp**(`value`, `propToCompare`): `boolean`
+
+#### Parameters
+
+• **value**: `any`
+
+• **propToCompare**: `string`= `"value"`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/ObjectUtils.ts:106
+
+***
+
+### getProp()
+
+> `static` **getProp**(`obj`, `keyPath`): `undefined` \| `Record`\<`string`, `any`\>
+
+Busca a propriedade de um objeto baseado em seu caminho.
+
+#### Parameters
+
+• **obj**: `Record`\<`string`, `any`\>
+
+Objeto a ser verificado.
+
+• **keyPath**: `string`
+
+Caminho da propriedade a ser buscada.
+
+#### Returns
+
+`undefined` \| `Record`\<`string`, `any`\>
+
+- O valor da propriedade caso ela exista.
+
+#### Source
+
+src/utils/ObjectUtils.ts:161
+
+***
+
+### hasEquivalentProps()
+
+> `static` **hasEquivalentProps**(`obj1`, `obj2`, `propToCompare`): `boolean`
+
+Compara se o valor de dois items são equivalentes.
+Comparando tanto o valor do item em si, quanto sua propriedade "value"
+
+#### Parameters
+
+• **obj1**: `any`
+
+Objeto a ser comparado.
+
+• **obj2**: `any`
+
+Objeto a ser comparado.
+
+• **propToCompare**: `string`= `"value"`
+
+propriedade que deve ser comparada.
+
+#### Returns
+
+`boolean`
+
+- Se o objeto 1 é equivalente ao objeto 2.
+
+*
+
+#### Examples
+
+```ts
+hasEquivalentProps('123', {value: '123', label: teste}, 'value') | Retorna: true
+```
+
+```ts
+hasEquivalentProps('xpto', {value: '123', label: teste}, 'propName') | Retorna: false
+```
+
+#### Source
+
+src/utils/ObjectUtils.ts:102
+
+***
+
+### isEmpty()
+
+> `static` **isEmpty**(`obj`): `boolean`
+
+Verifica se o objeto está vazio (sem atributos).
+
+#### Parameters
+
+• **obj**: `object`
+
+Objeto a ser verificado.
+
+#### Returns
+
+`boolean`
+
+- True caso o objeto esteja vazio.
+
+#### Source
+
+src/utils/ObjectUtils.ts:119
+
+***
+
+### isEmptySafetyCheck()
+
+> `static` **isEmptySafetyCheck**(`obj`): `boolean`
+
+Verifica se o objeto está vazio (sem atributos) e retorna true caso seja undefined ou null.
+
+#### Parameters
+
+• **obj**: `object`
+
+Objeto a ser verificado.
+
+#### Returns
+
+`boolean`
+
+- True caso o objeto esteja vazio.
+
+#### Source
+
+src/utils/ObjectUtils.ts:129
+
+***
+
+### isNotEmpty()
+
+> `static` **isNotEmpty**(`obj`): `boolean`
+
+Verifica se o objeto NÃO está vazio (sem atributos).
+
+#### Parameters
+
+• **obj**: `object`
+
+Objeto a ser verificado.
+
+#### Returns
+
+`boolean`
+
+- True caso o objeto NÃO esteja vazio
+
+#### Source
+
+src/utils/ObjectUtils.ts:140
+
+***
+
+### isNotEmptySafetyCheck()
+
+> `static` **isNotEmptySafetyCheck**(`obj`): `boolean`
+
+Verifica se o objeto NÃO está vazio (sem atributos) e retorna false caso objeto seja null ou undefined.
+
+#### Parameters
+
+• **obj**: `object`
+
+Objeto a ser verificado.
+
+#### Returns
+
+`boolean`
+
+- True caso o objeto NÃO esteja vazio
+
+#### Source
+
+src/utils/ObjectUtils.ts:150
+
+***
+
 ### objectToString()
 
 > `static` **objectToString**(`data`): `string`

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