@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-kb-106384.1 → 0.0.0-hotfix-ga-kb-106013.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.
- package/components/snk-application/readme.md +99 -90
- package/components/snk-configurator/readme.md +1 -1
- package/components/snk-crud/readme.md +9 -9
- package/components/snk-crud/subcomponents/readme.md +4 -4
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +4 -4
- package/components/snk-data-exporter/exporter-email-sender/readme.md +1 -1
- package/components/snk-data-unit/readme.md +4 -4
- package/components/snk-filter-bar/filter-item/readme.md +1 -1
- package/components/snk-filter-bar/readme.md +6 -4
- package/components/snk-filter-field-search/readme.md +1 -1
- package/components/snk-form/readme.md +20 -10
- package/components/snk-grid/readme.md +10 -10
- package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md +1 -1
- package/components/snk-simple-crud/readme.md +11 -11
- package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +2 -2
- package/components/snk-taskbar/readme.md +22 -22
- package/package.json +1 -1
@@ -9,12 +9,12 @@
|
|
9
9
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
11
11
|
| ----------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------- |
|
12
|
-
| `configName` | `config-name` |
|
13
|
-
| `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação
|
14
|
-
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração
|
15
|
-
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração
|
12
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
13
|
+
| `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `undefined` |
|
14
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
15
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
16
16
|
| `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: any; }, redirectFrom?: string) => void` | `undefined` |
|
17
|
-
| `messagesBuilder` | -- |
|
17
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
18
18
|
|
19
19
|
|
20
20
|
## Events
|
@@ -35,17 +35,17 @@ Registra um client event para o DataFetcher da aplicação.
|
|
35
35
|
|
36
36
|
Type: `Promise<void>`
|
37
37
|
|
38
|
-
|
38
|
+
---
|
39
39
|
|
40
40
|
### `addLoadingLock(forceReady?: boolean, templateSkeletonType?: TEMPLATES_SKELETON) => Promise<() => void>`
|
41
41
|
|
42
|
-
|
42
|
+
|
43
43
|
|
44
44
|
#### Returns
|
45
45
|
|
46
46
|
Type: `Promise<() => void>`
|
47
47
|
|
48
|
-
|
48
|
+
---
|
49
49
|
|
50
50
|
### `addPendingAction(actionsLocker: string, action: Function) => Promise<void>`
|
51
51
|
|
@@ -55,17 +55,17 @@ Adiciona uma ação pendente que deve ser executada por um determinado locker.
|
|
55
55
|
|
56
56
|
Type: `Promise<void>`
|
57
57
|
|
58
|
-
|
58
|
+
---
|
59
59
|
|
60
60
|
### `addSearchListener(entityName: string, dataUnit: DataUnit, listener: ISearchListener) => Promise<IRemoveSearchListener>`
|
61
61
|
|
62
|
-
Adiciona um listener no fetcher de Pesquisa
|
62
|
+
Adiciona um listener no fetcher de Pesquisa
|
63
63
|
|
64
64
|
#### Returns
|
65
65
|
|
66
66
|
Type: `Promise<IRemoveSearchListener>`
|
67
67
|
|
68
|
-
|
68
|
+
---
|
69
69
|
|
70
70
|
### `alert(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
71
71
|
|
@@ -75,7 +75,7 @@ Exibe o diálogo de alerta de acordo com os parâmetros passados.
|
|
75
75
|
|
76
76
|
Type: `Promise<boolean>`
|
77
77
|
|
78
|
-
|
78
|
+
---
|
79
79
|
|
80
80
|
### `callServiceBroker(serviceName: string, payload: string | Object, options?: Options) => Promise<any>`
|
81
81
|
|
@@ -85,7 +85,7 @@ Realiza a chamada ao Service Broker conforme o nome do serviço.
|
|
85
85
|
|
86
86
|
Type: `Promise<any>`
|
87
87
|
|
88
|
-
|
88
|
+
---
|
89
89
|
|
90
90
|
### `clearPopUpTitle() => Promise<void>`
|
91
91
|
|
@@ -95,7 +95,7 @@ A resposta do Service Broker.
|
|
95
95
|
|
96
96
|
Type: `Promise<void>`
|
97
97
|
|
98
|
-
|
98
|
+
---
|
99
99
|
|
100
100
|
### `closeModal() => Promise<void>`
|
101
101
|
|
@@ -105,7 +105,7 @@ Fecha o Modal e limpa o conteúdo.
|
|
105
105
|
|
106
106
|
Type: `Promise<void>`
|
107
107
|
|
108
|
-
|
108
|
+
---
|
109
109
|
|
110
110
|
### `closePopUp() => Promise<void>`
|
111
111
|
|
@@ -115,17 +115,17 @@ Fecha o Popup e limpa o conteúdo.
|
|
115
115
|
|
116
116
|
Type: `Promise<void>`
|
117
117
|
|
118
|
-
|
118
|
+
---
|
119
119
|
|
120
120
|
### `confirm(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions) => Promise<boolean>`
|
121
121
|
|
122
|
-
Exibe um diálogo de confirmação
|
122
|
+
Exibe um diálogo de confirmação
|
123
123
|
|
124
124
|
#### Returns
|
125
125
|
|
126
126
|
Type: `Promise<boolean>`
|
127
127
|
|
128
|
-
|
128
|
+
---
|
129
129
|
|
130
130
|
### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
|
131
131
|
|
@@ -136,7 +136,7 @@ passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUn
|
|
136
136
|
|
137
137
|
Type: `Promise<DataUnit>`
|
138
138
|
|
139
|
-
|
139
|
+
---
|
140
140
|
|
141
141
|
### `error(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
142
142
|
|
@@ -146,20 +146,20 @@ Exibe o diálogo de erro de acordo com os parâmetros passados.
|
|
146
146
|
|
147
147
|
Type: `Promise<boolean>`
|
148
148
|
|
149
|
+
---
|
149
150
|
|
151
|
+
### `executePreparedSearch(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
|
150
152
|
|
151
|
-
|
152
|
-
|
153
|
-
Obtém as opções em componentes de pesquisa com base em opções preparadas.
|
153
|
+
Obtém as opções em componentes de pesquisa
|
154
154
|
Ex.: snk-config-options
|
155
155
|
|
156
156
|
#### Returns
|
157
157
|
|
158
158
|
Type: `Promise<IOption | IOption[]>`
|
159
159
|
|
160
|
-
|
160
|
+
---
|
161
161
|
|
162
|
-
### `executePreparedSearchPlus(mode: string, argument: string, options:
|
162
|
+
### `executePreparedSearchPlus(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
|
163
163
|
|
164
164
|
Realiza a pesquisa de registros
|
165
165
|
Ex.: snk-config-options
|
@@ -168,18 +168,18 @@ Ex.: snk-config-options
|
|
168
168
|
|
169
169
|
Type: `Promise<IOption | IOption[]>`
|
170
170
|
|
171
|
+
---
|
171
172
|
|
173
|
+
### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption> | IOption>`
|
172
174
|
|
173
|
-
|
174
|
-
|
175
|
-
Obtém as opções em componentes de pesquisa.
|
175
|
+
Obtém as opções em componentes de pesquisa
|
176
176
|
Ex.: snk-config-options
|
177
177
|
|
178
178
|
#### Returns
|
179
179
|
|
180
180
|
Type: `Promise<IOption | IOption[]>`
|
181
181
|
|
182
|
-
|
182
|
+
---
|
183
183
|
|
184
184
|
### `executeSelectDistinct(dataUnit: DataUnit, fieldName: string, argument: string) => Promise<Array<any>>`
|
185
185
|
|
@@ -191,27 +191,27 @@ coluna.
|
|
191
191
|
|
192
192
|
Type: `Promise<any[]>`
|
193
193
|
|
194
|
-
|
194
|
+
---
|
195
195
|
|
196
196
|
### `getAllAccess(resourceID?: string) => Promise<any>`
|
197
197
|
|
198
|
-
Obtém todos os acessos do usuário logado
|
198
|
+
Obtém todos os acessos do usuário logado.
|
199
199
|
|
200
200
|
#### Returns
|
201
201
|
|
202
202
|
Type: `Promise<any>`
|
203
203
|
|
204
|
-
|
204
|
+
---
|
205
205
|
|
206
206
|
### `getAppLabel() => Promise<string>`
|
207
207
|
|
208
|
-
Obtém o nome
|
208
|
+
Obtém o nome das telas da aplicação
|
209
209
|
|
210
210
|
#### Returns
|
211
211
|
|
212
212
|
Type: `Promise<string>`
|
213
213
|
|
214
|
-
|
214
|
+
---
|
215
215
|
|
216
216
|
### `getApplicationPath() => Promise<string>`
|
217
217
|
|
@@ -221,7 +221,7 @@ Retorna o path relativo da aplicação.
|
|
221
221
|
|
222
222
|
Type: `Promise<string>`
|
223
223
|
|
224
|
-
|
224
|
+
---
|
225
225
|
|
226
226
|
### `getAttributeFromHTMLWrapper(attribName: string) => Promise<string>`
|
227
227
|
|
@@ -231,7 +231,7 @@ Acessa informações de contexto "empurrados" na abertura da tela.
|
|
231
231
|
|
232
232
|
Type: `Promise<string>`
|
233
233
|
|
234
|
-
|
234
|
+
---
|
235
235
|
|
236
236
|
### `getBooleanParam(name: string) => Promise<boolean>`
|
237
237
|
|
@@ -241,37 +241,39 @@ Obtém o valor de um parâmetro do tipo booleano.
|
|
241
241
|
|
242
242
|
Type: `Promise<boolean>`
|
243
243
|
|
244
|
-
|
244
|
+
---
|
245
245
|
|
246
246
|
### `getConfig(key: string) => Promise<any>`
|
247
247
|
|
248
|
-
Obtém a configuração de um recurso por service broker
|
248
|
+
Obtém a configuração de um recurso por service broker
|
249
249
|
|
250
250
|
#### Returns
|
251
251
|
|
252
252
|
Type: `Promise<any>`
|
253
253
|
|
254
|
-
|
254
|
+
---
|
255
255
|
|
256
256
|
### `getDataFetcher() => Promise<DataFetcher>`
|
257
257
|
|
258
|
-
Retorna a
|
258
|
+
Retorna a instancia do DataFetcher utilizado pelo application
|
259
259
|
|
260
260
|
#### Returns
|
261
261
|
|
262
262
|
Type: `Promise<DataFetcher>`
|
263
263
|
|
264
|
-
|
264
|
+
DataFetcher do application
|
265
|
+
|
266
|
+
---
|
265
267
|
|
266
268
|
### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
|
267
269
|
|
268
|
-
|
270
|
+
Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
|
269
271
|
|
270
272
|
#### Returns
|
271
273
|
|
272
274
|
Type: `Promise<DataUnit>`
|
273
275
|
|
274
|
-
|
276
|
+
---
|
275
277
|
|
276
278
|
### `getDateParam(name: string) => Promise<Date>`
|
277
279
|
|
@@ -281,7 +283,7 @@ Obtém o valor de um parâmetro do tipo data.
|
|
281
283
|
|
282
284
|
Type: `Promise<Date>`
|
283
285
|
|
284
|
-
|
286
|
+
---
|
285
287
|
|
286
288
|
### `getFloatParam(name: string) => Promise<number>`
|
287
289
|
|
@@ -291,7 +293,7 @@ Obtém o valor de um parâmetro do tipo Decimal.
|
|
291
293
|
|
292
294
|
Type: `Promise<number>`
|
293
295
|
|
294
|
-
|
296
|
+
---
|
295
297
|
|
296
298
|
### `getIntParam(name: string) => Promise<number>`
|
297
299
|
|
@@ -301,7 +303,7 @@ Obtém o valor de um parâmetro do tipo Inteiro.
|
|
301
303
|
|
302
304
|
Type: `Promise<number>`
|
303
305
|
|
304
|
-
|
306
|
+
---
|
305
307
|
|
306
308
|
### `getKeyboardManager() => Promise<KeyboardManager>`
|
307
309
|
|
@@ -311,17 +313,21 @@ Obtém o controlador de teclado.
|
|
311
313
|
|
312
314
|
Type: `Promise<KeyboardManager>`
|
313
315
|
|
314
|
-
|
316
|
+
the keyboard manager
|
317
|
+
|
318
|
+
---
|
315
319
|
|
316
320
|
### `getLayoutFormConfig() => Promise<LayoutFormConfig>`
|
317
321
|
|
318
|
-
Obtém o notificador de Layout de
|
322
|
+
Obtém o notificador de Layout de formulario.
|
319
323
|
|
320
324
|
#### Returns
|
321
325
|
|
322
326
|
Type: `Promise<LayoutFormConfig>`
|
323
327
|
|
324
|
-
|
328
|
+
the Configurador de Layout do Formulario
|
329
|
+
|
330
|
+
---
|
325
331
|
|
326
332
|
### `getResourceID() => Promise<string>`
|
327
333
|
|
@@ -331,7 +337,7 @@ Obtém o resourceID da tela em questão.
|
|
331
337
|
|
332
338
|
Type: `Promise<string>`
|
333
339
|
|
334
|
-
|
340
|
+
---
|
335
341
|
|
336
342
|
### `getStringParam(name: string) => Promise<string>`
|
337
343
|
|
@@ -341,47 +347,47 @@ Obtém o valor de um parâmetro do tipo string.
|
|
341
347
|
|
342
348
|
Type: `Promise<string>`
|
343
349
|
|
344
|
-
|
350
|
+
---
|
345
351
|
|
346
352
|
### `getUserID() => Promise<string>`
|
347
353
|
|
348
|
-
Obtém o UserId
|
354
|
+
Obtém o UserId da tela em questão.
|
349
355
|
|
350
356
|
#### Returns
|
351
357
|
|
352
358
|
Type: `Promise<string>`
|
353
359
|
|
354
|
-
|
360
|
+
---
|
355
361
|
|
356
362
|
### `hasAccess(access: AutorizationType, resourceID?: string) => Promise<boolean>`
|
357
363
|
|
358
|
-
Obtém `true` caso o usuário logado
|
364
|
+
Obtém `true` caso o usuário logado tem permissão pra determinada ação.
|
359
365
|
|
360
366
|
#### Returns
|
361
367
|
|
362
368
|
Type: `Promise<boolean>`
|
363
369
|
|
364
|
-
|
370
|
+
---
|
365
371
|
|
366
372
|
### `hasClientEvent(eventID: String) => Promise<boolean>`
|
367
373
|
|
368
|
-
|
374
|
+
Verfica se um client event está registrado no DataFetcher da aplicação.
|
369
375
|
|
370
376
|
#### Returns
|
371
377
|
|
372
378
|
Type: `Promise<boolean>`
|
373
379
|
|
374
|
-
|
380
|
+
---
|
375
381
|
|
376
382
|
### `importScript(relativePath: string | Array<string>) => Promise<void>`
|
377
383
|
|
378
|
-
Realiza o import de um JavaScript que está
|
384
|
+
Realiza o import de um JavaScript que está disponivel dentro da pasta /public da aplicação.
|
379
385
|
|
380
386
|
#### Returns
|
381
387
|
|
382
388
|
Type: `Promise<void>`
|
383
389
|
|
384
|
-
|
390
|
+
---
|
385
391
|
|
386
392
|
### `info(message: string, options?: MessageOptions) => Promise<void>`
|
387
393
|
|
@@ -391,17 +397,17 @@ Exibe uma informação efêmera (de segundo plano).
|
|
391
397
|
|
392
398
|
Type: `Promise<void>`
|
393
399
|
|
394
|
-
|
400
|
+
---
|
395
401
|
|
396
402
|
### `initOnboarding(onboardingKey: string) => Promise<void>`
|
397
403
|
|
398
|
-
|
404
|
+
|
399
405
|
|
400
406
|
#### Returns
|
401
407
|
|
402
408
|
Type: `Promise<void>`
|
403
409
|
|
404
|
-
|
410
|
+
---
|
405
411
|
|
406
412
|
### `isDebugMode() => Promise<boolean>`
|
407
413
|
|
@@ -411,17 +417,19 @@ Obtém `true` caso a tela esteja em modo de debug.
|
|
411
417
|
|
412
418
|
Type: `Promise<boolean>`
|
413
419
|
|
414
|
-
|
420
|
+
---
|
415
421
|
|
416
422
|
### `isLoadedByPk() => Promise<boolean>`
|
417
423
|
|
418
|
-
Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk
|
424
|
+
Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk
|
419
425
|
|
420
426
|
#### Returns
|
421
427
|
|
422
428
|
Type: `Promise<boolean>`
|
423
429
|
|
424
|
-
|
430
|
+
boolean
|
431
|
+
|
432
|
+
---
|
425
433
|
|
426
434
|
### `isUserSup() => Promise<boolean>`
|
427
435
|
|
@@ -431,7 +439,7 @@ Obtém `true` caso o usuário logado seja o SUP.
|
|
431
439
|
|
432
440
|
Type: `Promise<boolean>`
|
433
441
|
|
434
|
-
|
442
|
+
---
|
435
443
|
|
436
444
|
### `loadTotals(name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>`
|
437
445
|
|
@@ -441,27 +449,27 @@ Obtém os totalizadores da grade.
|
|
441
449
|
|
442
450
|
Type: `Promise<Map<string, number>>`
|
443
451
|
|
444
|
-
|
452
|
+
---
|
445
453
|
|
446
454
|
### `markToReload(templateSkeletonType?: TEMPLATES_SKELETON) => Promise<void>`
|
447
455
|
|
448
|
-
|
456
|
+
|
449
457
|
|
450
458
|
#### Returns
|
451
459
|
|
452
460
|
Type: `Promise<void>`
|
453
461
|
|
454
|
-
|
462
|
+
---
|
455
463
|
|
456
464
|
### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
457
465
|
|
458
|
-
Exibe um diálogo de mensagem comum
|
466
|
+
Exibe um diálogo de mensagem comum
|
459
467
|
|
460
468
|
#### Returns
|
461
469
|
|
462
470
|
Type: `Promise<boolean>`
|
463
471
|
|
464
|
-
|
472
|
+
---
|
465
473
|
|
466
474
|
### `openApp(resourceId: string, pkObject: Object) => Promise<void>`
|
467
475
|
|
@@ -471,7 +479,7 @@ Abre determinada tela, repassando pkObject.
|
|
471
479
|
|
472
480
|
Type: `Promise<void>`
|
473
481
|
|
474
|
-
|
482
|
+
---
|
475
483
|
|
476
484
|
### `preloadMangerRemoveRecord(dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>`
|
477
485
|
|
@@ -482,17 +490,17 @@ Deve ser usado quando existe um dataunit usando loader do application, mas o rem
|
|
482
490
|
|
483
491
|
Type: `Promise<void>`
|
484
492
|
|
485
|
-
|
493
|
+
---
|
486
494
|
|
487
495
|
### `removeClientEvent(eventID: String) => Promise<void>`
|
488
496
|
|
489
|
-
Remove um client event
|
497
|
+
Remove um client event para o DataFetcher da aplicação.
|
490
498
|
|
491
499
|
#### Returns
|
492
500
|
|
493
501
|
Type: `Promise<void>`
|
494
502
|
|
495
|
-
|
503
|
+
---
|
496
504
|
|
497
505
|
### `saveConfig(key: string, data: Object) => Promise<any>`
|
498
506
|
|
@@ -502,7 +510,7 @@ Salva a configuração de determinado recurso.
|
|
502
510
|
|
503
511
|
Type: `Promise<any>`
|
504
512
|
|
505
|
-
|
513
|
+
---
|
506
514
|
|
507
515
|
### `setPopUpTitle(title: string) => Promise<void>`
|
508
516
|
|
@@ -512,7 +520,7 @@ O resultado da operação de salvamento.
|
|
512
520
|
|
513
521
|
Type: `Promise<void>`
|
514
522
|
|
515
|
-
|
523
|
+
---
|
516
524
|
|
517
525
|
### `setSearchFilterContext(name: string, value: string) => Promise<void>`
|
518
526
|
|
@@ -522,18 +530,19 @@ Atribui valor para parâmetros de contexto no componente de pesquisa.
|
|
522
530
|
|
523
531
|
Type: `Promise<void>`
|
524
532
|
|
525
|
-
|
533
|
+
---
|
526
534
|
|
527
535
|
### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
|
528
536
|
|
529
|
-
Apresenta uma lista de alertas
|
530
|
-
|
537
|
+
Apresenta uma lista de alertas,
|
538
|
+
geralmente é utilizado para apresentar resultados
|
539
|
+
de processamentos em lote.
|
531
540
|
|
532
541
|
#### Returns
|
533
542
|
|
534
543
|
Type: `Promise<void>`
|
535
544
|
|
536
|
-
|
545
|
+
---
|
537
546
|
|
538
547
|
### `showModal(content: HTMLElement) => Promise<void>`
|
539
548
|
|
@@ -543,7 +552,7 @@ Exibe o conteúdo passado em um Modal.
|
|
543
552
|
|
544
553
|
Type: `Promise<void>`
|
545
554
|
|
546
|
-
|
555
|
+
---
|
547
556
|
|
548
557
|
### `showPopUp(content: HTMLElement, size?: "auto" | "full", useHeader?: boolean, onCloseCallback?: Function) => Promise<void>`
|
549
558
|
|
@@ -553,7 +562,7 @@ Exibe o conteúdo passado em um Popup.
|
|
553
562
|
|
554
563
|
Type: `Promise<void>`
|
555
564
|
|
556
|
-
|
565
|
+
---
|
557
566
|
|
558
567
|
### `showScrimApp(active: boolean) => Promise<void>`
|
559
568
|
|
@@ -563,7 +572,7 @@ Type: `Promise<void>`
|
|
563
572
|
|
564
573
|
Type: `Promise<void>`
|
565
574
|
|
566
|
-
|
575
|
+
---
|
567
576
|
|
568
577
|
### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
569
578
|
|
@@ -573,17 +582,17 @@ Exibe o diálogo de sucesso de acordo com os parâmetros passados.
|
|
573
582
|
|
574
583
|
Type: `Promise<boolean>`
|
575
584
|
|
576
|
-
|
585
|
+
---
|
577
586
|
|
578
587
|
### `temOpcional(opcional: string) => Promise<boolean>`
|
579
588
|
|
580
|
-
Verifica se a licença do cliente tem determinado opcional (produto)
|
589
|
+
Verifica se a licença do cliente tem determinado opcional (produto)
|
581
590
|
|
582
591
|
#### Returns
|
583
592
|
|
584
593
|
Type: `Promise<boolean>`
|
585
594
|
|
586
|
-
|
595
|
+
---
|
587
596
|
|
588
597
|
### `updateDataunitCache(oldName: string, dataUnitName: string, dataUnit: DataUnit) => Promise<void>`
|
589
598
|
|
@@ -593,7 +602,7 @@ Atualiza o cache de dataunits da aplicação.
|
|
593
602
|
|
594
603
|
Type: `Promise<void>`
|
595
604
|
|
596
|
-
|
605
|
+
---
|
597
606
|
|
598
607
|
### `webConnection(keyPort: string, methodName: string, params: IAppletCallerParams) => Promise<void>`
|
599
608
|
|
@@ -603,17 +612,17 @@ Realiza a chamada do WebConnection para realizar a exportação de arquivo.
|
|
603
612
|
|
604
613
|
Type: `Promise<void>`
|
605
614
|
|
606
|
-
|
615
|
+
---
|
607
616
|
|
608
617
|
### `whenApplicationReady() => Promise<SnkApplication>`
|
609
618
|
|
610
|
-
Retorna uma promise que
|
619
|
+
Retorna uma promise que sera resolvida quando o snk-application estiver carregado e registrado no ApplicationContext
|
611
620
|
|
612
621
|
#### Returns
|
613
622
|
|
614
623
|
Type: `Promise<SnkApplication>`
|
615
624
|
|
616
|
-
|
625
|
+
SnkApplication carregado.
|
617
626
|
|
618
627
|
|
619
628
|
## Dependencies
|
@@ -60,7 +60,7 @@ Registra um editor customizado para campos da grade e formulário.
|
|
60
60
|
|
61
61
|
Type: `Promise<void>`
|
62
62
|
|
63
|
-
|
63
|
+
---
|
64
64
|
|
65
65
|
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
66
66
|
|
@@ -70,7 +70,7 @@ Registra um formatador de valores para uma coluna da grid.
|
|
70
70
|
|
71
71
|
Type: `Promise<void>`
|
72
72
|
|
73
|
-
|
73
|
+
---
|
74
74
|
|
75
75
|
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
76
76
|
|
@@ -80,7 +80,7 @@ Registra um render customizado para colunas da grid.
|
|
80
80
|
|
81
81
|
Type: `Promise<void>`
|
82
82
|
|
83
|
-
|
83
|
+
---
|
84
84
|
|
85
85
|
### `closeConfigurator() => Promise<void>`
|
86
86
|
|
@@ -90,7 +90,7 @@ Usado para fechar o configurator do CRUD
|
|
90
90
|
|
91
91
|
Type: `Promise<void>`
|
92
92
|
|
93
|
-
|
93
|
+
---
|
94
94
|
|
95
95
|
### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
|
96
96
|
|
@@ -100,7 +100,7 @@ Retorna o elemento da filter-bar da grade.
|
|
100
100
|
|
101
101
|
Type: `Promise<HTMLSnkFilterBarElement>`
|
102
102
|
|
103
|
-
|
103
|
+
---
|
104
104
|
|
105
105
|
### `goToView(mode: string) => Promise<void>`
|
106
106
|
|
@@ -110,7 +110,7 @@ Usado para alternar a visão entre GRID e FORM externamente.
|
|
110
110
|
|
111
111
|
Type: `Promise<void>`
|
112
112
|
|
113
|
-
|
113
|
+
---
|
114
114
|
|
115
115
|
### `openConfigurator() => Promise<void>`
|
116
116
|
|
@@ -120,7 +120,7 @@ Usado para abrir o configurator do CRUD
|
|
120
120
|
|
121
121
|
Type: `Promise<void>`
|
122
122
|
|
123
|
-
|
123
|
+
---
|
124
124
|
|
125
125
|
### `reloadFilterBar() => Promise<void>`
|
126
126
|
|
@@ -130,7 +130,7 @@ Faz o recarregamento da filter-bar do crud, buscando o state no servidor.
|
|
130
130
|
|
131
131
|
Type: `Promise<void>`
|
132
132
|
|
133
|
-
|
133
|
+
---
|
134
134
|
|
135
135
|
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
136
136
|
|
@@ -140,7 +140,7 @@ Remove o formatador de valores de uma coluna da grid.
|
|
140
140
|
|
141
141
|
Type: `Promise<void>`
|
142
142
|
|
143
|
-
|
143
|
+
---
|
144
144
|
|
145
145
|
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
146
146
|
|
@@ -49,7 +49,7 @@ Registra um editor customizado para campos da grade e formulário
|
|
49
49
|
|
50
50
|
Type: `Promise<void>`
|
51
51
|
|
52
|
-
|
52
|
+
---
|
53
53
|
|
54
54
|
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
55
55
|
|
@@ -59,7 +59,7 @@ Registra um render customizado para colunas da grid.
|
|
59
59
|
|
60
60
|
Type: `Promise<void>`
|
61
61
|
|
62
|
-
|
62
|
+
---
|
63
63
|
|
64
64
|
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
65
65
|
|
@@ -69,7 +69,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
|
|
69
69
|
|
70
70
|
Type: `Promise<void>`
|
71
71
|
|
72
|
-
|
72
|
+
---
|
73
73
|
|
74
74
|
### `setFocus() => Promise<void>`
|
75
75
|
|
@@ -79,7 +79,7 @@ Atribui o foco para o componente.
|
|
79
79
|
|
80
80
|
Type: `Promise<void>`
|
81
81
|
|
82
|
-
|
82
|
+
---
|
83
83
|
|
84
84
|
### `showFormConfig(detail?: boolean) => Promise<void>`
|
85
85
|
|
@@ -46,7 +46,7 @@ Registra um editor customizado para campos da grade e formulário.
|
|
46
46
|
|
47
47
|
Type: `Promise<void>`
|
48
48
|
|
49
|
-
|
49
|
+
---
|
50
50
|
|
51
51
|
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
52
52
|
|
@@ -56,7 +56,7 @@ Registra um render customizado para colunas da grid.
|
|
56
56
|
|
57
57
|
Type: `Promise<void>`
|
58
58
|
|
59
|
-
|
59
|
+
---
|
60
60
|
|
61
61
|
### `changeViewMode(mode: VIEW_MODE) => Promise<void>`
|
62
62
|
|
@@ -66,7 +66,7 @@ Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FOR
|
|
66
66
|
|
67
67
|
Type: `Promise<void>`
|
68
68
|
|
69
|
-
|
69
|
+
---
|
70
70
|
|
71
71
|
### `configGrid() => Promise<void>`
|
72
72
|
|
@@ -76,7 +76,7 @@ Abre o configurador de grid.
|
|
76
76
|
|
77
77
|
Type: `Promise<void>`
|
78
78
|
|
79
|
-
|
79
|
+
---
|
80
80
|
|
81
81
|
### `showUp() => Promise<void>`
|
82
82
|
|
@@ -46,7 +46,7 @@ Obtém o dataUnit.
|
|
46
46
|
|
47
47
|
Type: `Promise<DataUnit>`
|
48
48
|
|
49
|
-
|
49
|
+
---
|
50
50
|
|
51
51
|
### `getFieldsWithRmPrecision() => Promise<string[]>`
|
52
52
|
|
@@ -56,7 +56,7 @@ Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precisi
|
|
56
56
|
|
57
57
|
Type: `Promise<string[]>`
|
58
58
|
|
59
|
-
|
59
|
+
---
|
60
60
|
|
61
61
|
### `getFieldsWithRmp() => Promise<string[]>`
|
62
62
|
|
@@ -66,7 +66,7 @@ Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
|
|
66
66
|
|
67
67
|
Type: `Promise<string[]>`
|
68
68
|
|
69
|
-
|
69
|
+
---
|
70
70
|
|
71
71
|
### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
|
72
72
|
|
@@ -76,7 +76,7 @@ Busca os metadados da linha selecionada.
|
|
76
76
|
|
77
77
|
Type: `Promise<RowMetadata>`
|
78
78
|
|
79
|
-
|
79
|
+
---
|
80
80
|
|
81
81
|
### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
|
82
82
|
|
@@ -41,7 +41,7 @@ Adiciona um item de filtro.
|
|
41
41
|
|
42
42
|
Type: `Promise<void>`
|
43
43
|
|
44
|
-
|
44
|
+
---
|
45
45
|
|
46
46
|
### `getFilterItem(id: string) => Promise<SnkFilterItemConfig | undefined>`
|
47
47
|
|
@@ -51,7 +51,7 @@ Retorna um item de filtro pelo ID.
|
|
51
51
|
|
52
52
|
Type: `Promise<SnkFilterItemConfig>`
|
53
53
|
|
54
|
-
|
54
|
+
---
|
55
55
|
|
56
56
|
### `reload() => Promise<void>`
|
57
57
|
|
@@ -61,7 +61,7 @@ Faz o recarregamento da filterbar buscando o state no servidor.
|
|
61
61
|
|
62
62
|
Type: `Promise<void>`
|
63
63
|
|
64
|
-
|
64
|
+
---
|
65
65
|
|
66
66
|
### `removeFilterItem(filterID: string) => Promise<SnkFilterItemConfig | undefined>`
|
67
67
|
|
@@ -73,6 +73,8 @@ Type: `Promise<SnkFilterItemConfig>`
|
|
73
73
|
|
74
74
|
- Retorna o item de filtro removido, ou undefined caso não encontrado.
|
75
75
|
|
76
|
+
---
|
77
|
+
|
76
78
|
### `showFilterModal() => Promise<void>`
|
77
79
|
|
78
80
|
Abre o modal de filtros
|
@@ -81,7 +83,7 @@ Abre o modal de filtros
|
|
81
83
|
|
82
84
|
Type: `Promise<void>`
|
83
85
|
|
84
|
-
|
86
|
+
---
|
85
87
|
|
86
88
|
### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
|
87
89
|
|
@@ -10,7 +10,7 @@
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
11
11
|
| ---------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
12
12
|
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
|
13
|
-
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração
|
13
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário. | `string` | `undefined` |
|
14
14
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
15
15
|
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
16
16
|
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
@@ -18,24 +18,24 @@
|
|
18
18
|
|
19
19
|
## Events
|
20
20
|
|
21
|
-
| Event | Description
|
22
|
-
| ---------------- |
|
23
|
-
| `actionClick` |
|
24
|
-
| `exit` |
|
25
|
-
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
21
|
+
| Event | Description | Type |
|
22
|
+
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
|
23
|
+
| `actionClick` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<string>` |
|
24
|
+
| `exit` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<void>` |
|
25
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view | `CustomEvent<HTMLElement[]>` |
|
26
26
|
|
27
27
|
|
28
28
|
## Methods
|
29
29
|
|
30
30
|
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
31
31
|
|
32
|
-
Registra um editor customizado para campos
|
32
|
+
Registra um editor customizado para campos do formulário.
|
33
33
|
|
34
34
|
#### Returns
|
35
35
|
|
36
36
|
Type: `Promise<void>`
|
37
37
|
|
38
|
-
|
38
|
+
---
|
39
39
|
|
40
40
|
### `hideConfig() => Promise<void>`
|
41
41
|
|
@@ -45,7 +45,7 @@ Fecha a janela de configurações do formulário.
|
|
45
45
|
|
46
46
|
Type: `Promise<void>`
|
47
47
|
|
48
|
-
|
48
|
+
---
|
49
49
|
|
50
50
|
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
51
51
|
|
@@ -55,7 +55,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
|
|
55
55
|
|
56
56
|
Type: `Promise<void>`
|
57
57
|
|
58
|
-
|
58
|
+
---
|
59
59
|
|
60
60
|
### `showConfig() => Promise<void>`
|
61
61
|
|
@@ -65,6 +65,16 @@ Exibe a janela de configurações do formulário.
|
|
65
65
|
|
66
66
|
Type: `Promise<void>`
|
67
67
|
|
68
|
+
---
|
69
|
+
|
70
|
+
### `validate() => Promise<void>`
|
71
|
+
|
72
|
+
Valida o formulário.
|
73
|
+
|
74
|
+
#### Returns
|
75
|
+
|
76
|
+
Type: `Promise<void>`
|
77
|
+
|
68
78
|
|
69
79
|
|
70
80
|
|
@@ -64,7 +64,7 @@ Registra um editor customizado para campos da grade e formulário
|
|
64
64
|
|
65
65
|
Type: `Promise<void>`
|
66
66
|
|
67
|
-
|
67
|
+
---
|
68
68
|
|
69
69
|
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
70
70
|
|
@@ -74,7 +74,7 @@ Registra um formatador de valores para uma coluna da grid.
|
|
74
74
|
|
75
75
|
Type: `Promise<void>`
|
76
76
|
|
77
|
-
|
77
|
+
---
|
78
78
|
|
79
79
|
### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
|
80
80
|
|
@@ -84,7 +84,7 @@ Registra um render customizado para colunas da grid.
|
|
84
84
|
|
85
85
|
Type: `Promise<void>`
|
86
86
|
|
87
|
-
|
87
|
+
---
|
88
88
|
|
89
89
|
### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
|
90
90
|
|
@@ -94,7 +94,7 @@ Retorna o elemento da filter-bar da grade.
|
|
94
94
|
|
95
95
|
Type: `Promise<HTMLSnkFilterBarElement>`
|
96
96
|
|
97
|
-
|
97
|
+
---
|
98
98
|
|
99
99
|
### `hideConfig() => Promise<void>`
|
100
100
|
|
@@ -104,7 +104,7 @@ Fecha a janela de configurações da grade.
|
|
104
104
|
|
105
105
|
Type: `Promise<void>`
|
106
106
|
|
107
|
-
|
107
|
+
---
|
108
108
|
|
109
109
|
### `reloadConfig() => Promise<void>`
|
110
110
|
|
@@ -114,7 +114,7 @@ Type: `Promise<void>`
|
|
114
114
|
|
115
115
|
Type: `Promise<void>`
|
116
116
|
|
117
|
-
|
117
|
+
---
|
118
118
|
|
119
119
|
### `reloadFilterBar() => Promise<void>`
|
120
120
|
|
@@ -124,7 +124,7 @@ Faz o recarregamento da filter-bar da grade buscando o state no servidor.
|
|
124
124
|
|
125
125
|
Type: `Promise<void>`
|
126
126
|
|
127
|
-
|
127
|
+
---
|
128
128
|
|
129
129
|
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
130
130
|
|
@@ -134,7 +134,7 @@ Remove o formatador de valores de uma coluna da grid.
|
|
134
134
|
|
135
135
|
Type: `Promise<void>`
|
136
136
|
|
137
|
-
|
137
|
+
---
|
138
138
|
|
139
139
|
### `setConfig(config: IGridConfig) => Promise<void>`
|
140
140
|
|
@@ -144,7 +144,7 @@ Atribui o valor da configuração da grade.
|
|
144
144
|
|
145
145
|
Type: `Promise<void>`
|
146
146
|
|
147
|
-
|
147
|
+
---
|
148
148
|
|
149
149
|
### `setFocus() => Promise<void>`
|
150
150
|
|
@@ -154,7 +154,7 @@ Atribui o foco para a grade.
|
|
154
154
|
|
155
155
|
Type: `Promise<void>`
|
156
156
|
|
157
|
-
|
157
|
+
---
|
158
158
|
|
159
159
|
### `showConfig() => Promise<void>`
|
160
160
|
|
@@ -63,7 +63,7 @@ Registra um editor customizado para campos da grade e formulário.
|
|
63
63
|
|
64
64
|
Type: `Promise<void>`
|
65
65
|
|
66
|
-
|
66
|
+
---
|
67
67
|
|
68
68
|
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
69
69
|
|
@@ -73,7 +73,7 @@ Registra um formatador de valores para uma coluna da grid.
|
|
73
73
|
|
74
74
|
Type: `Promise<void>`
|
75
75
|
|
76
|
-
|
76
|
+
---
|
77
77
|
|
78
78
|
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
79
79
|
|
@@ -83,7 +83,7 @@ Registra um render customizado para colunas da grid.
|
|
83
83
|
|
84
84
|
Type: `Promise<void>`
|
85
85
|
|
86
|
-
|
86
|
+
---
|
87
87
|
|
88
88
|
### `closeConfigurator() => Promise<void>`
|
89
89
|
|
@@ -93,7 +93,7 @@ Usado para fechar o configurator do CRUD
|
|
93
93
|
|
94
94
|
Type: `Promise<void>`
|
95
95
|
|
96
|
-
|
96
|
+
---
|
97
97
|
|
98
98
|
### `getRecords() => Promise<Array<Record>>`
|
99
99
|
|
@@ -103,7 +103,7 @@ Type: `Promise<void>`
|
|
103
103
|
|
104
104
|
Type: `Promise<Record[]>`
|
105
105
|
|
106
|
-
|
106
|
+
---
|
107
107
|
|
108
108
|
### `goToView(view: VIEW_MODE) => Promise<void>`
|
109
109
|
|
@@ -113,7 +113,7 @@ Usado para alternar a visão entre GRID e FORM externamente.
|
|
113
113
|
|
114
114
|
Type: `Promise<void>`
|
115
115
|
|
116
|
-
|
116
|
+
---
|
117
117
|
|
118
118
|
### `openConfigurator() => Promise<void>`
|
119
119
|
|
@@ -123,7 +123,7 @@ Usado para abrir o configurator do CRUD
|
|
123
123
|
|
124
124
|
Type: `Promise<void>`
|
125
125
|
|
126
|
-
|
126
|
+
---
|
127
127
|
|
128
128
|
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
129
129
|
|
@@ -133,7 +133,7 @@ Remove o formatador de valores de uma coluna da grid.
|
|
133
133
|
|
134
134
|
Type: `Promise<void>`
|
135
135
|
|
136
|
-
|
136
|
+
---
|
137
137
|
|
138
138
|
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
139
139
|
|
@@ -143,7 +143,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
|
|
143
143
|
|
144
144
|
Type: `Promise<void>`
|
145
145
|
|
146
|
-
|
146
|
+
---
|
147
147
|
|
148
148
|
### `setMetadata(metadata: UnitMetadata) => Promise<void>`
|
149
149
|
|
@@ -153,7 +153,7 @@ Type: `Promise<void>`
|
|
153
153
|
|
154
154
|
Type: `Promise<void>`
|
155
155
|
|
156
|
-
|
156
|
+
---
|
157
157
|
|
158
158
|
### `setRecords(records: Array<Record>) => Promise<void>`
|
159
159
|
|
@@ -163,7 +163,7 @@ Type: `Promise<void>`
|
|
163
163
|
|
164
164
|
Type: `Promise<void>`
|
165
165
|
|
166
|
-
|
166
|
+
---
|
167
167
|
|
168
168
|
### `updateConfig() => Promise<void>`
|
169
169
|
|
@@ -33,7 +33,7 @@ Esaconde a lista de ações.
|
|
33
33
|
|
34
34
|
Type: `Promise<void>`
|
35
35
|
|
36
|
-
|
36
|
+
---
|
37
37
|
|
38
38
|
### `isOpened() => Promise<boolean>`
|
39
39
|
|
@@ -43,7 +43,7 @@ Informa se a lista de ações está aberta.
|
|
43
43
|
|
44
44
|
Type: `Promise<boolean>`
|
45
45
|
|
46
|
-
|
46
|
+
---
|
47
47
|
|
48
48
|
### `showActions() => Promise<void>`
|
49
49
|
|
@@ -7,32 +7,32 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description
|
11
|
-
| --------------------- | --------------------- |
|
12
|
-
| `actionsList` | -- |
|
13
|
-
| `actionsSettingsList` | -- |
|
14
|
-
| `alignRigth` | `align-rigth` |
|
15
|
-
| `buttons` | `buttons` |
|
16
|
-
| `configName` | `config-name` |
|
17
|
-
| `customButtons` | -- |
|
18
|
-
| `customContainerId` | `custom-container-id` |
|
19
|
-
| `customSlotId` | `custom-slot-id` |
|
20
|
-
| `dataUnit` | -- |
|
21
|
-
| `disabledButtons` | -- |
|
22
|
-
| `messagesBuilder` | -- |
|
23
|
-
| `overflowStrategy` | `overflow-strategy` |
|
24
|
-
| `presentationMode` | `presentation-mode` |
|
25
|
-
| `primaryButton` | `primary-button` |
|
26
|
-
| `resourceID` | `resource-i-d` |
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| --------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | --------------------------- |
|
12
|
+
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
13
|
+
| `actionsSettingsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
14
|
+
| `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
|
15
|
+
| `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
|
16
|
+
| `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
|
17
|
+
| `customButtons` | -- | Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer. | `Map<string, CustomButton>` | `undefined` |
|
18
|
+
| `customContainerId` | `custom-container-id` | Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados que não podem ser passados por slot. Exemplo: Elementos customizados na Taskbar da aba de detalhes. | `string` | `undefined` |
|
19
|
+
| `customSlotId` | `custom-slot-id` | Usado para determinar o identificador do slot que recebe elementos personalizados. | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
|
20
|
+
| `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
|
21
|
+
| `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
|
22
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
23
|
+
| `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
|
24
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
25
|
+
| `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
|
26
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
27
27
|
|
28
28
|
|
29
29
|
## Events
|
30
30
|
|
31
|
-
| Event | Description
|
32
|
-
| --------------------- |
|
33
|
-
| `actionClick` |
|
34
|
-
| `taskbarSaveLocker` |
|
35
|
-
| `taskbarSaveUnlocker` |
|
31
|
+
| Event | Description | Type |
|
32
|
+
| --------------------- | ------------------------------------------------------------ | --------------------- |
|
33
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
34
|
+
| `taskbarSaveLocker` | Emitido sempre que um save é iniciado pela taskbar. | `CustomEvent<void>` |
|
35
|
+
| `taskbarSaveUnlocker` | Emitido sempre que o ocorre alguma action que libera o save. | `CustomEvent<void>` |
|
36
36
|
|
37
37
|
|
38
38
|
## Dependencies
|