@sankhyalabs/core-docs 5.17.0-rc.1 → 5.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -76,6 +76,54 @@ src/utils/ObjectUtils.ts:84
76
76
 
77
77
  ***
78
78
 
79
+ ### isEmpty()
80
+
81
+ > `static` **isEmpty**(`obj`): `boolean`
82
+
83
+ Verifica se o objeto está vazio (sem atributos).
84
+
85
+ #### Parameters
86
+
87
+ • **obj**: `object`
88
+
89
+ Objeto a ser verificado.
90
+
91
+ #### Returns
92
+
93
+ `boolean`
94
+
95
+ - True caso o objeto esteja vazio.
96
+
97
+ #### Source
98
+
99
+ src/utils/ObjectUtils.ts:94
100
+
101
+ ***
102
+
103
+ ### isNotEmpty()
104
+
105
+ > `static` **isNotEmpty**(`obj`): `boolean`
106
+
107
+ Verifica se o objeto NÃO está vazio (sem atributos).
108
+
109
+ #### Parameters
110
+
111
+ • **obj**: `object`
112
+
113
+ Objeto a ser verificado.
114
+
115
+ #### Returns
116
+
117
+ `boolean`
118
+
119
+ - True caso o objeto NÃO esteja vazio
120
+
121
+ #### Source
122
+
123
+ src/utils/ObjectUtils.ts:104
124
+
125
+ ***
126
+
79
127
  ### objectToString()
80
128
 
81
129
  > `static` **objectToString**(`data`): `string`
@@ -10,37 +10,33 @@
10
10
 
11
11
  ### new OverflowWatcher()
12
12
 
13
- > **new OverflowWatcher**(`element`, `callback`, `overFlowDirection`, `deltaSize`): [`OverflowWatcher`](OverflowWatcher.md)
13
+ > **new OverflowWatcher**(`__namedParameters`): [`OverflowWatcher`](OverflowWatcher.md)
14
14
 
15
15
  Cria uma instancia do OverflowWatcher
16
16
 
17
17
  #### Parameters
18
18
 
19
- **element**: `HTMLElement`
19
+ **\_\_namedParameters**: [`OverFlowWatcherParams`](../interfaces/OverFlowWatcherParams.md)
20
20
 
21
- Elemento HTML que o overflow será observado.
22
-
23
- • **callback**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
24
-
25
- Função que sera chamada quando ocorrer overflow no elemento.
21
+ #### Returns
26
22
 
27
- • **overFlowDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md)= `OverflowDirection.HORIZONTAL`
23
+ [`OverflowWatcher`](OverflowWatcher.md)
28
24
 
29
- Indica direção que o overflow será monitorado.
25
+ #### Source
30
26
 
31
- • **deltaSize**: `number`= `10`
27
+ src/utils/OverflowWatcher/index.ts:35
32
28
 
33
- Variação de tamanho que será considerada como overflow.
29
+ ## Properties
34
30
 
35
- #### Returns
31
+ ### DATA\_ELEMENT\_ID
36
32
 
37
- [`OverflowWatcher`](OverflowWatcher.md)
33
+ > `readonly` **DATA\_ELEMENT\_ID**: `"data-element-id"` = `'data-element-id'`
38
34
 
39
35
  #### Source
40
36
 
41
- src/utils/OverflowWatcher/index.ts:25
37
+ src/utils/OverflowWatcher/index.ts:23
42
38
 
43
- ## Properties
39
+ ***
44
40
 
45
41
  ### \_deltaSize
46
42
 
@@ -48,13 +44,33 @@ src/utils/OverflowWatcher/index.ts:25
48
44
 
49
45
  #### Source
50
46
 
47
+ src/utils/OverflowWatcher/index.ts:20
48
+
49
+ ***
50
+
51
+ ### \_hiddenItemsProps
52
+
53
+ > `private` **\_hiddenItemsProps**: `Map`\<`Element`, `SizeProps`\>
54
+
55
+ #### Source
56
+
57
+ src/utils/OverflowWatcher/index.ts:18
58
+
59
+ ***
60
+
61
+ ### \_lastContainerInstance
62
+
63
+ > `private` **\_lastContainerInstance**: `undefined` \| `HTMLElement` = `undefined`
64
+
65
+ #### Source
66
+
51
67
  src/utils/OverflowWatcher/index.ts:15
52
68
 
53
69
  ***
54
70
 
55
- ### \_hiddenItems
71
+ ### \_lastContainerSize
56
72
 
57
- > `private` **\_hiddenItems**: `Element`[] = `[]`
73
+ > `private` **\_lastContainerSize**: `undefined` \| `number` = `undefined`
58
74
 
59
75
  #### Source
60
76
 
@@ -62,13 +78,23 @@ src/utils/OverflowWatcher/index.ts:14
62
78
 
63
79
  ***
