@sankhyalabs/sankhyablocks-docs 9.1.4 → 9.1.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.
Files changed (17) hide show
  1. package/components/snk-application/readme.md +89 -25
  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 +8 -0
  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 +20 -10
  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/components/snk-taskbar/readme.md +22 -22
  17. 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
 
@@ -47,6 +47,8 @@ Type: `Promise<() => void>`
47
47
 
48
48
  O ID do bloqueio adicionado.
49
49
 
50
+ ---
51
+
50
52
  ### `addPendingAction(actionsLocker: string, action: Function) => Promise<void>`
51
53
 
52
54
  Adiciona uma ação pendente que deve ser executada por um determinado locker.
@@ -55,7 +57,7 @@ Adiciona uma ação pendente que deve ser executada por um determinado locker.
55
57
 
56
58
  Type: `Promise<void>`
57
59
 
58
-
60
+ ---
59
61
 
60
62
  ### `addSearchListener(entityName: string, dataUnit: DataUnit, listener: ISearchListener) => Promise<IRemoveSearchListener>`
61
63
 
@@ -67,6 +69,8 @@ Type: `Promise<IRemoveSearchListener>`
67
69
 
68
70
  Uma função para remover o listener.
69
71
 
72
+ ---
73
+
70
74
  ### `alert(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
71
75
 
72
76
  Exibe o diálogo de alerta de acordo com os parâmetros passados.
@@ -75,7 +79,7 @@ Exibe o diálogo de alerta de acordo com os parâmetros passados.
75
79
 
76
80
  Type: `Promise<boolean>`
77
81
 
78
-
82
+ ---
79
83
 
80
84
  ### `callServiceBroker(serviceName: string, payload: string | Object, options?: Options) => Promise<any>`
81
85
 
@@ -87,6 +91,8 @@ Type: `Promise<any>`
87
91
 
88
92
  A resposta do Service Broker.
89
93
 
94
+ ---
95
+
90
96
  ### `clearPopUpTitle() => Promise<void>`
91
97
 
92
98
 
@@ -95,7 +101,7 @@ A resposta do Service Broker.
95
101
 
96
102
  Type: `Promise<void>`
97
103
 
98
-
104
+ ---
99
105
 
100
106
  ### `closeModal() => Promise<void>`
101
107
 
@@ -105,7 +111,7 @@ Fecha o Modal e limpa o conteúdo.
105
111
 
106
112
  Type: `Promise<void>`
107
113
 
108
-
114
+ ---
109
115
 
110
116
  ### `closePopUp() => Promise<void>`
111
117
 
@@ -115,7 +121,7 @@ Fecha o Popup e limpa o conteúdo.
115
121
 
116
122
  Type: `Promise<void>`
117
123
 
118
-
124
+ ---
119
125
 
120
126
  ### `confirm(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions) => Promise<boolean>`
121
127
 
@@ -127,6 +133,8 @@ Type: `Promise<boolean>`
127
133
 
128
134
  `true` se confirmado, `false` caso contrário.
129
135
 
136
+ ---
137
+
130
138
  ### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
131
139
 
132
140
  Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
@@ -138,6 +146,8 @@ Type: `Promise<DataUnit>`
138
146
 
139
147
  O DataUnit criado ou obtido do cache.
140
148
 
149
+ ---
150
+
141
151
  ### `error(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
142
152
 
143
153
  Exibe o diálogo de erro de acordo com os parâmetros passados.
@@ -146,7 +156,7 @@ Exibe o diálogo de erro de acordo com os parâmetros passados.
146
156
 
147
157
  Type: `Promise<boolean>`
148
158
 
149
-
159
+ ---
150
160
 
151
161
  ### `executePreparedSearch(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
152
162
 
@@ -159,6 +169,8 @@ Type: `Promise<IOption | IOption[]>`
159
169
 
160
170
  Uma lista de opções ou uma única opção.
161
171
 
172
+ ---
173
+
162
174
  ### `executePreparedSearchPlus(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
163
175
 
164
176
  Realiza a pesquisa de registros
@@ -170,6 +182,8 @@ Type: `Promise<IOption | IOption[]>`
170
182
 
171
183
  Uma lista de opções ou uma única opção.
172
184
 
