@sankhyalabs/core-docs 0.0.0-hotfix-rc-KB-47960.0 → 0.0.0-hotfix-ga-5468339.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,54 +76,6 @@ 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
-
127
79
  ### objectToString()
128
80
 
129
81
  > `static` **objectToString**(`data`): `string`
@@ -10,57 +10,41 @@
10
10
 
11
11
  ### new OverflowWatcher()
12
12
 
13
- > **new OverflowWatcher**(`__namedParameters`): [`OverflowWatcher`](OverflowWatcher.md)
13
+ > **new OverflowWatcher**(`element`, `callback`, `overFlowDirection`, `deltaSize`): [`OverflowWatcher`](OverflowWatcher.md)
14
14
 
15
15
  Cria uma instancia do OverflowWatcher
16
16
 
17
17
  #### Parameters
18
18
 
19
- **\_\_namedParameters**: [`OverFlowWatcherParams`](../interfaces/OverFlowWatcherParams.md)
19
+ **element**: `HTMLElement`
20
20
 
21
- #### Returns
22
-
23
- [`OverflowWatcher`](OverflowWatcher.md)
24
-
25
- #### Source
26
-
27
- src/utils/OverflowWatcher/index.ts:35
28
-
29
- ## Properties
30
-
31
- ### DATA\_ELEMENT\_ID
21
+ Elemento HTML que o overflow será observado.
32
22
 
33
- > `readonly` **DATA\_ELEMENT\_ID**: `"data-element-id"` = `'data-element-id'`
34
-
35
- #### Source
36
-
37
- src/utils/OverflowWatcher/index.ts:23
38
-
39
- ***
23
+ **callback**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
40
24
 
41
- ### \_deltaSize
25
+ Função que sera chamada quando ocorrer overflow no elemento.
42
26
 
43
- > `private` **\_deltaSize**: `number`
27
+ **overFlowDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md)= `OverflowDirection.HORIZONTAL`
44
28
 
45
- #### Source
29
+ Indica direção que o overflow será monitorado.
46
30
 
47
- src/utils/OverflowWatcher/index.ts:20
31
+ • **deltaSize**: `number`= `10`
48
32
 
49
- ***
33
+ Variação de tamanho que será considerada como overflow.
50
34
 
51
- ### \_hiddenItemsProps
35
+ #### Returns
52
36
 
53
- > `private` **\_hiddenItemsProps**: `Map`\<`Element`, `SizeProps`\>
37
+ [`OverflowWatcher`](OverflowWatcher.md)
54
38
 
55
39
  #### Source
56
40
 
57
- src/utils/OverflowWatcher/index.ts:18
41
+ src/utils/OverflowWatcher/index.ts:25
58
42
 
59
- ***
43
+ ## Properties
60
44
 
61
- ### \_lastContainerInstance
45
+ ### \_deltaSize
62
46
 
63
- > `private` **\_lastContainerInstance**: `undefined` \| `HTMLElement` = `undefined`
47
+ > `private` **\_deltaSize**: `number`
64
48
 
65
49
  #### Source
66
50
 
@@ -68,9 +52,9 @@ src/utils/OverflowWatcher/index.ts:15
68
52
 
69
53
  ***
70
54
 
71
- ### \_lastContainerSize
55
+ ### \_hiddenItems
72
56
 
73
- > `private` **\_lastContainerSize**: `undefined` \| `number` = `undefined`
57
+ > `private` **\_hiddenItems**: `Element`[] = `[]`
74
58
 
75
59
  #### Source
76
60
 
@@ -78,23 +62,13 @@ src/utils/OverflowWatcher/index.ts:14
78
62
 
79
63
  ***
80
64
 
81
- ### \_notOverFlow
82
-
83
- > `private` **\_notOverFlow**: `string`[] = `[]`
84
-
85
- #### Source
86
-
87
- src/utils/OverflowWatcher/index.ts:21
88
-
89
- ***
90
-
91
- ### \_notOverFlowPros
65
+ ### \_lastContentRect
92
66
 
93
- > `private` **\_notOverFlowPros**: `Map`\<`string`, `SizeProps`\>
67
+ > `private` **\_lastContentRect**: `undefined` \| `DOMRectReadOnly` = `undefined`
94
68
 
