@sankhyalabs/core-docs 5.20.0-dev.5 → 5.20.0-dev.6
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/README.md +3 -1
- package/classes/ApplicationContext.md +31 -32
- package/classes/ArrayUtils.md +95 -83
- package/classes/AuthorizedServiceCaller.md +25 -34
- package/classes/Change.md +59 -74
- package/classes/DataUnit.md +1017 -1091
- package/classes/DataUnitAction.md +25 -42
- package/classes/DataUnitStorage.md +40 -43
- package/classes/DateUtils.md +133 -126
- package/classes/ElementIDUtils.md +123 -122
- package/classes/ErrorException.md +67 -88
- package/classes/ErrorTracking.md +20 -23
- package/classes/FieldComparator.md +35 -39
- package/classes/FloatingManager.md +195 -198
- package/classes/HTMLBuilder.md +14 -20
- package/classes/HttpProvider.md +45 -41
- package/classes/IDBRepository.md +179 -196
- package/classes/JSUtils.md +65 -66
- package/classes/KeyboardManager.md +95 -87
- package/classes/{MaskFormatter-1.md → MaskFormatter.md} +81 -120
- package/classes/NumberUtils.md +163 -152
- package/classes/ObjectUtils.md +66 -71
- package/classes/OnboardingUtils.md +36 -51
- package/classes/PromiseSync.md +25 -42
- package/classes/ReadyUtil.md +31 -41
- package/classes/RequestMetadata.md +29 -30
- package/classes/SearchUtils.md +18 -20
- package/classes/SelectionInfo.md +59 -74
- package/classes/SkwHttpProvider.md +33 -45
- package/classes/StringUtils.md +297 -322
- package/classes/TimeFormatter.md +43 -44
- package/classes/UserAgentUtils.md +17 -20
- package/classes/VersionUtils.md +15 -18
- package/classes/WaitingChangeException.md +63 -84
- package/classes/WarningException.md +67 -88
- package/enumerations/Action.md +297 -0
- package/enumerations/ChangeOperation.md +47 -0
- package/enumerations/DataType.md +57 -0
- package/enumerations/DependencyType.md +37 -0
- package/enumerations/SelectionMode.md +27 -0
- package/enumerations/SortMode.md +27 -0
- package/enumerations/UserInterface.md +177 -0
- package/functions/defaultDataLoader.md +25 -0
- package/{modules.md → globals.md} +17 -39
- package/interfaces/ChildDescriptor.md +12 -16
- package/interfaces/ChildLink.md +9 -12
- package/interfaces/DUActionInterceptor.md +10 -14
- package/interfaces/ExecutionContext.md +17 -32
- package/interfaces/FieldDescriptor.md +52 -66
- package/interfaces/Filter.md +13 -17
- package/interfaces/IElementIDInfo.md +11 -14
- package/interfaces/ILoadResult.md +11 -16
- package/interfaces/IRepository.md +88 -93
- package/interfaces/IRepositoryIndex.md +23 -30
- package/interfaces/LoadDataRequest.md +36 -45
- package/interfaces/LoadDataResponse.md +11 -14
- package/interfaces/PageRequest.md +16 -20
- package/interfaces/PaginationInfo.md +24 -31
- package/interfaces/PromiseSyncCallback.md +13 -17
- package/interfaces/QuickFilter.md +17 -21
- package/interfaces/Record.md +26 -33
- package/interfaces/SavedRecord.md +33 -41
- package/interfaces/Sort.md +12 -16
- package/interfaces/SortingProvider.md +10 -13
- package/interfaces/UnitMetadata.md +16 -21
- package/interfaces/WaitingChange.md +16 -20
- package/namespaces/MaskFormatter/README.md +17 -0
- package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +13 -0
- package/namespaces/MaskFormatter/variables/MaskCharacter.md +13 -0
- package/package.json +1 -1
- package/enums/Action.md +0 -305
- package/enums/ChangeOperation.md +0 -52
- package/enums/DataType.md +0 -63
- package/enums/DependencyType.md +0 -41
- package/enums/SelectionMode.md +0 -30
- package/enums/SortMode.md +0 -30
- package/enums/UserInterface.md +0 -195
- package/modules/MaskFormatter.md +0 -37
|
@@ -1,86 +1,75 @@
|
|
|
1
|
-
[
|
|
1
|
+
[**@sankhyalabs/core**](../README.md) • **Docs**
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@sankhyalabs/core](../globals.md) / ElementIDUtils
|
|
2
6
|
|
|
3
7
|
# Class: ElementIDUtils
|
|
4
8
|
|
|
5
9
|
`ElementIDUtils`: O ElementIDUtils é um utilitário responsável por criar e adicionar identificadores únicos aos componentes através do atributo data-element-id.
|
|
6
10
|
A finalidade dele é otimizar a automação dos testes e melhorar a eficiência na manipulação dos componentes do Design System, garantindo seleções precisas e seguras.
|
|
7
11
|
|
|
8
|
-
##
|
|
9
|
-
|
|
10
|
-
### Constructors
|
|
11
|
-
|
|
12
|
-
- [constructor](ElementIDUtils.md#constructor)
|
|
13
|
-
|
|
14
|
-
### Properties
|
|
15
|
-
|
|
16
|
-
- [DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME](ElementIDUtils.md#data_element_id_attribute_name)
|
|
17
|
-
- [INTERNAL\_INPUT\_NAME](ElementIDUtils.md#internal_input_name)
|
|
18
|
-
- [REGEX\_DATAUNIT\_NAME](ElementIDUtils.md#regex_dataunit_name)
|
|
19
|
-
|
|
20
|
-
### Methods
|
|
12
|
+
## Constructors
|
|
21
13
|
|
|
22
|
-
|
|
23
|
-
- [addIDInfoIfNotExists](ElementIDUtils.md#addidinfoifnotexists)
|
|
24
|
-
- [addPrefix](ElementIDUtils.md#addprefix)
|
|
25
|
-
- [addSuffix](ElementIDUtils.md#addsuffix)
|
|
26
|
-
- [formatDescription](ElementIDUtils.md#formatdescription)
|
|
27
|
-
- [getAttributeValid](ElementIDUtils.md#getattributevalid)
|
|
28
|
-
- [getDataElementID](ElementIDUtils.md#getdataelementid)
|
|
29
|
-
- [getDataElementIDAttribute](ElementIDUtils.md#getdataelementidattribute)
|
|
30
|
-
- [getInternalIDInfo](ElementIDUtils.md#getinternalidinfo)
|
|
31
|
-
- [parseDataUnitName](ElementIDUtils.md#parsedataunitname)
|
|
14
|
+
### new ElementIDUtils()
|
|
32
15
|
|
|
33
|
-
|
|
16
|
+
> **new ElementIDUtils**(): [`ElementIDUtils`](ElementIDUtils.md)
|
|
34
17
|
|
|
35
|
-
|
|
18
|
+
#### Returns
|
|
36
19
|
|
|
37
|
-
|
|
20
|
+
[`ElementIDUtils`](ElementIDUtils.md)
|
|
38
21
|
|
|
39
22
|
## Properties
|
|
40
23
|
|
|
41
24
|
### DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME
|
|
42
25
|
|
|
43
|
-
|
|
26
|
+
> `static` **DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME**: `string` = `"data-element-id"`
|
|
44
27
|
|
|
45
|
-
####
|
|
28
|
+
#### Source
|
|
46
29
|
|
|
47
30
|
src/utils/ElementIDUtils.ts:14
|
|
48
31
|
|
|
49
|
-
|
|
32
|
+
***
|
|
50
33
|
|
|
51
34
|
### INTERNAL\_INPUT\_NAME
|
|
52
35
|
|
|
53
|
-
|
|
36
|
+
> `static` **INTERNAL\_INPUT\_NAME**: `string` = `"embedded"`
|
|
54
37
|
|
|
55
|
-
####
|
|
38
|
+
#### Source
|
|
56
39
|
|
|
57
40
|
src/utils/ElementIDUtils.ts:15
|
|
58
41
|
|
|
59
|
-
|
|
42
|
+
***
|
|
60
43
|
|
|
61
44
|
### REGEX\_DATAUNIT\_NAME
|
|
62
45
|
|
|
63
|
-
|
|
46
|
+
> `static` `private` **REGEX\_DATAUNIT\_NAME**: `RegExp`
|
|
64
47
|
|
|
65
|
-
####
|
|
48
|
+
#### Source
|
|
66
49
|
|
|
67
50
|
src/utils/ElementIDUtils.ts:16
|
|
68
51
|
|
|
69
52
|
## Methods
|
|
70
53
|
|
|
71
|
-
### addIDInfo
|
|
54
|
+
### addIDInfo()
|
|
72
55
|
|
|
73
|
-
|
|
56
|
+
> `static` **addIDInfo**(`element`, `suffix`?, `iDInfo`?): `string`
|
|
74
57
|
|
|
75
58
|
Cria e adiciona a propriedade `data-element-id` em um elemento.
|
|
76
59
|
|
|
77
60
|
#### Parameters
|
|
78
61
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
62
|
+
• **element**: `HTMLElement`
|
|
63
|
+
|
|
64
|
+
Elemento HTML a ser modificado (HTMLElement).
|
|
65
|
+
|
|
66
|
+
• **suffix?**: `string`
|
|
67
|
+
|
|
68
|
+
Sufixo/Texto para ser adicionado.
|
|
69
|
+
|
|
70
|
+
• **iDInfo?**: [`IElementIDInfo`](../interfaces/IElementIDInfo.md)
|
|
71
|
+
|
|
72
|
+
ID para ser adicionado.
|
|
84
73
|
|
|
85
74
|
#### Returns
|
|
86
75
|
|
|
@@ -88,46 +77,49 @@ Cria e adiciona a propriedade `data-element-id` em um elemento.
|
|
|
88
77
|
|
|
89
78
|
- O data-element-id gerado.
|
|
90
79
|
|
|
91
|
-
####
|
|
80
|
+
#### Source
|
|
92
81
|
|
|
93
82
|
src/utils/ElementIDUtils.ts:26
|
|
94
83
|
|
|
95
|
-
|
|
84
|
+
***
|
|
96
85
|
|
|
97
|
-
### addIDInfoIfNotExists
|
|
86
|
+
### addIDInfoIfNotExists()
|
|
98
87
|
|
|
99
|
-
|
|
88
|
+
> `static` **addIDInfoIfNotExists**(`element`, `suffix`?, `iDInfo`?): `string`
|
|
100
89
|
|
|
101
90
|
#### Parameters
|
|
102
91
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
92
|
+
• **element**: `HTMLElement`
|
|
93
|
+
|
|
94
|
+
• **suffix?**: `string`
|
|
95
|
+
|
|
96
|
+
• **iDInfo?**: [`IElementIDInfo`](../interfaces/IElementIDInfo.md)
|
|
108
97
|
|
|
109
98
|
#### Returns
|
|
110
99
|
|
|
111
100
|
`string`
|
|
112
101
|
|
|
113
|
-
####
|
|
102
|
+
#### Source
|
|
114
103
|
|
|
115
104
|
src/utils/ElementIDUtils.ts:39
|
|
116
105
|
|
|
117
|
-
|
|
106
|
+
***
|
|
118
107
|
|
|
119
|
-
### addPrefix
|
|
108
|
+
### addPrefix()
|
|
120
109
|
|
|
121
|
-
|
|
110
|
+
> `static` `private` **addPrefix**(`iDInfo`, `dataElementID`): `string`
|
|
122
111
|
|
|
123
112
|
Adiciona a propriedade name do DataUnit como prefixo do data-element-id do elemento.
|
|
124
113
|
|
|
125
114
|
#### Parameters
|
|
126
115
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
116
|
+
• **iDInfo**: `undefined` \| [`IElementIDInfo`](../interfaces/IElementIDInfo.md)
|
|
117
|
+
|
|
118
|
+
ID para ser adicionado ao `data-element-id`.
|
|
119
|
+
|
|
120
|
+
• **dataElementID**: `string`
|
|
121
|
+
|
|
122
|
+
Sufixo/Texto para ser adicionado ao `data-element-id`.
|
|
131
123
|
|
|
132
124
|
#### Returns
|
|
133
125
|
|
|
@@ -135,32 +127,31 @@ Adiciona a propriedade name do DataUnit como prefixo do data-element-id do eleme
|
|
|
135
127
|
|
|
136
128
|
- String contendo informação para ser usada no `data-element-id` do elemento.
|
|
137
129
|
|
|
138
|
-
####
|
|
130
|
+
#### Source
|
|
139
131
|
|
|
140
132
|
src/utils/ElementIDUtils.ts:147
|
|
141
133
|
|
|
142
|
-
|
|
134
|
+
***
|
|
143
135
|
|
|
144
|
-
### addSuffix
|
|
136
|
+
### addSuffix()
|
|
145
137
|
|
|
146
|
-
|
|
138
|
+
> `static` `private` **addSuffix**(`dataElementID`, `suffix`, `element`): `string`
|
|
147
139
|
|
|
148
140
|
Adiciona sufixo ao atributo `data-element-id` de um elemento, utilizado para montar a hierarquia dos ids dos componentes em tela.
|
|
149
141
|
|
|
150
|
-
|
|
142
|
+
#### Parameters
|
|
151
143
|
|
|
152
|
-
|
|
153
|
-
Um ez-combo-box tem data-element-id = codparc_input_embedded_combo.
|
|
154
|
-
Dentro desse ez-combo-box existe um ez-text-input. O data-element-id teria como sufixo o id 'codparc_input_embedded_combo' referente ao seu pai.
|
|
155
|
-
```
|
|
144
|
+
• **dataElementID**: `null` \| `string`
|
|
156
145
|
|
|
157
|
-
|
|
146
|
+
ID para ser adicionado ao `data-element-id`.
|
|
147
|
+
|
|
148
|
+
• **suffix**: `undefined` \| `string`
|
|
149
|
+
|
|
150
|
+
Sufixo/Texto para ser adicionado ao `data-element-id`.
|
|
158
151
|
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
| `suffix` | `undefined` \| `string` | Sufixo/Texto para ser adicionado ao `data-element-id`. |
|
|
163
|
-
| `element` | `HTMLElement` | Elemento HTML a ser modificado (HTMLElement). |
|
|
152
|
+
• **element**: `HTMLElement`
|
|
153
|
+
|
|
154
|
+
Elemento HTML a ser modificado (HTMLElement).
|
|
164
155
|
|
|
165
156
|
#### Returns
|
|
166
157
|
|
|
@@ -168,23 +159,30 @@ Dentro desse ez-combo-box existe um ez-text-input. O data-element-id teria como
|
|
|
168
159
|
|
|
169
160
|
- `data-element-id` com sufixo.
|
|
170
161
|
|
|
171
|
-
####
|
|
162
|
+
#### Example
|
|
163
|
+
|
|
164
|
+
```ts
|
|
165
|
+
Um ez-combo-box tem data-element-id = codparc_input_embedded_combo.
|
|
166
|
+
Dentro desse ez-combo-box existe um ez-text-input. O data-element-id teria como sufixo o id 'codparc_input_embedded_combo' referente ao seu pai.
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
#### Source
|
|
172
170
|
|
|
173
171
|
src/utils/ElementIDUtils.ts:130
|
|
174
172
|
|
|
175
|
-
|
|
173
|
+
***
|
|
176
174
|
|
|
177
|
-
### formatDescription
|
|
175
|
+
### formatDescription()
|
|
178
176
|
|
|
179
|
-
|
|
177
|
+
> `static` `private` **formatDescription**(`value`): `string`
|
|
180
178
|
|
|
181
179
|
Remove caracteres especiais.
|
|
182
180
|
|
|
183
181
|
#### Parameters
|
|
184
182
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
183
|
+
• **value**: `null` \| `string`
|
|
184
|
+
|
|
185
|
+
Texto que terá os caracteres especiais removidos.
|
|
188
186
|
|
|
189
187
|
#### Returns
|
|
190
188
|
|
|
@@ -192,50 +190,59 @@ Remove caracteres especiais.
|
|
|
192
190
|
|
|
193
191
|
- Retorna a string sem caracteres especiais e em camelCase.
|
|
194
192
|
|
|
195
|
-
####
|
|
193
|
+
#### Source
|
|
196
194
|
|
|
197
195
|
src/utils/ElementIDUtils.ts:162
|
|
198
196
|
|
|
199
|
-
|
|
197
|
+
***
|
|
200
198
|
|
|
201
|
-
### getAttributeValid
|
|
199
|
+
### getAttributeValid()
|
|
202
200
|
|
|
203
|
-
|
|
201
|
+
> `static` `private` **getAttributeValid**(`element`, `iDInfo`?): `null` \| `string`
|
|
204
202
|
|
|
205
203
|
Obtém ID válido para o elemento.
|
|
206
204
|
|
|
207
205
|
#### Parameters
|
|
208
206
|
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
207
|
+
• **element**: `HTMLElement`
|
|
208
|
+
|
|
209
|
+
Elemento HTML a ser modificado (HTMLElement).
|
|
210
|
+
|
|
211
|
+
• **iDInfo?**: [`IElementIDInfo`](../interfaces/IElementIDInfo.md)
|
|
212
|
+
|
|
213
|
+
ID para ser adicionado.
|
|
213
214
|
|
|
214
215
|
#### Returns
|
|
215
216
|
|
|
216
|
-
|
|
217
|
+
`null` \| `string`
|
|
217
218
|
|
|
218
219
|
- ID para ser adicionado ao elemento conforme ordem de prioridade.
|
|
219
220
|
|
|
220
|
-
####
|
|
221
|
+
#### Source
|
|
221
222
|
|
|
222
223
|
src/utils/ElementIDUtils.ts:90
|
|
223
224
|
|
|
224
|
-
|
|
225
|
+
***
|
|
225
226
|
|
|
226
|
-
### getDataElementID
|
|
227
|
+
### getDataElementID()
|
|
227
228
|
|
|
228
|
-
|
|
229
|
+
> `static` `private` **getDataElementID**(`element`, `suffix`?, `iDInfo`?): `string`
|
|
229
230
|
|
|
230
231
|
Obtém o `data-element-id` do elemento com adição do sufixo e ID.
|
|
231
232
|
|
|
232
233
|
#### Parameters
|
|
233
234
|
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
235
|
+
• **element**: `HTMLElement`
|
|
236
|
+
|
|
237
|
+
Elemento HTML a ser modificado (HTMLElement).
|
|
238
|
+
|
|
239
|
+
• **suffix?**: `string`
|
|
240
|
+
|
|
241
|
+
Sufixo/Texto para ser adicionado.
|
|
242
|
+
|
|
243
|
+
• **iDInfo?**: [`IElementIDInfo`](../interfaces/IElementIDInfo.md)
|
|
244
|
+
|
|
245
|
+
ID para ser adicionado.
|
|
239
246
|
|
|
240
247
|
#### Returns
|
|
241
248
|
|
|
@@ -243,66 +250,60 @@ Obtém o `data-element-id` do elemento com adição do sufixo e ID.
|
|
|
243
250
|
|
|
244
251
|
- Atributo `data-element-id` do elemento modificado com sufixo e/ou ID.
|
|
245
252
|
|
|
246
|
-
####
|
|
253
|
+
#### Source
|
|
247
254
|
|
|
248
255
|
src/utils/ElementIDUtils.ts:66
|
|
249
256
|
|
|
250
|
-
|
|
257
|
+
***
|
|
251
258
|
|
|
252
|
-
### getDataElementIDAttribute
|
|
259
|
+
### getDataElementIDAttribute()
|
|
253
260
|
|
|
254
|
-
|
|
261
|
+
> `static` `private` **getDataElementIDAttribute**(`element`): `null` \| `string`
|
|
255
262
|
|
|
256
263
|
#### Parameters
|
|
257
264
|
|
|
258
|
-
|
|
259
|
-
| :------ | :------ |
|
|
260
|
-
| `element` | `HTMLElement` |
|
|
265
|
+
• **element**: `HTMLElement`
|
|
261
266
|
|
|
262
267
|
#### Returns
|
|
263
268
|
|
|
264
|
-
|
|
269
|
+
`null` \| `string`
|
|
265
270
|
|
|
266
|
-
####
|
|
271
|
+
#### Source
|
|
267
272
|
|
|
268
273
|
src/utils/ElementIDUtils.ts:168
|
|
269
274
|
|
|
270
|
-
|
|
275
|
+
***
|
|
271
276
|
|
|
272
|
-
### getInternalIDInfo
|
|
277
|
+
### getInternalIDInfo()
|
|
273
278
|
|
|
274
|
-
|
|
279
|
+
> `static` **getInternalIDInfo**(`sufix`): `string`
|
|
275
280
|
|
|
276
281
|
#### Parameters
|
|
277
282
|
|
|
278
|
-
|
|
279
|
-
| :------ | :------ |
|
|
280
|
-
| `sufix` | `string` |
|
|
283
|
+
• **sufix**: `string`
|
|
281
284
|
|
|
282
285
|
#### Returns
|
|
283
286
|
|
|
284
287
|
`string`
|
|
285
288
|
|
|
286
|
-
####
|
|
289
|
+
#### Source
|
|
287
290
|
|
|
288
291
|
src/utils/ElementIDUtils.ts:54
|
|
289
292
|
|
|
290
|
-
|
|
293
|
+
***
|
|
291
294
|
|
|
292
|
-
### parseDataUnitName
|
|
295
|
+
### parseDataUnitName()
|
|
293
296
|
|
|
294
|
-
|
|
297
|
+
> `static` `private` **parseDataUnitName**(`uri`): `string`
|
|
295
298
|
|
|
296
299
|
#### Parameters
|
|
297
300
|
|
|
298
|
-
|
|
299
|
-
| :------ | :------ |
|
|
300
|
-
| `uri` | `string` |
|
|
301
|
+
• **uri**: `string`
|
|
301
302
|
|
|
302
303
|
#### Returns
|
|
303
304
|
|
|
304
305
|
`string`
|
|
305
306
|
|
|
306
|
-
####
|
|
307
|
+
#### Source
|
|
307
308
|
|
|
308
309
|
src/utils/ElementIDUtils.ts:175
|