@sankhyalabs/core-docs 0.0.0-feat-dev-KB-32496-2.1 → 0.0.0-feat-dev-KB-32496-2.3

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 (7) hide show
  1. package/classes/{OverFlowElementWatcher.md → OverflowWatcher.md} +36 -26
  2. package/enumerations/OverflowDirection.md +29 -0
  3. package/globals.md +3 -3
  4. package/package.json +1 -1
  5. package/type-aliases/OnOverflowCallBack.md +25 -0
  6. package/enumerations/OverFlowDirection.md +0 -27
  7. package/type-aliases/OnOverFlowCallBack.md +0 -21
package/classes/{OverFlowElementWatcher.md → OverflowWatcher.md} RENAMED
@@ -2,33 +2,43 @@
2
2
 
3
3
  ***
4
4
 
5
- [@sankhyalabs/core](../globals.md) / OverFlowElementWatcher
5
+ [@sankhyalabs/core](../globals.md) / OverflowWatcher
6
6
 
7
- # Class: OverFlowElementWatcher
7
+ # Class: OverflowWatcher
8
8
 
9
9
  ## Constructors
10
10
 
11
- ### new OverFlowElementWatcher()
11
+ ### new OverflowWatcher()
12
12
 
13
- > **new OverFlowElementWatcher**(`element`, `callback`, `overFlowDirection`, `deltaSize`): [`OverFlowElementWatcher`](OverFlowElementWatcher.md)
13
+ > **new OverflowWatcher**(`element`, `callback`, `overFlowDirection`, `deltaSize`): [`OverflowWatcher`](OverflowWatcher.md)
14
+
15
+ Cria uma instancia do OverflowWatcher
14
16
 
15
17
  #### Parameters
16
18
 
17
19
  • **element**: `HTMLElement`
18
20
 
19
- • **callback**: [`OnOverFlowCallBack`](../type-aliases/OnOverFlowCallBack.md)
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.
20
26
 
21
- • **overFlowDirection**: [`OverFlowDirection`](../enumerations/OverFlowDirection.md)= `OverFlowDirection.HORIZONTAL`
27
+ • **overFlowDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md)= `OverflowDirection.HORIZONTAL`
28
+
29
+ Indica direção que o overflow será monitorado.
22
30
 
23
31
  • **deltaSize**: `number`= `10`
24
32
 
33
+ Variação de tamanho que será considerada como overflow.
34
+
25
35
  #### Returns
26
36
 
27
- [`OverFlowElementWatcher`](OverFlowElementWatcher.md)
37
+ [`OverflowWatcher`](OverflowWatcher.md)
28
38
 
29
39
  #### Source
30
40
 
31
- src/utils/OverFlowElementWatcher.ts:12
41
+ src/utils/OverflowWatcher/index.ts:25
32
42
 
33
43
  ## Properties
34
44
 
@@ -38,7 +48,7 @@ src/utils/OverFlowElementWatcher.ts:12
38
48
 
39
49
  #### Source
40
50
 
41
- src/utils/OverFlowElementWatcher.ts:10
51
+ src/utils/OverflowWatcher/index.ts:15
42
52
 
43
53
  ***
44
54
 
@@ -48,7 +58,7 @@ src/utils/OverFlowElementWatcher.ts:10
48
58
 
49
59
  #### Source
50
60
 
51
- src/utils/OverFlowElementWatcher.ts:9
61
+ src/utils/OverflowWatcher/index.ts:14
52
62
 
53
63
  ***
54
64
 
@@ -58,17 +68,17 @@ src/utils/OverFlowElementWatcher.ts:9
58
68
 
59
69
  #### Source
60
70
 
61
- src/utils/OverFlowElementWatcher.ts:6
71
+ src/utils/OverflowWatcher/index.ts:11
62
72
 
63
73
  ***
64
74
 
65
75
  ### \_onResize
66
76
 
67
- > `private` **\_onResize**: [`OnOverFlowCallBack`](../type-aliases/OnOverFlowCallBack.md)
77
+ > `private` **\_onResize**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
68
78
 
69
79
  #### Source
70
80
 
71
- src/utils/OverFlowElementWatcher.ts:4
81
+ src/utils/OverflowWatcher/index.ts:9
72
82
 
73
83
  ***
74
84
 
@@ -78,7 +88,7 @@ src/utils/OverFlowElementWatcher.ts:4
78
88
 
79
89
  #### Source
80
90
 
81
- src/utils/OverFlowElementWatcher.ts:8
91
+ src/utils/OverflowWatcher/index.ts:13
82
92
 
83
93
  ***
84
94
 
@@ -88,17 +98,17 @@ src/utils/OverFlowElementWatcher.ts:8
88
98
 
89
99
  #### Source
90
100
 
91
- src/utils/OverFlowElementWatcher.ts:5
101
+ src/utils/OverflowWatcher/index.ts:10
92
102
 
93
103
  ***
94
104
 
95
105
  ### \_scrollDirection
96
106
 
97
- > `private` **\_scrollDirection**: [`OverFlowDirection`](../enumerations/OverFlowDirection.md) = `OverFlowDirection.HORIZONTAL`
107
+ > `private` **\_scrollDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md) = `OverflowDirection.HORIZONTAL`
98
108
 
99
109
  #### Source
100
110
 
101
- src/utils/OverFlowElementWatcher.ts:7
111
+ src/utils/OverflowWatcher/index.ts:12
102
112
 