95
69
  #### Source
96
70
 
97
- src/utils/OverflowWatcher/index.ts:19
71
+ src/utils/OverflowWatcher/index.ts:11
98
72
 
99
73
  ***
100
74
 
@@ -104,7 +78,7 @@ src/utils/OverflowWatcher/index.ts:19
104
78
 
105
79
  #### Source
106
80
 
107
- src/utils/OverflowWatcher/index.ts:12
81
+ src/utils/OverflowWatcher/index.ts:9
108
82
 
109
83
  ***
110
84
 
@@ -114,7 +88,7 @@ src/utils/OverflowWatcher/index.ts:12
114
88
 
115
89
  #### Source
116
90
 
117
- src/utils/OverflowWatcher/index.ts:17
91
+ src/utils/OverflowWatcher/index.ts:13
118
92
 
119
93
  ***
120
94
 
@@ -124,7 +98,7 @@ src/utils/OverflowWatcher/index.ts:17
124
98
 
125
99
  #### Source
126
100
 
127
- src/utils/OverflowWatcher/index.ts:13
101
+ src/utils/OverflowWatcher/index.ts:10
128
102
 
129
103
  ***
130
104
 
@@ -134,28 +108,10 @@ src/utils/OverflowWatcher/index.ts:13
134
108
 
135
109
  #### Source
136
110
 
137
- src/utils/OverflowWatcher/index.ts:16
111
+ src/utils/OverflowWatcher/index.ts:12
138
112
 
139
113
  ## Methods
140
114
 
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
-
159
115
  ### calcChildrenSize()
160
116
 
161
117
  > `private` **calcChildrenSize**(`children`): `number`
@@ -170,13 +126,13 @@ src/utils/OverflowWatcher/index.ts:52
170
126
 
171
127
  #### Source
172
128
 
173
- src/utils/OverflowWatcher/index.ts:205
129
+ src/utils/OverflowWatcher/index.ts:126
174
130
 
175
131
  ***
176
132
 
177
- ### calcElementSize()
133
+ ### calcMarginSize()
178
134
 
179
- > `private` **calcElementSize**(`el`): `number`
135
+ > `private` **calcMarginSize**(`el`): `number`
180
136
 
181
137
  #### Parameters
182
138
 
@@ -188,93 +144,7 @@ src/utils/OverflowWatcher/index.ts:205
188
144
 
189
145
  #### Source
190
146
 
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
147
+ src/utils/OverflowWatcher/index.ts:141
278
148
 
279
149
  ***
280
150
 
@@ -288,53 +158,13 @@ src/utils/OverflowWatcher/index.ts:126
288
158
 
289
159
  #### Source
290
160
 
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
161
+ src/utils/OverflowWatcher/index.ts:37
328
162
 
329
163
  ***
330
164
 
331
- ### getDataElementId()
332
-
333
- > `private` **getDataElementId**(`element`): `string`
334
-
335
- #### Parameters
165
+ ### getPropSizeByDirection()
336
166
 
337
- **element**: `Element`
167
+ > `private` **getPropSizeByDirection**(): `string`
338
168
 
339
169
  #### Returns
340
170
 
@@ -342,25 +172,7 @@ src/utils/OverflowWatcher/index.ts:62
342
172
 
343
173
  #### Source
344
174
 
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
175
+ src/utils/OverflowWatcher/index.ts:65
364
176
 
365
177
  ***
366
178
 
@@ -378,17 +190,17 @@ src/utils/OverflowWatcher/index.ts:197
378
190
 
379
191
  #### Source
380
192
 
381
- src/utils/OverflowWatcher/index.ts:68
193
+ src/utils/OverflowWatcher/index.ts:41
382
194
 
383
195
  ***
384
196
 
385
- ### hasChangedSize()
197
+ ### isChangedSize()
386
198
 
387
- > `private` **hasChangedSize**(`elementSize`): `boolean`
199
+ > `private` **isChangedSize**(`newContentRect`): `boolean`
388
200
 
389
201
  #### Parameters
390
202
 
391
- • **elementSize**: `number`
203
+ • **newContentRect**: `DOMRectReadOnly`
392
204
 
393
205
  #### Returns
394
206
 
@@ -396,45 +208,7 @@ src/utils/OverflowWatcher/index.ts:68
396
208
 
397
209
  #### Source
398
210
 
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
211
+ src/utils/OverflowWatcher/index.ts:57
438
212
 
439
213
  ***
440
214
 
@@ -454,75 +228,37 @@ src/utils/OverflowWatcher/index.ts:226
454
228
 
455
229
  #### Source
456
230
 
457
- src/utils/OverflowWatcher/index.ts:112
231
+ src/utils/OverflowWatcher/index.ts:73
458
232
 
459
233
  ***
460
234
 
461
235
  ### proccessElementsOverFlow()
462
236
 
463
- > `private` **proccessElementsOverFlow**(`allElements`, `avaliableSize`): `void`
464
-
465
- #### Parameters
466
-
467
- • **allElements**: `Element`[]
468
-
469
- • **avaliableSize**: `number`
470
-
471
- #### Returns
472
-
473
- `void`
474
-
475
- #### Source
476
-
477
- src/utils/OverflowWatcher/index.ts:131
478
-
479
- ***
480
-
481
- ### registerElementSize()
482
-
483
- > `private` **registerElementSize**(`element`): `void`
484
-
485
- #### Parameters
486
-
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`
237
+ > `private` **proccessElementsOverFlow**(`children`, `diff`): `void`
502
238
 
503
239
  #### Parameters
504
240
 
505
241
  • **children**: `Element`[]
506
242
 
243
+ • **diff**: `number`
244
+
507
245
  #### Returns
508
246
 
509
247
  `void`
510
248
 
511
249
  #### Source
512
250
 
513
- src/utils/OverflowWatcher/index.ts:88
251
+ src/utils/OverflowWatcher/index.ts:103
514
252
 
515
253
  ***
516
254
 
517
- ### updateOverFlowedItems()
255
+ ### proccessElementsWithoutOverFlow()
518
256
 
519
- > `private` **updateOverFlowedItems**(`container`, `containerSize`): `void`
257
+ > `private` **proccessElementsWithoutOverFlow**(`diff`): `void`
520
258
 
521
259
  #### Parameters
522
260
 
523
- • **container**: `HTMLElement`
524
-
525
- • **containerSize**: `number`
261
+ • **diff**: `number`
526
262
 
527
263
  #### Returns
528
264
 
@@ -530,4 +266,4 @@ src/utils/OverflowWatcher/index.ts:88
530
266
 
531
267
  #### Source
532
268
 
533
- src/utils/OverflowWatcher/index.ts:80
269
+ src/utils/OverflowWatcher/index.ts:91
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1950
33
+ src/dataunit/DataUnit.ts:1932
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1950
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:1944
43
+ src/dataunit/DataUnit.ts:1926
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1944
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1946
53
+ src/dataunit/DataUnit.ts:1928
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1946
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1947
63
+ src/dataunit/DataUnit.ts:1929
64
64
 
65
65
  ***
66
66
 
@@ -70,7 +70,7 @@ src/dataunit/DataUnit.ts:1947
70
70
 
71
71
  #### Source
72
72
 
73
- src/dataunit/DataUnit.ts:1945
73
+ src/dataunit/DataUnit.ts:1927
74
74
 
75
75
  ***
76
76
 
@@ -80,7 +80,7 @@ src/dataunit/DataUnit.ts:1945
80
80
 
81
81
  #### Source
82
82
 
83
- src/dataunit/DataUnit.ts:1948
83
+ src/dataunit/DataUnit.ts:1930
84
84
 
85
85
  ## Accessors
86
86
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:1948
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:1975
97
+ src/dataunit/DataUnit.ts:1957
98
98
 
99
99
  ***
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:1975
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:1965
111
+ src/dataunit/DataUnit.ts:1947
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:1965
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:1958
125
+ src/dataunit/DataUnit.ts:1940
126
126
 
127
127
  ## Methods
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:1958
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:1982
139
+ src/dataunit/DataUnit.ts:1964
140
140
 
141
141
  ***
142
142
 
@@ -150,4 +150,4 @@ src/dataunit/DataUnit.ts:1982
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:1986
153
+ src/dataunit/DataUnit.ts:1968