@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-kb-106013.1 → 0.0.0-hotfix-ga-kb-106183.0

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 (16) hide show
  1. package/components/snk-application/readme.md +61 -53
  2. package/components/snk-configurator/readme.md +1 -1
  3. package/components/snk-crud/readme.md +9 -9
  4. package/components/snk-crud/subcomponents/readme.md +4 -4
  5. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +4 -4
  6. package/components/snk-data-exporter/exporter-email-sender/readme.md +1 -1
  7. package/components/snk-data-unit/readme.md +4 -4
  8. package/components/snk-filter-bar/filter-item/readme.md +1 -1
  9. package/components/snk-filter-bar/readme.md +6 -4
  10. package/components/snk-filter-field-search/readme.md +1 -1
  11. package/components/snk-form/readme.md +10 -26
  12. package/components/snk-grid/readme.md +69 -51
  13. package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md +1 -1
  14. package/components/snk-simple-crud/readme.md +11 -11
  15. package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +2 -2
  16. package/package.json +1 -1
package/components/snk-application/readme.md CHANGED
@@ -35,7 +35,7 @@ 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
 
@@ -45,7 +45,7 @@ Type: `Promise<void>`
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,7 +55,7 @@ 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
 
@@ -65,7 +65,7 @@ Adiciona um listener no fetcher de Pesquisa
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 @@ Type: `Promise<any>`
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,7 +115,7 @@ 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
 
@@ -125,7 +125,7 @@ Exibe um diálogo de confirmação
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,7 +146,7 @@ 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
150
 
151
151
  ### `executePreparedSearch(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
152
152
 
@@ -157,7 +157,7 @@ Ex.: snk-config-options
157
157
 
158
158
  Type: `Promise<IOption | IOption[]>`
159
159
 
160
-
160
+ ---
161
161
 
162
162
  ### `executePreparedSearchPlus(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
163
163
 
@@ -168,7 +168,7 @@ Ex.: snk-config-options
168
168
 
169
169
  Type: `Promise<IOption | IOption[]>`
170
170
 
171
-
171
+ ---
172
172
 
173
173
  ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption> | IOption>`
174
174
 
@@ -179,7 +179,7 @@ Ex.: snk-config-options
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,7 +191,7 @@ coluna.
191
191
 
192
192
  Type: `Promise<any[]>`
193
193
 
194
-
194
+ ---
195
195
 
196
196
  ### `getAllAccess(resourceID?: string) => Promise<any>`
197
197
 
@@ -201,7 +201,7 @@ Obtém todos os acessos do usuário logado.
201
201
 
202
202
  Type: `Promise<any>`
203
203
 
204
-
204
+ ---
205
205
 
206
206
  ### `getAppLabel() => Promise<string>`
207
207
 
@@ -211,7 +211,7 @@ Obtém o nome das telas da aplicação
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,7 +241,7 @@ 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
 
@@ -251,7 +251,7 @@ Obtém a configuração de um recurso por service broker
251
251
 
252
252
  Type: `Promise<any>`
253
253
 
254
-
254
+ ---
255
255
 
256
256
  ### `getDataFetcher() => Promise<DataFetcher>`
257
257
 
@@ -263,6 +263,8 @@ Type: `Promise<DataFetcher>`
263
263
 
264
264
  DataFetcher do application
265
265
 
266
+ ---
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.
@@ -271,7 +273,7 @@ Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
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
 
@@ -313,6 +315,8 @@ Type: `Promise<KeyboardManager>`
313
315
 
314
316
  the keyboard manager
315
317
 
318
+ ---
319
+
316
320
  ### `getLayoutFormConfig() => Promise<LayoutFormConfig>`
317
321
 
318
322
  Obtém o notificador de Layout de formulario.
@@ -323,6 +327,8 @@ Type: `Promise<LayoutFormConfig>`
323
327
 
324
328
  the Configurador de Layout do Formulario
325
329
 
330
+ ---
331
+
326
332
  ### `getResourceID() => Promise<string>`
327
333
 
328
334
  Obtém o resourceID da tela em questão.
@@ -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,7 +347,7 @@ 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
 
@@ -351,7 +357,7 @@ Obtém o UserId da tela em questão.
351
357
 
352
358
  Type: `Promise<string>`
353
359
 
354
-
360
+ ---
355
361
 
356
362
  ### `hasAccess(access: AutorizationType, resourceID?: string) => Promise<boolean>`
357
363
 
@@ -361,7 +367,7 @@ Obtém `true` caso o usuário logado tem permissão pra determinada ação.
361
367
 
362
368
  Type: `Promise<boolean>`
363
369
 
364
-
370
+ ---
365
371
 
366
372
  ### `hasClientEvent(eventID: String) => Promise<boolean>`
367
373
 
@@ -371,7 +377,7 @@ Verfica se um client event está registrado no DataFetcher da aplicação.
371
377
 
372
378
  Type: `Promise<boolean>`
373
379
 
374
-
380
+ ---
375
381
 
376
382
  ### `importScript(relativePath: string | Array<string>) => Promise<void>`
377
383
 
@@ -381,7 +387,7 @@ Realiza o import de um JavaScript que está disponivel dentro da pasta /public d
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,7 +397,7 @@ 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
 
@@ -401,7 +407,7 @@ Type: `Promise<void>`
401
407
 
402
408
  Type: `Promise<void>`
403
409
 
404
-
410
+ ---
405
411
 
406
412
  ### `isDebugMode() => Promise<boolean>`
407
413
 
@@ -411,7 +417,7 @@ 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
 
@@ -423,6 +429,8 @@ Type: `Promise<boolean>`
423
429
 
424
430
  boolean
425
431
 
432
+ ---
433
+
426
434
  ### `isUserSup() => Promise<boolean>`
427
435
 
428
436
  Obtém `true` caso o usuário logado seja o SUP.
@@ -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,7 +449,7 @@ 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
 
@@ -451,7 +459,7 @@ Type: `Promise<Map<string, number>>`
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
 
@@ -461,7 +469,7 @@ Exibe um diálogo de mensagem comum
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,7 +490,7 @@ 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
 
@@ -492,7 +500,7 @@ Remove um client event para o DataFetcher da aplicação.
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 @@ Type: `Promise<any>`
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,7 +530,7 @@ 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
 
@@ -534,7 +542,7 @@ de processamentos em lote.
534
542
 
535
543
  Type: `Promise<void>`
536
544
 
537
-
545
+ ---
538
546
 
539
547
  ### `showModal(content: HTMLElement) => Promise<void>`
540
548
 
@@ -544,7 +552,7 @@ Exibe o conteúdo passado em um Modal.
544
552
 
545
553
  Type: `Promise<void>`
546
554
 
547
-
555
+ ---
548
556
 
549
557
  ### `showPopUp(content: HTMLElement, size?: "auto" | "full", useHeader?: boolean, onCloseCallback?: Function) => Promise<void>`
550
558
 
@@ -554,7 +562,7 @@ Exibe o conteúdo passado em um Popup.
554
562
 
555
563
  Type: `Promise<void>`
556
564
 
557
-
565
+ ---
558
566
 
559
567
  ### `showScrimApp(active: boolean) => Promise<void>`
560
568
 
@@ -564,7 +572,7 @@ Type: `Promise<void>`
564
572
 
565
573
  Type: `Promise<void>`
566
574
 
567
-
575
+ ---
568
576
 
569
577
  ### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
570
578
 
@@ -574,7 +582,7 @@ Exibe o diálogo de sucesso de acordo com os parâmetros passados.
574
582
 
575
583
  Type: `Promise<boolean>`
576
584
 
577
-
585
+ ---
578
586
 
579
587
  ### `temOpcional(opcional: string) => Promise<boolean>`
580
588
 
@@ -584,7 +592,7 @@ Verifica se a licença do cliente tem determinado opcional (produto)
584
592
 
585
593
  Type: `Promise<boolean>`
586
594
 
587
-
595
+ ---
588
596
 
589
597
  ### `updateDataunitCache(oldName: string, dataUnitName: string, dataUnit: DataUnit) => Promise<void>`
590
598
 
@@ -594,7 +602,7 @@ Atualiza o cache de dataunits da aplicação.
594
602
 
595
603
  Type: `Promise<void>`
596
604
 
597
-
605
+ ---
598
606
 
599
607
  ### `webConnection(keyPort: string, methodName: string, params: IAppletCallerParams) => Promise<void>`
600
608
 
@@ -604,7 +612,7 @@ Realiza a chamada do WebConnection para realizar a exportação de arquivo.
604
612
 
605
613
  Type: `Promise<void>`
606
614
 
607
-
615
+ ---
608
616
 
609
617
  ### `whenApplicationReady() => Promise<SnkApplication>`
610
618
 
package/components/snk-configurator/readme.md CHANGED
@@ -38,7 +38,7 @@ Fecha a janela de configuração.
38
38
 
39
39
  Type: `Promise<void>`
40
40
 
41
-
41
+ ---
42
42
 
43
43
  ### `open() => Promise<void>`
44
44
 
package/components/snk-crud/readme.md CHANGED
@@ -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
 
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -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
 
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -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
 
package/components/snk-data-exporter/exporter-email-sender/readme.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  Type: `Promise<IExportResult>`
24
24
 
25
-
25
+ ---
26
26
 
27
27
  ### `open(config: IExportConfig) => Promise<IExportResult>`
28
28
 
package/components/snk-data-unit/readme.md CHANGED
@@ -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
 
package/components/snk-filter-bar/filter-item/readme.md CHANGED
@@ -32,7 +32,7 @@ Oculta os detalhes de um item da lista.
32
32
 
33
33
  Type: `Promise<void>`
34
34
 
35
-
35
+ ---
36
36
 
37
37
  ### `showUp(open?: boolean) => Promise<void>`
38
38
 
package/components/snk-filter-bar/readme.md CHANGED
@@ -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
 
package/components/snk-filter-field-search/readme.md CHANGED
@@ -30,7 +30,7 @@ Filtra a fonte de dados do componente.
30
30
 
31
31
  Type: `Promise<void>`
32
32
 
33
-
33
+ ---
34
34
 
35
35
  ### `show(element?: HTMLElement, options?: IEzPopoverAnchorOptions) => Promise<void>`
36
36
 
package/components/snk-form/readme.md CHANGED
@@ -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 legada do formulário. | `string` | `undefined` |
13
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado 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,30 +18,24 @@
18
18
 
19
19
  ## Events
20
20
 
21
- | Event | Description | Type |
22
- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
23
- | `actionClick` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
24
-
25
- | `CustomEvent<string>` |
26
- | `exit` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
27
-
28
- | `CustomEvent<void>` |
29
- | `formItemsReady` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
30
-
31
- | `CustomEvent<HTMLElement[]>` |
21
+ | Event | Description | Type |
22
+ | ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
23
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
24
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
25
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
32
26
 
33
27
 
34
28
  ## Methods
35
29
 
36
30
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
37
31
 
38
- Registra um editor customizado para campos do formulário.
32
+ Registra um editor customizado para campos da grade e formulário.
39
33
 
40
34
  #### Returns
41
35
 
42
36
  Type: `Promise<void>`
43
37
 
44
-
38
+ ---
45
39
 
46
40
  ### `hideConfig() => Promise<void>`
47
41
 
@@ -51,7 +45,7 @@ Fecha a janela de configurações do formulário.
51
45
 
52
46
  Type: `Promise<void>`
53
47
 
54
-
48
+ ---
55
49
 
56
50
  ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
57
51
 
@@ -61,7 +55,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
61
55
 
62
56
  Type: `Promise<void>`
63
57
 
64
-
58
+ ---
65
59
 
66
60
  ### `showConfig() => Promise<void>`
67
61
 
@@ -73,16 +67,6 @@ Type: `Promise<void>`
73
67
 
74
68
 
75
69
 
76
- ### `validate() => Promise<void>`
77
-
78
- Valida o formulário.
79
-
80
- #### Returns
81
-
82
- Type: `Promise<void>`
83
-
84
-
85
-
86
70
 
87
71
  ## Dependencies
88
72
 
package/components/snk-grid/readme.md CHANGED
@@ -7,94 +7,102 @@
7
7
 
8
8
  ## Properties
9
9
 
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
- | `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
14
- | `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
15
- | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
16
- | `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
17
- | `compact` | `compact` | Define se a grade deve ser exibida em modo compacto | `boolean` | `undefined` |
18
- | `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
19
- | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
20
- | `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
21
- | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
22
- | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
23
- | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
24
- | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
25
- | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
26
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
27
- | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
28
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
29
- | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
30
- | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
31
- | `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
32
- | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
33
- | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
34
- | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
35
- | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
36
- | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
37
- | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
38
- | `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
39
- | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de chechbox deve ser suprimida | `boolean` | `undefined` |
40
- | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir o scroll horizontal. | `boolean` | `false` |
41
- | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
42
- | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
43
- | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
44
- | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
45
- | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F | `boolean` | `true` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------- |
12
+ | `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`. | `Action[]` | `undefined` |
13
+ | `autoFocus` | `auto-focus` | Define se a grade receberá o foco automaticamente ao ser carregada. | `boolean` | `true` |
14
+ | `autoLoad` | `auto-load` | Define se os dados serão carregados automaticamente na inicialização do componente. | `boolean` | `undefined` |
15
+ | `canEdit` | `can-edit` | Define se a edição de dados na grade está habilitada. | `boolean` | `true` |
16
+ | `columnFilterDataSource` | -- | Define o data source para o filtro de colunas. | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
17
+ | `compact` | `compact` | Define se a grade deve ser exibida em modo compacto. | `boolean` | `undefined` |
18
+ | `configName` | `config-name` | Nome usado para salvar e recuperar a configuração da grade. | `string` | `undefined` |
19
+ | `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros) e no modal lateral de filtros (contêiner de filtros personalizados). | `boolean` | `undefined` |
20
+ | `enableGridInsert` | `enable-grid-insert` | Habilita a inserção de registros diretamente na grade. | `boolean` | `false` |
21
+ | `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean` | `false` |
22
+ | `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
23
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legada da barra de filtros. | `string` | `undefined` |
24
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros. | `string` | `undefined` |
25
+ | `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
26
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade. | `string` | `undefined` |
27
+ | `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe de outra tela. | `boolean` | `undefined` |
28
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
29
+ | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultaneamente. | `boolean` | `true` |
30
+ | `multipleSelection` | `multiple-selection` | Determina se a seleção de múltiplas linhas é permitida. | `boolean` | `undefined` |
31
+ | `outlineMode` | `outline-mode` | Altera a aparência das bordas e sombras do componente. Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout). Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up). | `boolean` | `false` |
32
+ | `paginationCounterMode` | `pagination-counter-mode` | Define o modo de exibição do contador de paginação. | `"auto" \| "hidden" \| "show"` | `'auto'` |
33
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do `snk-taskbar`. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
34
+ | `recordsValidator` | -- | Validador responsável por verificar a integridade dos dados de um registro. | `IRecordValidator` | `undefined` |
35
+ | `resourceID` | `resource-i-d` | Identificador de recursos, como configurações e permissões de acesso. | `string` | `undefined` |
36
+ | `selectionToastConfig` | -- | Configuração do toast de seleção da grade. | `ISelectionToastConfig` | `undefined` |
37
+ | `statusResolver` | -- | Define a configuração de cores para a coluna de status. | `((data: object) => string) \| IStatusResolver` | `undefined` |
38
+ | `strategyExporter` | `strategy-exporter` | Define o modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
39
+ | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de checkbox deve ser suprimida. | `boolean` | `undefined` |
40
+ | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir a barra de rolagem horizontal. | `boolean` | `false` |
41
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do contêiner de elementos customizados da `Taskbar`. | `string` | `undefined` |
42
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
43
+ | `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Define o nome do slot para elementos customizados na `Taskbar` principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
44
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando `true`, a tecla ENTER navega entre as células como a tecla TAB. | `boolean` | `false` |
45
+ | `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`. | `boolean` | `true` |
46
46
 
47
47
 
48
48
  ## Events
49
49
 
50
- | Event | Description | Type |
51
- | ----------------- | ------------------------------------------------------------ | --------------------- |
52
- | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
53
- | `componentReady` | Emitido quando o componente estiver completamente carregado. | `CustomEvent<void>` |
54
- | `gridDoubleClick` | Emitido sempre que houver duplo click na grade. | `CustomEvent<any>` |
50
+ | Event | Description | Type |
51
+ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
52
+ | `actionClick` | Emitido ao clicar em um botão de ação ou item de menu. | `CustomEvent<string>` |
53
+ | `componentReady` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<void>` |
54
+ | `gridDoubleClick` | Emitido ao realizar um duplo clique em uma linha da grade. | `CustomEvent<any>` |
55
55
 
