@sankhyalabs/core 5.20.0-dev.8 → 5.20.0-rc.1

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.
Files changed (51) hide show
  1. package/.docs/classes/Change.md +11 -11
  2. package/.docs/classes/DataUnit.md +75 -75
  3. package/.docs/classes/OverflowWatcher.md +533 -0
  4. package/.docs/classes/SelectionInfo.md +11 -11
  5. package/.docs/enumerations/ChangeOperation.md +4 -4
  6. package/.docs/enumerations/OverflowDirection.md +29 -0
  7. package/.docs/enumerations/SelectionMode.md +2 -2
  8. package/.docs/globals.md +11 -0
  9. package/.docs/interfaces/DUActionInterceptor.md +1 -1
  10. package/.docs/interfaces/OverFlowWatcherParams.md +67 -0
  11. package/.docs/interfaces/PageRequest.md +3 -3
  12. package/.docs/interfaces/QuickFilter.md +3 -3
  13. package/.docs/interfaces/Record.md +4 -4
  14. package/.docs/interfaces/SavedRecord.md +5 -5
  15. package/.docs/interfaces/WaitingChange.md +3 -3
  16. package/.docs/type-aliases/OnOverflowCallBack.md +25 -0
  17. package/.docs/variables/OVERFLOWED_CLASS_NAME.md +13 -0
  18. package/dist/dataunit/DataUnit.d.ts +1 -1
  19. package/dist/dataunit/DataUnit.js +2 -2
  20. package/dist/dataunit/DataUnit.js.map +1 -1
  21. package/dist/dataunit/formatting/PrettyFormatter.js +6 -4
  22. package/dist/dataunit/formatting/PrettyFormatter.js.map +1 -1
  23. package/dist/index.d.ts +2 -1
  24. package/dist/index.js +2 -1
  25. package/dist/index.js.map +1 -1
  26. package/dist/utils/ElementUtils.d.ts +2 -0
  27. package/dist/utils/ElementUtils.js +9 -0
  28. package/dist/utils/ElementUtils.js.map +1 -0
  29. package/dist/utils/OverflowWatcher/index.d.ts +59 -0
  30. package/dist/utils/OverflowWatcher/index.js +188 -0
  31. package/dist/utils/OverflowWatcher/index.js.map +1 -0
  32. package/dist/utils/OverflowWatcher/types/overflow-callback.d.ts +6 -0
  33. package/dist/utils/OverflowWatcher/types/overflow-callback.js +2 -0
  34. package/dist/utils/OverflowWatcher/types/overflow-callback.js.map +1 -0
  35. package/dist/utils/OverflowWatcher/types/overflow-direction.d.ts +7 -0
  36. package/dist/utils/OverflowWatcher/types/overflow-direction.js +9 -0
  37. package/dist/utils/OverflowWatcher/types/overflow-direction.js.map +1 -0
  38. package/jest.config.ts +2 -0
  39. package/package.json +2 -1
  40. package/reports/test-report.xml +125 -0
  41. package/setupTests.js +1 -0
  42. package/sonar-project.properties +6 -3
  43. package/src/dataunit/DataUnit.ts +3 -4
  44. package/src/dataunit/formatting/PrettyFormatter.ts +5 -4
  45. package/src/index.ts +6 -0
  46. package/src/utils/ElementUtils.ts +10 -0
  47. package/src/utils/OverflowWatcher/index.ts +243 -0
  48. package/src/utils/OverflowWatcher/types/overflow-callback.ts +6 -0
  49. package/src/utils/OverflowWatcher/types/overflow-direction.ts +7 -0
  50. package/test/util/ElementUtils.spec.ts +34 -0
  51. package/test/util/OverflowWatcher.spec.ts +152 -0