64
80
 
65
- ### \_lastContentRect
81
+ ### \_notOverFlow
82
+
83
+ > `private` **\_notOverFlow**: `string`[] = `[]`
84
+
85
+ #### Source
86
+
87
+ src/utils/OverflowWatcher/index.ts:21
88
+
89
+ ***
90
+
91
+ ### \_notOverFlowPros
66
92
 
67
- > `private` **\_lastContentRect**: `undefined` \| `DOMRectReadOnly` = `undefined`
93
+ > `private` **\_notOverFlowPros**: `Map`\<`string`, `SizeProps`\>
68
94
 
69
95
  #### Source
70
96
 
71
- src/utils/OverflowWatcher/index.ts:11
97
+ src/utils/OverflowWatcher/index.ts:19
72
98
 
73
99
  ***
74
100
 
@@ -78,7 +104,7 @@ src/utils/OverflowWatcher/index.ts:11
78
104
 
79
105
  #### Source
80
106
 
81
- src/utils/OverflowWatcher/index.ts:9
107
+ src/utils/OverflowWatcher/index.ts:12
82
108
 
83
109
  ***
84
110
 
@@ -88,7 +114,7 @@ src/utils/OverflowWatcher/index.ts:9
88
114
 
89
115
  #### Source
90
116
 
91
- src/utils/OverflowWatcher/index.ts:13
117
+ src/utils/OverflowWatcher/index.ts:17
92
118
 
93
119
  ***
94
120
 
@@ -98,7 +124,7 @@ src/utils/OverflowWatcher/index.ts:13
98
124
 
99
125
  #### Source
100
126
 
101
- src/utils/OverflowWatcher/index.ts:10
127
+ src/utils/OverflowWatcher/index.ts:13
102
128
 
103
129
  ***
104
130
 
@@ -108,10 +134,28 @@ src/utils/OverflowWatcher/index.ts:10
108
134
 
109
135
  #### Source
110
136
 
111
- src/utils/OverflowWatcher/index.ts:12
137
+ src/utils/OverflowWatcher/index.ts:16
112
138
 
113
139
  ## Methods
114
140
 
141
+ ### addNotOverFlowElement()
142
+
143
+ > **addNotOverFlowElement**(`elementId`): `void`
144
+
145
+ #### Parameters
146
+
147
+ • **elementId**: `string`
148
+
149
+ #### Returns
150
+
151
+ `void`
152
+
153
+ #### Source
154
+
155
+ src/utils/OverflowWatcher/index.ts:52
156
+
157
+ ***
158
+
115
159
  ### calcChildrenSize()
116
160
 
117
161
  > `private` **calcChildrenSize**(`children`): `number`
@@ -126,13 +170,13 @@ src/utils/OverflowWatcher/index.ts:12
126
170
 
127
171
  #### Source
128
172
 
129
- src/utils/OverflowWatcher/index.ts:126
173
+ src/utils/OverflowWatcher/index.ts:205
130
174
 
131
175
  ***
132
176
 
133
- ### calcMarginSize()
177
+ ### calcElementSize()
134
178
 
135
- > `private` **calcMarginSize**(`el`): `number`
179
+ > `private` **calcElementSize**(`el`): `number`
136
180
 
137
181
  #### Parameters
138
182
 
@@ -144,7 +188,93 @@ src/utils/OverflowWatcher/index.ts:126
144
188
 
145
189
  #### Source
146
190
 
147
- src/utils/OverflowWatcher/index.ts:141
191
+ src/utils/OverflowWatcher/index.ts:212
192
+
193
+ ***
194
+
195
+ ### calculateVariation()
196
+
197
+ > `private` **calculateVariation**(`elementIdsToCalculate`): `number`
198
+
199
+ #### Parameters
200
+
201
+ • **elementIdsToCalculate**: `string`[]
202
+
203
+ #### Returns
204
+
205
+ `number`
206
+
207
+ #### Source
208
+
209
+ src/utils/OverflowWatcher/index.ts:177
210
+
211
+ ***
212
+
213
+ ### canNotOverFlowNotIncludedIds()
214
+
215
+ > `private` **canNotOverFlowNotIncludedIds**(`elements`): `string`[]
216
+
217
+ #### Parameters
218
+
219
+ • **elements**: `Element`[]
220
+
221
+ #### Returns
222
+
223
+ `string`[]
224
+
225
+ #### Source
226
+
227
+ src/utils/OverflowWatcher/index.ts:187
228
+
229
+ ***
230
+
231
+ ### canNotRegisterNotOverFlow()
232
+
233
+ > `private` **canNotRegisterNotOverFlow**(`id`): `boolean`
234
+
235
+ #### Parameters
236
+
237
+ • **id**: `string`
238
+
239
+ #### Returns
240
+
241
+ `boolean`
242
+
243
+ #### Source
244
+
245
+ src/utils/OverflowWatcher/index.ts:96
246
+
247
+ ***
248
+
249
+ ### canOverFlowElement()
250
+
251
+ > `private` **canOverFlowElement**(`element`): `boolean`
252
+
253
+ #### Parameters
254
+
255
+ • **element**: `Element`
256
+
257
+ #### Returns
258
+
259
+ `boolean`
260
+
261
+ #### Source
262
+
263
+ src/utils/OverflowWatcher/index.ts:157
264
+
265
+ ***
266
+
267
+ ### clearOverFlow()
268
+
269
+ > `private` **clearOverFlow**(): `void`
270
+
271
+ #### Returns
272
+
273
+ `void`
274
+
275
+ #### Source
276
+
277
+ src/utils/OverflowWatcher/index.ts:126
148
278
 
