@sankhyalabs/core-docs 5.20.0-dev.9 → 5.20.0-rc.2

Sign up to get free protection for your applications and to get access to all the features.
@@ -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: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
@@ -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/globals.md CHANGED
@@ -71,6 +71,7 @@
71
71
  - [IRepositoryIndex](interfaces/IRepositoryIndex.md)
72
72
  - [LoadDataRequest](interfaces/LoadDataRequest.md)
73
73
  - [LoadDataResponse](interfaces/LoadDataResponse.md)
74
+ - [OverFlowWatcherParams](interfaces/OverFlowWatcherParams.md)
74
75
  - [PageRequest](interfaces/PageRequest.md)
75
76
  - [PaginationInfo](interfaces/PaginationInfo.md)
76
77
  - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
@@ -86,6 +87,10 @@
86
87
 
87
88
  - [OnOverflowCallBack](type-aliases/OnOverflowCallBack.md)
88
89
 
90
+ ## Variables
91
+
92
+ - [OVERFLOWED\_CLASS\_NAME](variables/OVERFLOWED_CLASS_NAME.md)
93
+
89
94
  ## Functions
90
95
 
91
96
  - [defaultDataLoader](functions/defaultDataLoader.md)
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1778
25
+ src/dataunit/DataUnit.ts:1777