56
56
 
57
57
  ## Methods
58
58
 
59
59
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
60
60
 
61
- Registra um editor customizado para campos da grade e formulário
61
+ Registra um editor customizado para um campo da grade ou formulário.
62
62
 
63
63
  #### Returns
64
64
 
65
65
  Type: `Promise<void>`
66
66
 
67
+ Uma promessa que é resolvida quando o editor é registrado.
67
68
 
69
+ ---
68
70
 
69
71
  ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
70
72
 
71
- Registra um formatador de valores para uma coluna da grid.
73
+ Registra um formatador de valor customizado para uma coluna da grade.
72
74
 
73
75
  #### Returns
74
76
 
75
77
  Type: `Promise<void>`
76
78
 
79
+ Uma promessa que é resolvida quando o formatador é registrado.
77
80
 
81
+ ---
78
82
 
79
83
  ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
80
84
 
81
- Registra um render customizado para colunas da grid.
85
+ Registra um renderizador customizado para uma coluna da grade.
82
86
 
83
87
  #### Returns
84
88
 
85
89
  Type: `Promise<void>`
86
90
 
91
+ Uma promessa que é resolvida quando o renderizador é registrado.
87
92
 
93
+ ---
88
94
 
89
95
  ### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
90
96
 
91
- Retorna o elemento da filter-bar da grade.
97
+ Retorna o elemento da barra de filtros da grade.
92
98
 