185
+ ---
186
+
173
187
  ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption> | IOption>`
174
188
 
175
189
  Obtém as opções em componentes de pesquisa.
@@ -181,6 +195,8 @@ Type: `Promise<IOption | IOption[]>`
181
195
 
182
196
  Uma lista de opções ou uma única opção.
183
197
 
198
+ ---
199
+
184
200
  ### `executeSelectDistinct(dataUnit: DataUnit, fieldName: string, argument: string) => Promise<Array<any>>`
185
201
 
186
202
  Com base em um campo realiza um "select distinct" respeitando os
@@ -193,6 +209,8 @@ Type: `Promise<any[]>`
193
209
 
194
210
  Uma lista de valores distintos.
195
211
 
212
+ ---
213
+
196
214
  ### `getAllAccess(resourceID?: string) => Promise<any>`
197
215
 
198
216
  Obtém todos os acessos do usuário logado para um recurso específico ou para a aplicação.
@@ -203,6 +221,8 @@ Type: `Promise<any>`
203
221
 
204
222
  Um objeto contendo todos os tipos de acesso e se o usuário os possui.
205
223
 
224
+ ---
225
+
206
226
  ### `getAppLabel() => Promise<string>`
207
227
 
208
228
  Obtém o nome (label) da aplicação.
@@ -213,6 +233,8 @@ Type: `Promise<string>`
213
233
 
214
234
  O nome da aplicação.
215
235
 
236
+ ---
237
+
216
238
  ### `getApplicationPath() => Promise<string>`
217
239
 
218
240
  Retorna o path relativo da aplicação.
@@ -223,6 +245,8 @@ Type: `Promise<string>`
223
245
 
224
246
  O caminho relativo da aplicação.
225
247
 
248
+ ---
249
+
226
250
  ### `getAttributeFromHTMLWrapper(attribName: string) => Promise<string>`
227
251
 
228
252
  Acessa informações de contexto "empurrados" na abertura da tela.
@@ -233,6 +257,8 @@ Type: `Promise<string>`
233
257
 
234
258
  O valor do atributo.
235
259
 
260
+ ---
261
+
236
262
  ### `getBooleanParam(name: string) => Promise<boolean>`
237
263
 
238
264
  Obtém o valor de um parâmetro do tipo booleano.
@@ -243,6 +269,8 @@ Type: `Promise<boolean>`
243
269
 
244
270
  O valor do parâmetro como booleano.
245
271
 
272
+ ---
273
+
246
274
  ### `getConfig(key: string) => Promise<any>`
247
275
 
248
276
  Obtém a configuração de um recurso por service broker.
@@ -253,6 +281,8 @@ Type: `Promise<any>`
253
281
 
254
282
  Os dados da configuração.
255
283
 
284
+ ---
285
+
256
286
  ### `getDataFetcher() => Promise<DataFetcher>`
257
287
 
258
288
  Retorna a instância do DataFetcher utilizado pelo application.
@@ -263,6 +293,8 @@ Type: `Promise<DataFetcher>`
263
293
 
264
294
  O DataFetcher da aplicação.
265
295
 
296
+ ---
297
+
266
298
  ### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
267
299
 
268
300
  Obtém um DataUnit do cache ou cria um caso ainda não tenha sido criado.
@@ -273,6 +305,8 @@ Type: `Promise<DataUnit>`
273
305
 
274
306
  O DataUnit obtido do cache ou recém-criado.
275
307
 
308
+ ---
309
+
276
310
  ### `getDateParam(name: string) => Promise<Date>`
277
311
 
278
312
  Obtém o valor de um parâmetro do tipo data.
@@ -283,6 +317,8 @@ Type: `Promise<Date>`
283
317
 
284
318
  O valor do parâmetro como objeto Date.
285
319
 
320
+ ---
321
+
286
322
  ### `getFloatParam(name: string) => Promise<number>`
287
323
 
288
324
  Obtém o valor de um parâmetro do tipo Decimal.
@@ -293,6 +329,8 @@ Type: `Promise<number>`
293
329
 
294
330
  O valor do parâmetro como número decimal.
295
331
 
332
+ ---
333
+
296
334
  ### `getIntParam(name: string) => Promise<number>`
297
335
 
298
336
  Obtém o valor de um parâmetro do tipo Inteiro.
@@ -303,6 +341,8 @@ Type: `Promise<number>`
303
341
 
304
342
  O valor do parâmetro como número inteiro.
305
343
 
344
+ ---
345
+
306
346
  ### `getKeyboardManager() => Promise<KeyboardManager>`
307
347
 
308
348
  Obtém o controlador de teclado.
@@ -313,6 +353,8 @@ Type: `Promise<KeyboardManager>`
313
353
 
314
354
  O gerenciador de teclado.
315
355
 
356
+ ---
357
+
316
358
  ### `getLayoutFormConfig() => Promise<LayoutFormConfig>`
317
359
 
318
360
  Obtém o notificador de Layout de formulário.
@@ -323,6 +365,8 @@ Type: `Promise<LayoutFormConfig>`
323
365
 
324
366
  O configurador de Layout do Formulário.
325
367
 
368
+ ---
369
+
326
370
  ### `getResourceID() => Promise<string>`
327
371
 
328
372
  Obtém o resourceID da tela em questão.
@@ -333,6 +377,8 @@ Type: `Promise<string>`
333
377
 
334
378
  O ID do recurso da aplicação.
335
379
 
380
+ ---
381
+
336
382
  ### `getStringParam(name: string) => Promise<string>`
337
383
 
338
384
  Obtém o valor de um parâmetro do tipo string.
@@ -343,6 +389,8 @@ Type: `Promise<string>`
343
389
 
344
390
  O valor do parâmetro como string.
345
391
 
392
+ ---
393
+
346
394
  ### `getUserID() => Promise<string>`
347
395
 
348
396
  Obtém o UserId do usuário logado.
@@ -353,6 +401,8 @@ Type: `Promise<string>`
353
401
 
354
402
  O ID do usuário.
355
403
 
404
+ ---
405
+
356
406
  ### `hasAccess(access: AutorizationType, resourceID?: string) => Promise<boolean>`
357
407
 
358
408
  Obtém `true` caso o usuário logado tenha permissão para determinada ação.
@@ -363,6 +413,8 @@ Type: `Promise<boolean>`
363
413
 
364
414
  `true` se o usuário tiver acesso, `false` caso contrário.
365
415
 
416
+ ---
417
+
366
418
  ### `hasClientEvent(eventID: String) => Promise<boolean>`
367
419
 
368
420
  Verifica se um client event está registrado no DataFetcher da aplicação.
@@ -373,6 +425,8 @@ Type: `Promise<boolean>`
373
425
 
374
426
  `true` se o evento estiver registrado, `false` caso contrário.
375
427
 
428
+ ---
429
+
376
430
  ### `importScript(relativePath: string | Array<string>) => Promise<void>`
377
431
 
378
432
  Realiza o import de um JavaScript que está disponível dentro da pasta /public da aplicação.
@@ -381,7 +435,7 @@ Realiza o import de um JavaScript que está disponível dentro da pasta /public
381
435
 
382
436
  Type: `Promise<void>`
383
437
 
384
-
438
+ ---
385
439
 
386
440
  ### `info(message: string, options?: MessageOptions) => Promise<void>`
387
441
 
@@ -391,7 +445,7 @@ Exibe uma informação efêmera (de segundo plano).
391
445
 
392
446
  Type: `Promise<void>`
393
447
 
394
-
448
+ ---
395
449
 
396
450
  ### `initOnboarding(onboardingKey: string) => Promise<void>`
397
451
 
@@ -401,7 +455,7 @@ Inicializa o onboarding para uma chave específica.
401
455
 
402
456
  Type: `Promise<void>`
403
457
 
404
-
458
+ ---
405
459
 
406
460
  ### `isDebugMode() => Promise<boolean>`
407
461
 
@@ -411,7 +465,7 @@ Obtém `true` caso a tela esteja em modo de debug.
411
465
 
412
466
  Type: `Promise<boolean>`
413
467
 
414
-
468
+ ---
415
469
 
416
470
  ### `isLoadedByPk() => Promise<boolean>`
417
471
 
@@ -423,6 +477,8 @@ Type: `Promise<boolean>`
423
477
 
424
478
  `true` se foi carregado por PK, `false` caso contrário.
425
479
 
480
+ ---
481
+
426
482
  ### `isUserSup() => Promise<boolean>`
427
483
 
428
484
  Obtém `true` caso o usuário logado seja o SUP.
@@ -433,6 +489,8 @@ Type: `Promise<boolean>`
433
489
 
434
490
  `true` se o usuário for SUP, `false` caso contrário.
435
491
 
492
+ ---
493
+
436
494
  ### `loadTotals(name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>`
437
495
 
438
496
  Obtém os totalizadores da grade.
@@ -443,6 +501,8 @@ Type: `Promise<Map<string, number>>`
443
501
 
444
502
  Um mapa com os nomes dos totalizadores e seus valores.
445
503
 
504
+ ---
505
+
446
506
  ### `markToReload(templateSkeletonType?: TEMPLATES_SKELETON) => Promise<void>`
447
507
 
448
508
  Marca a aplicação para recarregar, opcionalmente especificando um tipo de esqueleto de carregamento.
@@ -451,7 +511,7 @@ Marca a aplicação para recarregar, opcionalmente especificando um tipo de esqu
451
511
 
452
512
  Type: `Promise<void>`
453
513
 
454
-
514
+ ---
455
515
 
456
516
  ### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
457
517
 
@@ -461,7 +521,7 @@ Exibe um diálogo de mensagem comum.
461
521
 
462
522
  Type: `Promise<boolean>`
463
523
 
464
-
524
+ ---
465
525
 
466
526
  ### `openApp(resourceId: string, pkObject: Object) => Promise<void>`
467
527
 
@@ -471,7 +531,7 @@ Abre determinada tela, repassando pkObject.
471
531
 
472
532
  Type: `Promise<void>`
473
533
 
474
-
534
+ ---
475
535
 
476
536
  ### `preloadMangerRemoveRecord(dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>`
477
537
 
@@ -482,7 +542,7 @@ Deve ser usado quando existe um dataunit usando loader do application, mas o rem
482
542
 
483
543
  Type: `Promise<void>`
484
544
 
485
-
545
+ ---
486
546
 
487
547
  ### `removeClientEvent(eventID: String) => Promise<void>`
488
548
 
@@ -492,7 +552,7 @@ Remove um client event do DataFetcher da aplicação.
492
552
 
493
553
  Type: `Promise<void>`
494
554
 
495
-
555
+ ---
496
556
 
497
557
  ### `saveConfig(key: string, data: Object) => Promise<any>`
498
558
 
@@ -504,6 +564,8 @@ Type: `Promise<any>`
504
564
 
505
565
  O resultado da operação de salvamento.
506
566
 
567
+ ---
568
+
507
569
  ### `setPopUpTitle(title: string) => Promise<void>`
508
570
 
509
571
 
@@ -512,7 +574,7 @@ O resultado da operação de salvamento.
512
574
 
513
575
  Type: `Promise<void>`
514
576
 
515
-
577
+ ---
516
578
 
517
579
  ### `setSearchFilterContext(name: string, value: string) => Promise<void>`
518
580
 
@@ -522,7 +584,7 @@ Atribui valor para parâmetros de contexto no componente de pesquisa.
522
584
 
523
585
  Type: `Promise<void>`
524
586
 
525
-
587
+ ---
526
588
 
527
589
  ### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
528
590
 
@@ -533,7 +595,7 @@ Geralmente é utilizado para apresentar resultados de processamentos em lote.
533
595
 
534
596
  Type: `Promise<void>`
535
597
 
536
-
598
+ ---
537
599
 
538
600
  ### `showModal(content: HTMLElement) => Promise<void>`
539
601
 
@@ -543,7 +605,7 @@ Exibe o conteúdo passado em um Modal.
543
605
 
544
606
  Type: `Promise<void>`
545
607
 
546
-
608
+ ---
547
609
 
548
610
  ### `showPopUp(content: HTMLElement, size?: "auto" | "full", useHeader?: boolean, onCloseCallback?: Function) => Promise<void>`
549
611
 
@@ -553,7 +615,7 @@ Exibe o conteúdo passado em um Popup.
553
615
 
554
616
  Type: `Promise<void>`
555
617
 
556
-
618
+ ---
557
619
 
558
620
  ### `showScrimApp(active: boolean) => Promise<void>`
559
621
 
@@ -563,7 +625,7 @@ Type: `Promise<void>`
563
625
 
564
626
  Type: `Promise<void>`
565
627
 
566
-
628
+ ---
567
629
 
568
630
  ### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
569
631
 
@@ -573,7 +635,7 @@ Exibe o diálogo de sucesso de acordo com os parâmetros passados.
573
635
 
574
636
  Type: `Promise<boolean>`
575
637
 
576
-
638
+ ---
577
639
 
578
640
  ### `temOpcional(opcional: string) => Promise<boolean>`
579
641
 
@@ -585,6 +647,8 @@ Type: `Promise<boolean>`
585
647
 
586
648
  `true` se o cliente tiver o opcional, `false` caso contrário.
587
649
 
650
+ ---
651
+
588
652
  ### `updateDataunitCache(oldName: string, dataUnitName: string, dataUnit: DataUnit) => Promise<void>`
589
653
 
590
654
  Atualiza o cache de dataunits da aplicação.
@@ -593,7 +657,7 @@ Atualiza o cache de dataunits da aplicação.
593
657
 
594
658
  Type: `Promise<void>`
595
659
 
596
-
660
+ ---
597
661
 
598
662
  ### `webConnection(keyPort: string, methodName: string, params: IAppletCallerParams) => Promise<void>`
599
663
 
@@ -603,7 +667,7 @@ Realiza a chamada do WebConnection para realizar a exportação de arquivo.
603
667
 
604
668
  Type: `Promise<void>`
605
669
 
606
-
670
+ ---
607
671
 
608
672
  ### `whenApplicationReady() => Promise<SnkApplication>`
609
673
 
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
@@ -48,6 +48,8 @@ Type: `Promise<DataUnit>`
48
48
 
49
49
  Uma promessa que resolve com a instância do DataUnit.
50
50
 
51
+ ---
52
+
51
53
  ### `getFieldsWithRmPrecision() => Promise<string[]>`
52
54
 
53
55
  Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
@@ -58,6 +60,8 @@ Type: `Promise<string[]>`
58
60
 
59
61
  Uma promessa que resolve com um array de nomes de campos.
60
62
 
63
+ ---
64
+
61
65
  ### `getFieldsWithRmp() => Promise<string[]>`
62
66
 
63
67
  Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
@@ -68,6 +72,8 @@ Type: `Promise<string[]>`
68
72
 
69
73
  Uma promessa que resolve com um array de nomes de campos.
70
74
 
75
+ ---
76
+
71
77
  ### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
72
78
 
73
79
  Busca os metadados da linha selecionada.
@@ -78,6 +84,8 @@ Type: `Promise<RowMetadata>`
78
84
 
79
85
  Uma promessa que resolve com os metadados da linha.
80
86
 
87
+ ---
88
+
81
89
  ### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
82
90
 
83
91
  Método que retorna a lista de IDs dos registros selecionados.
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 legado do formulário. | `string` | `undefined` |
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 | 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[]>` |
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 da grade e formulário.
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
 
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/components/snk-taskbar/readme.md CHANGED
@@ -7,32 +7,32 @@
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
- | `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` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | --------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------- | --------------------------- |
12
+ | `actionsList` | -- | | `Action[]` | `undefined` |
13
+ | `actionsSettingsList` | -- | | `Action[]` | `undefined` |
14
+ | `alignRigth` | `align-rigth` | | `boolean` | `false` |
15
+ | `buttons` | `buttons` | | `string` | `undefined` |
16
+ | `configName` | `config-name` | | `string` | `undefined` |
17
+ | `customButtons` | -- | | `Map<string, CustomButton>` | `undefined` |
18
+ | `customContainerId` | `custom-container-id` | | `string` | `undefined` |
19
+ | `customSlotId` | `custom-slot-id` | | `string` | `"TASKBAR_CUSTOM_ELEMENTS"` |
20
+ | `dataUnit` | -- | | `DataUnit` | `undefined` |
21
+ | `disabledButtons` | -- | | `string[]` | `undefined` |
22
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
23
+ | `overflowStrategy` | `overflow-strategy` | | `"hiddenItems" \| "none"` | `'hiddenItems'` |
24
+ | `presentationMode` | `presentation-mode` | | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
25
+ | `primaryButton` | `primary-button` | | `string` | `undefined` |
26
+ | `resourceID` | `resource-i-d` | | `string` | `undefined` |
27
27
 
28
28
 
29
29
  ## Events
30
30
 
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>` |
31
+ | Event | Description | Type |
32
+ | --------------------- | ----------- | --------------------- |
33
+ | `actionClick` | | `CustomEvent<string>` |
34
+ | `taskbarSaveLocker` | | `CustomEvent<void>` |
35
+ | `taskbarSaveUnlocker` | | `CustomEvent<void>` |
36
36
 
37
37
 
38
38
  ## Dependencies
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "9.1.4",
3
+ "version": "9.1.6",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [