@sankhyalabs/core-docs 0.0.0-feat-dev-KB-32496-2.2 → 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/{OverFlowWatcher.md → OverflowWatcher.md} +26 -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/{OverFlowWatcher.md → OverflowWatcher.md} RENAMED
@@ -2,15 +2,15 @@
2
2
 
3
3
  ***
4
4
 
5
- [@sankhyalabs/core](../globals.md) / OverFlowWatcher
5
+ [@sankhyalabs/core](../globals.md) / OverflowWatcher
6
6
 
7
- # Class: OverFlowWatcher
7
+ # Class: OverflowWatcher
8
8
 
9
9
  ## Constructors
10
10
 
11
- ### new OverFlowWatcher()
11
+ ### new OverflowWatcher()
12
12
 
13
- > **new OverFlowWatcher**(`element`, `callback`, `overFlowDirection`, `deltaSize`): [`OverFlowWatcher`](OverFlowWatcher.md)
13
+ > **new OverflowWatcher**(`element`, `callback`, `overFlowDirection`, `deltaSize`): [`OverflowWatcher`](OverflowWatcher.md)
14
14
 
15
15
  Cria uma instancia do OverflowWatcher
16
16
 
@@ -20,11 +20,11 @@ Cria uma instancia do OverflowWatcher
20
20
 
21
21
  Elemento HTML que o overflow será observado.
22
22
 
23
- • **callback**: [`OnOverFlowCallBack`](../type-aliases/OnOverFlowCallBack.md)
23
+ • **callback**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
24
24
 
25
25
  Função que sera chamada quando ocorrer overflow no elemento.
26
26
 
27
- • **overFlowDirection**: [`OverFlowDirection`](../enumerations/OverFlowDirection.md)= `OverFlowDirection.HORIZONTAL`
27
+ • **overFlowDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md)= `OverflowDirection.HORIZONTAL`
28
28
 
29
29
  Indica direção que o overflow será monitorado.
30
30
 
@@ -34,11 +34,11 @@ Variação de tamanho que será considerada como overflow.
34
34
 
35
35
  #### Returns
36
36
 
37
- [`OverFlowWatcher`](OverFlowWatcher.md)
37
+ [`OverflowWatcher`](OverflowWatcher.md)
38
38
 
39
39
  #### Source
40
40
 
41
- src/utils/OverflowWatcher.ts:20
41
+ src/utils/OverflowWatcher/index.ts:25
42
42
 
43
43
  ## Properties
44
44
 
@@ -48,7 +48,7 @@ src/utils/OverflowWatcher.ts:20
48
48
 
49
49
  #### Source
50
50
 
51
- src/utils/OverflowWatcher.ts:10
51
+ src/utils/OverflowWatcher/index.ts:15
52
52
 
53
53
  ***
54
54
 
@@ -58,7 +58,7 @@ src/utils/OverflowWatcher.ts:10
58
58
 
59
59
  #### Source
60
60
 
61
- src/utils/OverflowWatcher.ts:9
61
+ src/utils/OverflowWatcher/index.ts:14
62
62
 
63
63
  ***
64
64
 
@@ -68,17 +68,17 @@ src/utils/OverflowWatcher.ts:9
68
68
 
69
69
  #### Source
70
70
 
71
- src/utils/OverflowWatcher.ts:6
71
+ src/utils/OverflowWatcher/index.ts:11
72
72
 
73
73
  ***
74
74
 
75
75
  ### \_onResize
76
76
 
77
- > `private` **\_onResize**: [`OnOverFlowCallBack`](../type-aliases/OnOverFlowCallBack.md)
77
+ > `private` **\_onResize**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
78
78
 
79
79
  #### Source
80
80
 
81
- src/utils/OverflowWatcher.ts:4
81
+ src/utils/OverflowWatcher/index.ts:9
82
82
 
83
83
  ***
84
84
 
@@ -88,7 +88,7 @@ src/utils/OverflowWatcher.ts:4
88
88
 
89
89
  #### Source
90
90
 
91
- src/utils/OverflowWatcher.ts:8
91
+ src/utils/OverflowWatcher/index.ts:13
92
92
 
93
93
  ***
94
94
 
@@ -98,17 +98,17 @@ src/utils/OverflowWatcher.ts:8
98
98
 
99
99
  #### Source
100
100
 
101
- src/utils/OverflowWatcher.ts:5
101
+ src/utils/OverflowWatcher/index.ts:10
102
102
 
103
103
  ***
104
104
 
105
105
  ### \_scrollDirection
106
106
 
107
- > `private` **\_scrollDirection**: [`OverFlowDirection`](../enumerations/OverFlowDirection.md) = `OverFlowDirection.HORIZONTAL`
107
+ > `private` **\_scrollDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md) = `OverflowDirection.HORIZONTAL`
108
108
 
109
109
  #### Source
110
110
 
111
- src/utils/OverflowWatcher.ts:7
111
+ src/utils/OverflowWatcher/index.ts:12
112
112
 
113
113
  ## Methods
114
114
 
@@ -126,7 +126,7 @@ src/utils/OverflowWatcher.ts:7
126
126
 
127
127
  #### Source
128
128
 
129
- src/utils/OverflowWatcher.ts:121
129
+ src/utils/OverflowWatcher/index.ts:126
130
130
 
131
131
  ***
132
132
 
@@ -144,7 +144,7 @@ src/utils/OverflowWatcher.ts:121
144
144
 
145
145
  #### Source
146
146
 
147
- src/utils/OverflowWatcher.ts:136
147
+ src/utils/OverflowWatcher/index.ts:141
148
148
 
149
149
  ***
150
150
 
@@ -158,7 +158,7 @@ src/utils/OverflowWatcher.ts:136
158
158
 
159
159
  #### Source
160
160
 
161
- src/utils/OverflowWatcher.ts:32
161
+ src/utils/OverflowWatcher/index.ts:37
162
162
 
163
163
  ***
164
164
 
@@ -172,7 +172,7 @@ src/utils/OverflowWatcher.ts:32
172
172
 
173
173
  #### Source
174
174
 
175
- src/utils/OverflowWatcher.ts:60
175
+ src/utils/OverflowWatcher/index.ts:65
176
176
 
177
177
  ***
178
178
 
@@ -190,7 +190,7 @@ src/utils/OverflowWatcher.ts:60
190
190
 
191
191
  #### Source
192
192
 
193
- src/utils/OverflowWatcher.ts:36
193
+ src/utils/OverflowWatcher/index.ts:41
194
194
 
195
195
  ***
196
196
 
@@ -208,7 +208,7 @@ src/utils/OverflowWatcher.ts:36
208
208
 
209
209
  #### Source
210
210
 
211
- src/utils/OverflowWatcher.ts:52
211
+ src/utils/OverflowWatcher/index.ts:57
212
212
 
213
213
  ***
214
214
 
@@ -228,7 +228,7 @@ src/utils/OverflowWatcher.ts:52
228
228
 
229
229
  #### Source
230
230
 
231
- src/utils/OverflowWatcher.ts:68
231
+ src/utils/OverflowWatcher/index.ts:73
232
232
 
233
233
  ***
234
234
 
@@ -248,7 +248,7 @@ src/utils/OverflowWatcher.ts:68
248
248
 
249
249
  #### Source
250
250
 
251
- src/utils/OverflowWatcher.ts:98
251
+ src/utils/OverflowWatcher/index.ts:103
252
252
 
253
253
  ***
254
254
 
@@ -266,4 +266,4 @@ src/utils/OverflowWatcher.ts:98
266
266
 
267
267
  #### Source
268
268
 
269
- src/utils/OverflowWatcher.ts:86
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
- - [OverFlowWatcher](classes/OverFlowWatcher.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.2",
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/OverflowWatcher.ts:152
18
-
19
- ***
20
-
21
- ### VERTICAL
22
-
23
- > **VERTICAL**: `0`
24
-
25
- #### Source
26
-
27
- src/utils/OverflowWatcher.ts:151
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/OverflowWatcher.ts:148