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