149
279
  ***
150
280
 
@@ -158,13 +288,53 @@ src/utils/OverflowWatcher/index.ts:141
158
288
 
159
289
  #### Source
160
290
 
161
- src/utils/OverflowWatcher/index.ts:37
291
+ src/utils/OverflowWatcher/index.ts:58
292
+
293
+ ***
294
+
295
+ ### exceedsAvaliableSize()
296
+
297
+ > `private` **exceedsAvaliableSize**(`sumElementsSize`, `elements`, `avaliableSize`): `boolean`
298
+
299
+ #### Parameters
300
+
301
+ • **sumElementsSize**: `number`
302
+
303
+ • **elements**: `Element`[]
304
+
305
+ • **avaliableSize**: `number`
306
+
307
+ #### Returns
308
+
309
+ `boolean`
310
+
311
+ #### Source
312
+
313
+ src/utils/OverflowWatcher/index.ts:166
314
+
315
+ ***
316
+
317
+ ### forceUpdate()
318
+
319
+ > **forceUpdate**(): `void`
320
+
321
+ #### Returns
322
+
323
+ `void`
324
+
325
+ #### Source
326
+
327
+ src/utils/OverflowWatcher/index.ts:62
162
328
 
163
329
  ***
164
330
 
165
- ### getPropSizeByDirection()
331
+ ### getDataElementId()
332
+
333
+ > `private` **getDataElementId**(`element`): `string`
334
+
335
+ #### Parameters
166
336
 
167
- > `private` **getPropSizeByDirection**(): `string`
337
+ **element**: `Element`
168
338
 
169
339
  #### Returns
170
340
 
@@ -172,7 +342,25 @@ src/utils/OverflowWatcher/index.ts:37
172
342
 
173
343
  #### Source
174
344
 
175
- src/utils/OverflowWatcher/index.ts:65
345
+ src/utils/OverflowWatcher/index.ts:162
346
+
347
+ ***
348
+
349
+ ### getElementSizeProps()
350
+
351
+ > `private` **getElementSizeProps**(`element`): `SizeProps`
352
+
353
+ #### Parameters
354
+
355
+ • **element**: `Element`
356
+
357
+ #### Returns
358
+
359
+ `SizeProps`
360
+
361
+ #### Source
362
+
363
+ src/utils/OverflowWatcher/index.ts:197
176
364
 
177
365
  ***
178
366
 
@@ -190,17 +378,17 @@ src/utils/OverflowWatcher/index.ts:65
190
378
 
191
379
  #### Source
192
380
 
193
- src/utils/OverflowWatcher/index.ts:41
381
+ src/utils/OverflowWatcher/index.ts:68
194
382
 
195
383
  ***
196
384
 
197
- ### isChangedSize()
385
+ ### hasChangedSize()
198
386
 
199
- > `private` **isChangedSize**(`newContentRect`): `boolean`
387
+ > `private` **hasChangedSize**(`elementSize`): `boolean`
200
388
 
201
389
  #### Parameters
202
390
 
203
- • **newContentRect**: `DOMRectReadOnly`
391
+ • **elementSize**: `number`
204
392
 
205
393
  #### Returns
206
394
 
@@ -208,7 +396,45 @@ src/utils/OverflowWatcher/index.ts:41
208
396
 
209
397
  #### Source
210
398
 
211
- src/utils/OverflowWatcher/index.ts:57
399
+ src/utils/OverflowWatcher/index.ts:100
400
+
401
+ ***
402
+
403
+ ### isElementOverFlowing()
404
+
405
+ > `private` **isElementOverFlowing**(`elementsThatFit`, `element`): `boolean`
406
+
407
+ #### Parameters
408
+
409
+ • **elementsThatFit**: `Element`[]
410
+
411
+ • **element**: `Element`
412
+
413
+ #### Returns
414
+
415
+ `boolean`
416
+
417
+ #### Source
418
+
419
+ src/utils/OverflowWatcher/index.ts:153
420
+
421
+ ***
422
+
423
+ ### isOverFlowed()
424
+
425
+ > `private` **isOverFlowed**(`el`): `boolean`
426
+
427
+ #### Parameters
428
+
429
+ • **el**: `Element`
430
+
431
+ #### Returns
432
+
433
+ `boolean`
434
+
435
+ #### Source
436
+
437
+ src/utils/OverflowWatcher/index.ts:226
212
438
 