93
99
  #### Returns
94
100
 
95
101
  Type: `Promise<HTMLSnkFilterBarElement>`
96
102
 
103
+ O elemento da barra de filtros.
97
104
 
105
+ ---
98
106
 
99
107
  ### `hideConfig() => Promise<void>`
100
108
 
@@ -104,47 +112,55 @@ Fecha a janela de configurações da grade.
104
112
 
105
113
  Type: `Promise<void>`
106
114
 
115
+ Uma promessa que é resolvida quando a janela de configuração é fechada.
107
116
 
117
+ ---
108
118
 
109
119
  ### `reloadConfig() => Promise<void>`
110
120
 
111
-
121
+ Recarrega a configuração da grade.
112
122
 
113
123
  #### Returns
114
124
 
115
125
  Type: `Promise<void>`
116
126
 
117
-
127
+ ---
118
128
 
119
129
  ### `reloadFilterBar() => Promise<void>`
120
130
 
121
- Faz o recarregamento da filter-bar da grade buscando o state no servidor.
131
+ Recarrega a barra de filtros da grade, buscando o estado do servidor.
122
132
 
123
133
  #### Returns
124
134
 
125
135
  Type: `Promise<void>`
126
136
 
137
+ Uma promessa que é resolvida quando a barra de filtros é recarregada.
127
138
 