@@ -0,0 +1,533 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OverflowWatcher
6
+
7
+ # Class: OverflowWatcher
8
+
9
+ ## Constructors
10
+
11
+ ### new OverflowWatcher()
12
+
13
+ > **new OverflowWatcher**(`__namedParameters`): [`OverflowWatcher`](OverflowWatcher.md)
14
+
15
+ Cria uma instancia do OverflowWatcher
16
+
17
+ #### Parameters
18
+
19
+ • **\_\_namedParameters**: [`OverFlowWatcherParams`](../interfaces/OverFlowWatcherParams.md)
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
32
+
33
+ > `readonly` **DATA\_ELEMENT\_ID**: `"data-element-id"` = `'data-element-id'`
34
+
35
+ #### Source
36
+
37
+ src/utils/OverflowWatcher/index.ts:23
38
+
39
+ ***
40
+
41
+ ### \_deltaSize
42
+
43
+ > `private` **\_deltaSize**: `number`
44
+
45
+ #### Source
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
+
67
+ src/utils/OverflowWatcher/index.ts:15
68
+
69
+ ***
70
+
71
+ ### \_lastContainerSize
72
+
73
+ > `private` **\_lastContainerSize**: `undefined` \| `number` = `undefined`
74
+
75
+ #### Source
76
+
77
+ src/utils/OverflowWatcher/index.ts:14
78
+
79
+ ***
80
+
81
+ ### \_notOverFlow
82
+
83
+ > `private` **\_notOverFlow**: `string`[] = `[]`
84
+
85
+ #### Source
86
+
87
+ src/utils/OverflowWatcher/index.ts:21
88
+
89
+ ***
90
+
91
+ ### \_notOverFlowPros
92
+
93
+ > `private` **\_notOverFlowPros**: `Map`\<`string`, `SizeProps`\>
94
+
95
+ #### Source
96
+
97
+ src/utils/OverflowWatcher/index.ts:19
98
+
99
+ ***
100
+
101
+ ### \_onResize
102
+
103
+ > `private` **\_onResize**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
104
+
105
+ #### Source
106
+
107
+ src/utils/OverflowWatcher/index.ts:12
108
+
109
+ ***
110
+
111
+ ### \_propSize
112
+
113
+ > `private` **\_propSize**: `string`
114
+
115
+ #### Source
116
+
117
+ src/utils/OverflowWatcher/index.ts:17
118
+
119
+ ***
120
+
121
+ ### \_resizeObserver
122
+
123
+ > `private` **\_resizeObserver**: `ResizeObserver`
124
+
125
+ #### Source
126
+
127
+ src/utils/OverflowWatcher/index.ts:13
128
+
129
+ ***
130
+
131
+ ### \_scrollDirection
132
+
133
+ > `private` **\_scrollDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md) = `OverflowDirection.HORIZONTAL`
134
+
135
+ #### Source
136
+
137
+ src/utils/OverflowWatcher/index.ts:16
138
+
139
+ ## Methods
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
+
159
+ ### calcChildrenSize()
160
+
161
+ > `private` **calcChildrenSize**(`children`): `number`
162
+
163
+ #### Parameters
164
+
165
+ • **children**: `Element`[]
166
+
167
+ #### Returns
168
+
169
+ `number`
170
+
171
+ #### Source
172
+
173
+ src/utils/OverflowWatcher/index.ts:205
174
+
175
+ ***
176
+
177
+ ### calcElementSize()
178
+
179
+ > `private` **calcElementSize**(`el`): `number`
180
+
181
+ #### Parameters
182
+
183
+ • **el**: `Element`
184
+
185
+ #### Returns
186
+
187
+ `number`
188
+
189
+ #### Source
190
+
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
278
+
279
+ ***
280
+
281
+ ### destroy()
282
+
283
+ > **destroy**(): `void`
284
+
285
+ #### Returns
286
+
287
+ `void`
288
+
289
+ #### Source
290
+
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
328
+
329
+ ***
330
+
331
+ ### getDataElementId()
332
+
333
+ > `private` **getDataElementId**(`element`): `string`
334
+
335
+ #### Parameters
336
+
337
+ • **element**: `Element`
338
+
339
+ #### Returns
340
+
341
+ `string`
342
+
343
+ #### Source
344
+
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
364
+
365
+ ***
366
+
367
+ ### handleResize()
368
+
369
+ > `private` **handleResize**(`entries`): `void`
370
+
371
+ #### Parameters
372
+
373
+ • **entries**: `ResizeObserverEntry`[]
374
+
375
+ #### Returns
376
+
377
+ `void`
378
+
379
+ #### Source
380
+
381
+ src/utils/OverflowWatcher/index.ts:68
382
+
383
+ ***
384
+
385
+ ### hasChangedSize()
386
+
387
+ > `private` **hasChangedSize**(`elementSize`): `boolean`
388
+
389
+ #### Parameters
390
+
391
+ • **elementSize**: `number`
392
+
393
+ #### Returns
394
+
395
+ `boolean`
396
+
397
+ #### Source
398
+
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
438
+
439
+ ***
440
+
441
+ ### proccessElements()
442
+
443
+ > `private` **proccessElements**(`elementSize`, `children`): `void`
444
+
445
+ #### Parameters
446
+
447
+ • **elementSize**: `number`
448
+
449
+ • **children**: `Element`[]
450
+
451
+ #### Returns
452
+
453
+ `void`
454
+
455
+ #### Source
456
+
457
+ src/utils/OverflowWatcher/index.ts:112
458
+
459
+ ***
460
+
461
+ ### proccessElementsOverFlow()
462
+
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`
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`
526
+
527
+ #### Returns
528
+
529
+ `void`
530
+
531
+ #### Source
532
+
533
+ src/utils/OverflowWatcher/index.ts:80
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1915
33
+ src/dataunit/DataUnit.ts:1914
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1915
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:1909
43
+ src/dataunit/DataUnit.ts:1908
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1909
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1911
53
+ src/dataunit/DataUnit.ts:1910
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1911
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1912
63
+ src/dataunit/DataUnit.ts:1911
64
64
 
65
65
  ***
66
66
 
@@ -70,7 +70,7 @@ src/dataunit/DataUnit.ts:1912
70
70
 
71
71
  #### Source
72
72
 
73
- src/dataunit/DataUnit.ts:1910
73
+ src/dataunit/DataUnit.ts:1909
74
74
 
75
75
  ***
76
76
 
@@ -80,7 +80,7 @@ src/dataunit/DataUnit.ts:1910
80
80
 
81
81
  #### Source
82
82
 
83
- src/dataunit/DataUnit.ts:1913
83
+ src/dataunit/DataUnit.ts:1912
84
84
 
85
85
  ## Accessors
86
86
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:1913
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:1940
97
+ src/dataunit/DataUnit.ts:1939
98
98
 
99
99
  ***
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:1940
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:1930
111
+ src/dataunit/DataUnit.ts:1929
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:1930
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:1923
125
+ src/dataunit/DataUnit.ts:1922
126
126
 
127
127
  ## Methods
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:1923
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:1947
139
+ src/dataunit/DataUnit.ts:1946
140
140
 
141
141
  ***
142
142
 
@@ -150,4 +150,4 @@ src/dataunit/DataUnit.ts:1947
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:1951
153
+ src/dataunit/DataUnit.ts:1950
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1795
17
+ src/dataunit/DataUnit.ts:1794
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1795
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1797
27
+ src/dataunit/DataUnit.ts:1796
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1797
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1794
37
+ src/dataunit/DataUnit.ts:1793
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1794
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1796
47
+ src/dataunit/DataUnit.ts:1795
@@ -0,0 +1,29 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OverflowDirection
6
+
7
+ # Enumeration: OverflowDirection
8
+
9
+ Define em qual direção o overflow será observado
10
+
11
+ ## Enumeration Members
12
+
13
+ ### HORIZONTAL
14
+
15
+ > **HORIZONTAL**: `1`
16
+
17
+ #### Source
18
+
19
+ src/utils/OverflowWatcher/types/overflow-direction.ts:6
20
+
21
+ ***
22
+
23
+ ### VERTICAL
24
+
25
+ > **VERTICAL**: `0`
26
+
27
+ #### Source
28
+
29
+ src/utils/OverflowWatcher/types/overflow-direction.ts:5
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1903
17
+ src/dataunit/DataUnit.ts:1902
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1903
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1904
27
+ src/dataunit/DataUnit.ts:1903
package/.docs/globals.md CHANGED
@@ -14,6 +14,7 @@
14
14
  - [ChangeOperation](enumerations/ChangeOperation.md)
15
15
  - [DataType](enumerations/DataType.md)
16
16
  - [DependencyType](enumerations/DependencyType.md)
17
+ - [OverflowDirection](enumerations/OverflowDirection.md)
17
18
  - [SelectionMode](enumerations/SelectionMode.md)
18
19
  - [SortMode](enumerations/SortMode.md)
19
20
  - [UserInterface](enumerations/UserInterface.md)
@@ -42,6 +43,7 @@
42
43
  - [NumberUtils](classes/NumberUtils.md)
43
44
  - [ObjectUtils](classes/ObjectUtils.md)
44
45
  - [OnboardingUtils](classes/OnboardingUtils.md)
46
+ - [OverflowWatcher](classes/OverflowWatcher.md)
45
47
  - [PromiseSync](classes/PromiseSync.md)
46
48
  - [ReadyUtil](classes/ReadyUtil.md)
47
49
  - [RequestMetadata](classes/RequestMetadata.md)
@@ -69,6 +71,7 @@
69
71
  - [IRepositoryIndex](interfaces/IRepositoryIndex.md)
70
72
  - [LoadDataRequest](interfaces/LoadDataRequest.md)
71
73
  - [LoadDataResponse](interfaces/LoadDataResponse.md)
74
+ - [OverFlowWatcherParams](interfaces/OverFlowWatcherParams.md)
72
75
  - [PageRequest](interfaces/PageRequest.md)
73
76
  - [PaginationInfo](interfaces/PaginationInfo.md)
74
77
  - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
@@ -80,6 +83,14 @@
80
83
  - [UnitMetadata](interfaces/UnitMetadata.md)
81
84
  - [WaitingChange](interfaces/WaitingChange.md)
82
85
 
86
+ ## Type Aliases
87
+
88
+ - [OnOverflowCallBack](type-aliases/OnOverflowCallBack.md)
89
+
90
+ ## Variables
91
+
92
+ - [OVERFLOWED\_CLASS\_NAME](variables/OVERFLOWED_CLASS_NAME.md)
93
+
83
94
  ## Functions
84
95
 
85
96
  - [defaultDataLoader](functions/defaultDataLoader.md)