213
439
  ***
214
440
 
@@ -228,19 +454,19 @@ src/utils/OverflowWatcher/index.ts:57
228
454
 
229
455
  #### Source
230
456
 
231
- src/utils/OverflowWatcher/index.ts:73
457
+ src/utils/OverflowWatcher/index.ts:112
232
458
 
233
459
  ***
234
460
 
235
461
  ### proccessElementsOverFlow()
236
462
 
237
- > `private` **proccessElementsOverFlow**(`children`, `diff`): `void`
463
+ > `private` **proccessElementsOverFlow**(`allElements`, `avaliableSize`): `void`
238
464
 
239
465
  #### Parameters
240
466
 
241
- • **children**: `Element`[]
467
+ • **allElements**: `Element`[]
242
468
 
243
- • **diff**: `number`
469
+ • **avaliableSize**: `number`
244
470
 
245
471
  #### Returns
246
472
 
@@ -248,17 +474,55 @@ src/utils/OverflowWatcher/index.ts:73
248
474
 
249
475
  #### Source
250
476
 
251
- src/utils/OverflowWatcher/index.ts:103
477
+ src/utils/OverflowWatcher/index.ts:131
252
478
 
253
479
  ***
254
480
 
255
- ### proccessElementsWithoutOverFlow()
481
+ ### registerElementSize()
256
482
 
257
- > `private` **proccessElementsWithoutOverFlow**(`diff`): `void`
483
+ > `private` **registerElementSize**(`element`): `void`
258
484
 
259
485
  #### Parameters
260
486
 
261
- • **diff**: `number`
487
+ • **element**: `Element`
488
+
489
+ #### Returns
490
+
491
+ `void`
492
+
493
+ #### Source
494
+
495
+ src/utils/OverflowWatcher/index.ts:192
496
+
497
+ ***
498
+
499
+ ### registerNotOverflowProps()
500
+
501
+ > `private` **registerNotOverflowProps**(`children`): `void`
502
+
503
+ #### Parameters
504
+
505
+ • **children**: `Element`[]
506
+
507
+ #### Returns
508
+
509
+ `void`
510
+
511
+ #### Source
512
+
513
+ src/utils/OverflowWatcher/index.ts:88
514
+
515
+ ***
516
+
517
+ ### updateOverFlowedItems()
518
+
519
+ > `private` **updateOverFlowedItems**(`container`, `containerSize`): `void`
520
+
521
+ #### Parameters
522
+
523
+ • **container**: `HTMLElement`
524
+
525
+ • **containerSize**: `number`
262
526
 
263
527
  #### Returns
264
528
 
@@ -266,4 +530,4 @@ src/utils/OverflowWatcher/index.ts:103
266
530
 
267
531
  #### Source
268
532
 
269
- src/utils/OverflowWatcher/index.ts:91
533
+ src/utils/OverflowWatcher/index.ts:80
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1914
33
+ src/dataunit/DataUnit.ts:1952
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1914
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:1908
43
+ src/dataunit/DataUnit.ts:1946
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1908
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1910
53
+ src/dataunit/DataUnit.ts:1948
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1910
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1911
63
+ src/dataunit/DataUnit.ts:1949
64
64
 
65
65
  ***
66
66
 
@@ -70,7 +70,7 @@ src/dataunit/DataUnit.ts:1911
70
70
 
71
71
  #### Source
72
72
 
73
- src/dataunit/DataUnit.ts:1909
73
+ src/dataunit/DataUnit.ts:1947
74
74
 
75
75
  ***
76
76
 
@@ -80,7 +80,7 @@ src/dataunit/DataUnit.ts:1909
80
80
 
81
81
  #### Source
82
82
 
83
- src/dataunit/DataUnit.ts:1912
83
+ src/dataunit/DataUnit.ts:1950
84
84
 
85
85
  ## Accessors
86
86
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:1912
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:1939
97
+ src/dataunit/DataUnit.ts:1977
98
98
 
99
99
  ***
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:1939
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:1929
111
+ src/dataunit/DataUnit.ts:1967
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:1929
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:1922
125
+ src/dataunit/DataUnit.ts:1960
126
126
 
127
127
  ## Methods
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:1922
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:1946
139
+ src/dataunit/DataUnit.ts:1984
140
140
 
141
141
  ***
142
142
 
@@ -150,4 +150,4 @@ src/dataunit/DataUnit.ts:1946
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:1950
153
+ src/dataunit/DataUnit.ts:1988