139
+ ---
128
140
 
129
141
  ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
130
142
 
131
- Remove o formatador de valores de uma coluna da grid.
143
+ Remove um formatador de valor customizado de uma coluna da grade.
132
144
 
133
145
  #### Returns
134
146
 
135
147
  Type: `Promise<void>`
136
148
 
149
+ Uma promessa que é resolvida quando o formatador é removido.
137
150
 
151
+ ---
138
152
 
139
153
  ### `setConfig(config: IGridConfig) => Promise<void>`
140
154
 
141
- Atribui o valor da configuração da grade.
155
+ Define a configuração da grade.
142
156
 
143
157
  #### Returns
144
158
 
145
159
  Type: `Promise<void>`
146
160
 
161
+ Uma promessa que é resolvida quando a configuração é aplicada.
147
162
 
163
+ ---
148
164
 
149
165
  ### `setFocus() => Promise<void>`
150
166
 
@@ -154,7 +170,9 @@ Atribui o foco para a grade.
154
170
 
155
171
  Type: `Promise<void>`
156
172
 
173
+ Uma promessa que é resolvida quando o foco é atribuído.
157
174
 
175
+ ---
158
176
 
159
177
  ### `showConfig() => Promise<void>`
160
178
 
@@ -164,7 +182,7 @@ Exibe a janela de configurações da grade.
164
182
 
165
183
  Type: `Promise<void>`
166
184
 
167
-
185
+ Uma promessa que é resolvida quando a janela de configuração é exibida.
168
186
 
169
187
 
170
188
  ## Dependencies
package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md CHANGED
@@ -22,7 +22,7 @@ Fecha o modal de configuração de valor variável
22
22
 
23
23
  Type: `Promise<IExpressionItem>`
24
24
 
25
-
25
+ ---
26
26
 
27
27
  ### `open(expressionItem: IExpressionItem) => Promise<IExpressionItem>`
28
28
 
package/components/snk-simple-crud/readme.md CHANGED
@@ -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
 
package/components/snk-taskbar/elements/taskbar-actions-button/readme.md CHANGED
@@ -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
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-hotfix-ga-kb-106013.1",
3
+ "version": "0.0.0-hotfix-ga-kb-106183.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [