@sankhyalabs/core-docs 0.0.0-feat-dev-23220.1 → 0.0.0-feat-dev-KB-32496-2.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 (5) hide show
  1. package/classes/OverFlowElementWatcher.md +259 -0
  2. package/enumerations/OverFlowDirection.md +27 -0
  3. package/globals.md +6 -0
  4. package/package.json +1 -1
  5. package/type-aliases/OnOverFlowCallBack.md +21 -0
package/classes/OverFlowElementWatcher.md ADDED
@@ -0,0 +1,259 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OverFlowElementWatcher
6
+
7
+ # Class: OverFlowElementWatcher
8
+
9
+ ## Constructors
10
+
11
+ ### new OverFlowElementWatcher()
12
+
13
+ > **new OverFlowElementWatcher**(`element`, `callback`, `overFlowDirection`, `deltaSize`): [`OverFlowElementWatcher`](OverFlowElementWatcher.md)
14
+
15
+ #### Parameters
16
+
17
+ • **element**: `HTMLElement`
18
+
19
+ • **callback**: [`OnOverFlowCallBack`](../type-aliases/OnOverFlowCallBack.md)
20
+
21
+ • **overFlowDirection**: [`OverFlowDirection`](../enumerations/OverFlowDirection.md)= `OverFlowDirection.HORIZONTAL`
22
+
23
+ • **deltaSize**: `number`= `10`
24
+
25
+ #### Returns
26
+
27
+ [`OverFlowElementWatcher`](OverFlowElementWatcher.md)
28
+
29
+ #### Source
30
+
31
+ src/utils/OverFlowElementWatcher.ts:12
32
+
33
+ ## Properties
34
+
35
+ ### \_deltaSize
36
+
37
+ > `private` **\_deltaSize**: `number`
38
+
39
+ #### Source
40
+
41
+ src/utils/OverFlowElementWatcher.ts:10
42
+
43
+ ***
44
+
45
+ ### \_hiddenItems
46
+
47
+ > `private` **\_hiddenItems**: `Element`[] = `[]`
48
+
49
+ #### Source
50
+
51
+ src/utils/OverFlowElementWatcher.ts:9
52
+
53
+ ***
54
+
55
+ ### \_lastContentRect
56
+
57
+ > `private` **\_lastContentRect**: `undefined` \| `DOMRectReadOnly` = `undefined`
58
+
59
+ #### Source
60
+
61
+ src/utils/OverFlowElementWatcher.ts:6
62
+
63
+ ***
64
+
65
+ ### \_onResize
66
+
67
+ > `private` **\_onResize**: [`OnOverFlowCallBack`](../type-aliases/OnOverFlowCallBack.md)
68
+
69
+ #### Source
70
+
71
+ src/utils/OverFlowElementWatcher.ts:4
72
+
73
+ ***
74
+
75
+ ### \_propSize
76
+
77
+ > `private` **\_propSize**: `string`
78
+
79
+ #### Source
80
+
81
+ src/utils/OverFlowElementWatcher.ts:8
82
+
83
+ ***
84
+
85
+ ### \_resizeObserver
86
+
87
+ > `private` **\_resizeObserver**: `ResizeObserver`
88
+
89
+ #### Source
90
+
91
+ src/utils/OverFlowElementWatcher.ts:5
92
+
93
+ ***
94
+
95
+ ### \_scrollDirection
96
+
97
+ > `private` **\_scrollDirection**: [`OverFlowDirection`](../enumerations/OverFlowDirection.md) = `OverFlowDirection.HORIZONTAL`
98
+
99
+ #### Source
100
+
101
+ src/utils/OverFlowElementWatcher.ts:7
102
+
103
+ ## Methods
104
+
105
+ ### calcChildrenSize()
106
+
107
+ > `private` **calcChildrenSize**(`children`): `number`
108
+
109
+ #### Parameters
110
+
111
+ • **children**: `Element`[]
112
+
113
+ #### Returns
114
+
115
+ `number`
116
+
117
+ #### Source
118
+
119
+ src/utils/OverFlowElementWatcher.ts:112
120
+
121
+ ***
122
+
123
+ ### calcMarginSize()
124
+
125
+ > `private` **calcMarginSize**(`el`): `number`
126
+
127
+ #### Parameters
128
+
129
+ • **el**: `Element`
130
+
131
+ #### Returns
132
+
133
+ `number`
134
+
135
+ #### Source
136
+
137
+ src/utils/OverFlowElementWatcher.ts:127
138
+
139
+ ***
140
+
141
+ ### destroy()
142
+
143
+ > **destroy**(): `void`
144
+
145
+ #### Returns
146
+
147
+ `void`
148
+
149
+ #### Source
150
+
151
+ src/utils/OverFlowElementWatcher.ts:23
152
+
153
+ ***
154
+
155
+ ### getPropSizeByDirection()
156
+
157
+ > `private` **getPropSizeByDirection**(): `string`
158
+
159
+ #### Returns
160
+
161
+ `string`
162
+
163
+ #### Source
164
+
165
+ src/utils/OverFlowElementWatcher.ts:51
166
+
167
+ ***
168
+
169
+ ### handleResize()
170
+
171
+ > `private` **handleResize**(`entries`): `void`
172
+
173
+ #### Parameters
174
+
175
+ • **entries**: `ResizeObserverEntry`[]
176
+
177
+ #### Returns
178
+
179
+ `void`
180
+
181
+ #### Source
182
+
183
+ src/utils/OverFlowElementWatcher.ts:27
184
+
185
+ ***
186
+
187
+ ### isChangedSize()
188
+
189
+ > `private` **isChangedSize**(`newContentRect`): `boolean`
190
+
191
+ #### Parameters
192
+
193
+ • **newContentRect**: `DOMRectReadOnly`
194
+
195
+ #### Returns
196
+
197
+ `boolean`
198
+
199
+ #### Source
200
+
201
+ src/utils/OverFlowElementWatcher.ts:43
202
+
203
+ ***
204
+
205
+ ### proccessElements()
206
+
207
+ > `private` **proccessElements**(`elementSize`, `children`): `void`
208
+
209
+ #### Parameters
210
+
211
+ • **elementSize**: `number`
212
+
213
+ • **children**: `Element`[]
214
+
215
+ #### Returns
216
+
217
+ `void`
218
+
219
+ #### Source
220
+
221
+ src/utils/OverFlowElementWatcher.ts:59
222
+
223
+ ***
224
+
225
+ ### proccessElementsOverFlow()
226
+
227
+ > `private` **proccessElementsOverFlow**(`children`, `diff`): `void`
228
+
229
+ #### Parameters
230
+
231
+ • **children**: `Element`[]
232
+
233
+ • **diff**: `number`
234
+
235
+ #### Returns
236
+
237
+ `void`
238
+
239
+ #### Source
240
+
241
+ src/utils/OverFlowElementWatcher.ts:89
242
+
243
+ ***
244
+
245
+ ### proccessElementsWithoutOverFlow()
246
+
247
+ > `private` **proccessElementsWithoutOverFlow**(`diff`): `void`
248
+
249
+ #### Parameters
250
+
251
+ • **diff**: `number`
252
+
253
+ #### Returns
254
+
255
+ `void`
256
+
257
+ #### Source
258
+
259
+ src/utils/OverFlowElementWatcher.ts:77
package/enumerations/OverFlowDirection.md ADDED
@@ -0,0 +1,27 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OverFlowDirection
6
+
7
+ # Enumeration: OverFlowDirection
8
+
9
+ ## Enumeration Members
10
+
11
+ ### HORIZONTAL
12
+
13
+ > **HORIZONTAL**: `1`
14
+
15
+ #### Source
16
+
17
+ src/utils/OverFlowElementWatcher.ts:143
18
+
19
+ ***
20
+
21
+ ### VERTICAL
22
+
23
+ > **VERTICAL**: `0`
24
+
25
+ #### Source
26
+
27
+ src/utils/OverFlowElementWatcher.ts:142
package/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
+ - [OverFlowElementWatcher](classes/OverFlowElementWatcher.md)
45
47
  - [PromiseSync](classes/PromiseSync.md)
46
48
  - [ReadyUtil](classes/ReadyUtil.md)
47
49
  - [RequestMetadata](classes/RequestMetadata.md)
@@ -80,6 +82,10 @@
80
82
  - [UnitMetadata](interfaces/UnitMetadata.md)
81
83
  - [WaitingChange](interfaces/WaitingChange.md)
82
84
 
85
+ ## Type Aliases
86
+
87
+ - [OnOverFlowCallBack](type-aliases/OnOverFlowCallBack.md)
88
+
83
89
  ## Functions
84
90
 
85
91
  - [defaultDataLoader](functions/defaultDataLoader.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "0.0.0-feat-dev-23220.1",
3
+ "version": "0.0.0-feat-dev-KB-32496-2.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/type-aliases/OnOverFlowCallBack.md ADDED
@@ -0,0 +1,21 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OnOverFlowCallBack
6
+
7
+ # Type alias: OnOverFlowCallBack()
8
+
9
+ > **OnOverFlowCallBack**: (`elementsOverFlow`) => `void`
10
+
11
+ ## Parameters
12
+
13
+ • **elementsOverFlow**: `Element`[]
14
+
15
+ ## Returns
16
+
17
+ `void`
18
+
19
+ ## Source
20
+
21
+ src/utils/OverFlowElementWatcher.ts:139