103
113
  ## Methods
104
114
 
@@ -116,7 +126,7 @@ src/utils/OverFlowElementWatcher.ts:7
116
126
 
117
127
  #### Source
118
128
 
119
- src/utils/OverFlowElementWatcher.ts:112
129
+ src/utils/OverflowWatcher/index.ts:126
120
130
 
121
131
  ***
122
132
 
@@ -134,7 +144,7 @@ src/utils/OverFlowElementWatcher.ts:112
134
144
 
135
145
  #### Source
136
146
 
137
- src/utils/OverFlowElementWatcher.ts:127
147
+ src/utils/OverflowWatcher/index.ts:141
138
148
 
139
149
  ***
140
150
 
@@ -148,7 +158,7 @@ src/utils/OverFlowElementWatcher.ts:127
148
158
 
149
159
  #### Source
150
160
 
151
- src/utils/OverFlowElementWatcher.ts:23
161
+ src/utils/OverflowWatcher/index.ts:37
152
162
 
153
163
  ***
154
164
 
@@ -162,7 +172,7 @@ src/utils/OverFlowElementWatcher.ts:23
162
172
 
163
173
  #### Source
164
174
 
165
- src/utils/OverFlowElementWatcher.ts:51
175
+ src/utils/OverflowWatcher/index.ts:65
166
176
 
167
177
  ***
168
178
 
@@ -180,7 +190,7 @@ src/utils/OverFlowElementWatcher.ts:51
180
190
 
181
191
  #### Source
182
192
 
183
- src/utils/OverFlowElementWatcher.ts:27
193
+ src/utils/OverflowWatcher/index.ts:41
184
194
 
185
195
  ***
186
196
 
@@ -198,7 +208,7 @@ src/utils/OverFlowElementWatcher.ts:27
198
208
 
199
209
  #### Source
200
210
 
201
- src/utils/OverFlowElementWatcher.ts:43
211
+ src/utils/OverflowWatcher/index.ts:57
202
212
 
203
213
  ***
204
214
 
@@ -218,7 +228,7 @@ src/utils/OverFlowElementWatcher.ts:43
218
228
 
219
229
  #### Source
220
230
 
221
- src/utils/OverFlowElementWatcher.ts:59
231
+ src/utils/OverflowWatcher/index.ts:73
222
232
 
223
233
  ***
224
234
 
@@ -238,7 +248,7 @@ src/utils/OverFlowElementWatcher.ts:59
238
248
 
239
249
  #### Source
240
250
 
241
- src/utils/OverFlowElementWatcher.ts:89
251
+ src/utils/OverflowWatcher/index.ts:103
242
252
 
243
253
  ***
244
254
 
@@ -256,4 +266,4 @@ src/utils/OverFlowElementWatcher.ts:89
256
266
 
257
267
  #### Source
258
268
 
259
- src/utils/OverFlowElementWatcher.ts:77
269
+ src/utils/OverflowWatcher/index.ts:91
package/enumerations/OverflowDirection.md ADDED
@@ -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
package/globals.md CHANGED
@@ -14,7 +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
+ - [OverflowDirection](enumerations/OverflowDirection.md)
18
18
  - [SelectionMode](enumerations/SelectionMode.md)
19
19
  - [SortMode](enumerations/SortMode.md)
20
20
  - [UserInterface](enumerations/UserInterface.md)
@@ -43,7 +43,7 @@
43
43
  - [NumberUtils](classes/NumberUtils.md)
44
44
  - [ObjectUtils](classes/ObjectUtils.md)
45
45
  - [OnboardingUtils](classes/OnboardingUtils.md)
46
- - [OverFlowElementWatcher](classes/OverFlowElementWatcher.md)
46
+ - [OverflowWatcher](classes/OverflowWatcher.md)
47
47
  - [PromiseSync](classes/PromiseSync.md)
48
48
  - [ReadyUtil](classes/ReadyUtil.md)
49
49
  - [RequestMetadata](classes/RequestMetadata.md)
@@ -84,7 +84,7 @@
84
84
 
85
85
  ## Type Aliases
86
86
 
87
- - [OnOverFlowCallBack](type-aliases/OnOverFlowCallBack.md)
87
+ - [OnOverflowCallBack](type-aliases/OnOverflowCallBack.md)
88
88
 
89
89
  ## Functions
90
90
 
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.1",
3
+ "version": "0.0.0-feat-dev-KB-32496-2.3",
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,25 @@
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
+ Callback que será chamado quando o overflow de um elemento for alterado.
12
+
13
+ ## Parameters
14
+
15
+ • **elementsOverFlow**: `Element`[]
16
+
17
+ Conjunto de elementos filhos que estão causando overflow no elemento pai.
18
+
19
+ ## Returns
20
+
21
+ `void`
22
+
23
+ ## Source
24
+
25
+ src/utils/OverflowWatcher/types/overflow-callback.ts:6
package/enumerations/OverFlowDirection.md DELETED
@@ -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/OverFlowElementWatcher.ts:143
18
-
19
- ***
20
-
21
- ### VERTICAL
22
-
23
- > **VERTICAL**: `0`
24
-
25
- #### Source
26
-
27
- src/utils/OverFlowElementWatcher.ts:142
package/type-aliases/OnOverFlowCallBack.md DELETED
@@ -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/OverFlowElementWatcher.ts:139