@sankhyalabs/sankhyablocks-docs 9.1.0-dev.2 → 9.1.0-dev.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/components/snk-application/readme.md +72 -64
- package/components/snk-attach/readme.md +10 -9
- package/components/snk-entity-list/readme.md +1 -0
- package/components/snk-form-config/fields-selector/readme.md +5 -4
- package/components/snk-grid/readme.md +5 -4
- package/components/snk-grid-config/snk-select-box/readme.md +4 -3
- package/components/snk-layout-form-config/readme.md +7 -0
- package/components/snk-pesquisa/pesquisa-tree/readme.md +7 -6
- package/components/snk-simple-form-config/readme.md +5 -4
- package/package.json +1 -1
@@ -9,12 +9,12 @@
|
|
9
9
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
11
11
|
| ----------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------- |
|
12
|
-
| `configName` | `config-name` |
|
13
|
-
| `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação
|
14
|
-
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração
|
15
|
-
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração
|
12
|
+
| `configName` | `config-name` | Nome da configuração utilizada para salvar as preferências dos blocos de construção. | `string` | `undefined` |
|
13
|
+
| `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean` | `undefined` |
|
14
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário, utilizada para migração de configurações antigas. | `string` | `undefined` |
|
15
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade, utilizada para migração de configurações antigas. | `string` | `undefined` |
|
16
16
|
| `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: any; }, redirectFrom?: string) => void` | `undefined` |
|
17
|
-
| `messagesBuilder` | -- |
|
17
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
18
18
|
|
19
19
|
|
20
20
|
## Events
|
@@ -39,13 +39,13 @@ Type: `Promise<void>`
|
|
39
39
|
|
40
40
|
### `addLoadingLock(forceReady?: boolean, templateSkeletonType?: TEMPLATES_SKELETON) => Promise<() => void>`
|
41
41
|
|
42
|
-
|
42
|
+
Adiciona um bloqueio de carregamento à aplicação.
|
43
43
|
|
44
44
|
#### Returns
|
45
45
|
|
46
46
|
Type: `Promise<() => void>`
|
47
47
|
|
48
|
-
|
48
|
+
O ID do bloqueio adicionado.
|
49
49
|
|
50
50
|
### `addPendingAction(actionsLocker: string, action: Function) => Promise<void>`
|
51
51
|
|
@@ -59,13 +59,13 @@ Type: `Promise<void>`
|
|
59
59
|
|
60
60
|
### `addSearchListener(entityName: string, dataUnit: DataUnit, listener: ISearchListener) => Promise<IRemoveSearchListener>`
|
61
61
|
|
62
|
-
Adiciona um listener no fetcher de Pesquisa
|
62
|
+
Adiciona um listener no fetcher de Pesquisa.
|
63
63
|
|
64
64
|
#### Returns
|
65
65
|
|
66
66
|
Type: `Promise<IRemoveSearchListener>`
|
67
67
|
|
68
|
-
|
68
|
+
Uma função para remover o listener.
|
69
69
|
|
70
70
|
### `alert(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
71
71
|
|
@@ -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
|
+
A resposta do Service Broker.
|
89
89
|
|
90
90
|
### `clearPopUpTitle() => Promise<void>`
|
91
91
|
|
@@ -119,13 +119,13 @@ Type: `Promise<void>`
|
|
119
119
|
|
120
120
|
### `confirm(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions) => Promise<boolean>`
|
121
121
|
|
122
|
-
Exibe um diálogo de confirmação
|
122
|
+
Exibe um diálogo de confirmação.
|
123
123
|
|
124
124
|
#### Returns
|
125
125
|
|
126
126
|
Type: `Promise<boolean>`
|
127
127
|
|
128
|
-
|
128
|
+
`true` se confirmado, `false` caso contrário.
|
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
|
+
O DataUnit criado ou obtido do cache.
|
140
140
|
|
141
141
|
### `error(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
142
142
|
|
@@ -150,14 +150,13 @@ Type: `Promise<boolean>`
|
|
150
150
|
|
151
151
|
### `executePreparedSearch(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
|
152
152
|
|
153
|
-
|
154
|
-
Ex.: snk-config-options
|
153
|
+
|
155
154
|
|
156
155
|
#### Returns
|
157
156
|
|
158
157
|
Type: `Promise<IOption | IOption[]>`
|
159
158
|
|
160
|
-
|
159
|
+
Uma lista de opções ou uma única opção.
|
161
160
|
|
162
161
|
### `executePreparedSearchPlus(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
|
163
162
|
|
@@ -170,16 +169,16 @@ Type: `Promise<IOption | IOption[]>`
|
|
170
169
|
|
171
170
|
|
172
171
|
|
173
|
-
### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?:
|
172
|
+
### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption> | IOption>`
|
174
173
|
|
175
|
-
Obtém as opções em componentes de pesquisa
|
174
|
+
Obtém as opções em componentes de pesquisa.
|
176
175
|
Ex.: snk-config-options
|
177
176
|
|
178
177
|
#### Returns
|
179
178
|
|
180
179
|
Type: `Promise<IOption | IOption[]>`
|
181
180
|
|
182
|
-
|
181
|
+
Uma lista de opções ou uma única opção.
|
183
182
|
|
184
183
|
### `executeSelectDistinct(dataUnit: DataUnit, fieldName: string, argument: string) => Promise<Array<any>>`
|
185
184
|
|
@@ -191,27 +190,27 @@ coluna.
|
|
191
190
|
|
192
191
|
Type: `Promise<any[]>`
|
193
192
|
|
194
|
-
|
193
|
+
Uma lista de valores distintos.
|
195
194
|
|
196
195
|
### `getAllAccess(resourceID?: string) => Promise<any>`
|
197
196
|
|
198
|
-
Obtém todos os acessos do usuário logado.
|
197
|
+
Obtém todos os acessos do usuário logado para um recurso específico ou para a aplicação.
|
199
198
|
|
200
199
|
#### Returns
|
201
200
|
|
202
201
|
Type: `Promise<any>`
|
203
202
|
|
204
|
-
|
203
|
+
Um objeto contendo todos os tipos de acesso e se o usuário os possui.
|
205
204
|
|
206
205
|
### `getAppLabel() => Promise<string>`
|
207
206
|
|
208
|
-
Obtém o nome
|
207
|
+
Obtém o nome (label) da aplicação.
|
209
208
|
|
210
209
|
#### Returns
|
211
210
|
|
212
211
|
Type: `Promise<string>`
|
213
212
|
|
214
|
-
|
213
|
+
O nome da aplicação.
|
215
214
|
|
216
215
|
### `getApplicationPath() => Promise<string>`
|
217
216
|
|
@@ -221,7 +220,7 @@ Retorna o path relativo da aplicação.
|
|
221
220
|
|
222
221
|
Type: `Promise<string>`
|
223
222
|
|
224
|
-
|
223
|
+
O caminho relativo da aplicação.
|
225
224
|
|
226
225
|
### `getAttributeFromHTMLWrapper(attribName: string) => Promise<string>`
|
227
226
|
|
@@ -231,7 +230,7 @@ Acessa informações de contexto "empurrados" na abertura da tela.
|
|
231
230
|
|
232
231
|
Type: `Promise<string>`
|
233
232
|
|
234
|
-
|
233
|
+
O valor do atributo.
|
235
234
|
|
236
235
|
### `getBooleanParam(name: string) => Promise<boolean>`
|
237
236
|
|
@@ -241,37 +240,37 @@ Obtém o valor de um parâmetro do tipo booleano.
|
|
241
240
|
|
242
241
|
Type: `Promise<boolean>`
|
243
242
|
|
244
|
-
|
243
|
+
O valor do parâmetro como booleano.
|
245
244
|
|
246
245
|
### `getConfig(key: string) => Promise<any>`
|
247
246
|
|
248
|
-
Obtém a configuração de um recurso por service broker
|
247
|
+
Obtém a configuração de um recurso por service broker.
|
249
248
|
|
250
249
|
#### Returns
|
251
250
|
|
252
251
|
Type: `Promise<any>`
|
253
252
|
|
254
|
-
|
253
|
+
Os dados da configuração.
|
255
254
|
|
256
255
|
### `getDataFetcher() => Promise<DataFetcher>`
|
257
256
|
|
258
|
-
Retorna a
|
257
|
+
Retorna a instância do DataFetcher utilizado pelo application.
|
259
258
|
|
260
259
|
#### Returns
|
261
260
|
|
262
261
|
Type: `Promise<DataFetcher>`
|
263
262
|
|
264
|
-
DataFetcher
|
263
|
+
O DataFetcher da aplicação.
|
265
264
|
|
266
265
|
### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
|
267
266
|
|
268
|
-
|
267
|
+
Obtém um DataUnit do cache ou cria um caso ainda não tenha sido criado.
|
269
268
|
|
270
269
|
#### Returns
|
271
270
|
|
272
271
|
Type: `Promise<DataUnit>`
|
273
272
|
|
274
|
-
|
273
|
+
O DataUnit obtido do cache ou recém-criado.
|
275
274
|
|
276
275
|
### `getDateParam(name: string) => Promise<Date>`
|
277
276
|
|
@@ -281,7 +280,7 @@ Obtém o valor de um parâmetro do tipo data.
|
|
281
280
|
|
282
281
|
Type: `Promise<Date>`
|
283
282
|
|
284
|
-
|
283
|
+
O valor do parâmetro como objeto Date.
|
285
284
|
|
286
285
|
### `getFloatParam(name: string) => Promise<number>`
|
287
286
|
|
@@ -291,7 +290,7 @@ Obtém o valor de um parâmetro do tipo Decimal.
|
|
291
290
|
|
292
291
|
Type: `Promise<number>`
|
293
292
|
|
294
|
-
|
293
|
+
O valor do parâmetro como número decimal.
|
295
294
|
|
296
295
|
### `getIntParam(name: string) => Promise<number>`
|
297
296
|
|
@@ -301,7 +300,7 @@ Obtém o valor de um parâmetro do tipo Inteiro.
|
|
301
300
|
|
302
301
|
Type: `Promise<number>`
|
303
302
|
|
304
|
-
|
303
|
+
O valor do parâmetro como número inteiro.
|
305
304
|
|
306
305
|
### `getKeyboardManager() => Promise<KeyboardManager>`
|
307
306
|
|
@@ -311,17 +310,17 @@ Obtém o controlador de teclado.
|
|
311
310
|
|
312
311
|
Type: `Promise<KeyboardManager>`
|
313
312
|
|
314
|
-
|
313
|
+
O gerenciador de teclado.
|
315
314
|
|
316
315
|
### `getLayoutFormConfig() => Promise<LayoutFormConfig>`
|
317
316
|
|
318
|
-
Obtém o notificador de Layout de
|
317
|
+
Obtém o notificador de Layout de formulário.
|
319
318
|
|
320
319
|
#### Returns
|
321
320
|
|
322
321
|
Type: `Promise<LayoutFormConfig>`
|
323
322
|
|
324
|
-
|
323
|
+
O configurador de Layout do Formulário.
|
325
324
|
|
326
325
|
### `getResourceID() => Promise<string>`
|
327
326
|
|
@@ -331,7 +330,7 @@ Obtém o resourceID da tela em questão.
|
|
331
330
|
|
332
331
|
Type: `Promise<string>`
|
333
332
|
|
334
|
-
|
333
|
+
O ID do recurso da aplicação.
|
335
334
|
|
336
335
|
### `getStringParam(name: string) => Promise<string>`
|
337
336
|
|
@@ -341,41 +340,41 @@ Obtém o valor de um parâmetro do tipo string.
|
|
341
340
|
|
342
341
|
Type: `Promise<string>`
|
343
342
|
|
344
|
-
|
343
|
+
O valor do parâmetro como string.
|
345
344
|
|
346
345
|
### `getUserID() => Promise<string>`
|
347
346
|
|
348
|
-
Obtém o UserId
|
347
|
+
Obtém o UserId do usuário logado.
|
349
348
|
|
350
349
|
#### Returns
|
351
350
|
|
352
351
|
Type: `Promise<string>`
|
353
352
|
|
354
|
-
|
353
|
+
O ID do usuário.
|
355
354
|
|
356
355
|
### `hasAccess(access: AutorizationType, resourceID?: string) => Promise<boolean>`
|
357
356
|
|
358
|
-
Obtém `true` caso o usuário logado
|
357
|
+
Obtém `true` caso o usuário logado tenha permissão para determinada ação.
|
359
358
|
|
360
359
|
#### Returns
|
361
360
|
|
362
361
|
Type: `Promise<boolean>`
|
363
362
|
|
364
|
-
|
363
|
+
`true` se o usuário tiver acesso, `false` caso contrário.
|
365
364
|
|
366
365
|
### `hasClientEvent(eventID: String) => Promise<boolean>`
|
367
366
|
|
368
|
-
|
367
|
+
Verifica se um client event está registrado no DataFetcher da aplicação.
|
369
368
|
|
370
369
|
#### Returns
|
371
370
|
|
372
371
|
Type: `Promise<boolean>`
|
373
372
|
|
374
|
-
|
373
|
+
`true` se o evento estiver registrado, `false` caso contrário.
|
375
374
|
|
376
375
|
### `importScript(relativePath: string | Array<string>) => Promise<void>`
|
377
376
|
|
378
|
-
Realiza o import de um JavaScript que está
|
377
|
+
Realiza o import de um JavaScript que está disponível dentro da pasta /public da aplicação.
|
379
378
|
|
380
379
|
#### Returns
|
381
380
|
|
@@ -395,7 +394,7 @@ Type: `Promise<void>`
|
|
395
394
|
|
396
395
|
### `initOnboarding(onboardingKey: string) => Promise<void>`
|
397
396
|
|
398
|
-
|
397
|
+
Inicializa o onboarding para uma chave específica.
|
399
398
|
|
400
399
|
#### Returns
|
401
400
|
|
@@ -413,15 +412,25 @@ Type: `Promise<boolean>`
|
|
413
412
|
|
414
413
|
|
415
414
|
|
415
|
+
### `isFeatureActive(featureName: string) => Promise<boolean>`
|
416
|
+
|
417
|
+
Retorna se uma feature flag global está ativa ou não.
|
418
|
+
|
419
|
+
#### Returns
|
420
|
+
|
421
|
+
Type: `Promise<boolean>`
|
422
|
+
|
423
|
+
|
424
|
+
|
416
425
|
### `isLoadedByPk() => Promise<boolean>`
|
417
426
|
|
418
|
-
Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk
|
427
|
+
Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk.
|
419
428
|
|
420
429
|
#### Returns
|
421
430
|
|
422
431
|
Type: `Promise<boolean>`
|
423
432
|
|
424
|
-
|
433
|
+
`true` se foi carregado por PK, `false` caso contrário.
|
425
434
|
|
426
435
|
### `isUserSup() => Promise<boolean>`
|
427
436
|
|
@@ -431,7 +440,7 @@ Obtém `true` caso o usuário logado seja o SUP.
|
|
431
440
|
|
432
441
|
Type: `Promise<boolean>`
|
433
442
|
|
434
|
-
|
443
|
+
`true` se o usuário for SUP, `false` caso contrário.
|
435
444
|
|
436
445
|
### `loadTotals(name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>`
|
437
446
|
|
@@ -441,11 +450,11 @@ Obtém os totalizadores da grade.
|
|
441
450
|
|
442
451
|
Type: `Promise<Map<string, number>>`
|
443
452
|
|
444
|
-
|
453
|
+
Um mapa com os nomes dos totalizadores e seus valores.
|
445
454
|
|
446
455
|
### `markToReload(templateSkeletonType?: TEMPLATES_SKELETON) => Promise<void>`
|
447
456
|
|
448
|
-
|
457
|
+
Marca a aplicação para recarregar, opcionalmente especificando um tipo de esqueleto de carregamento.
|
449
458
|
|
450
459
|
#### Returns
|
451
460
|
|
@@ -455,7 +464,7 @@ Type: `Promise<void>`
|
|
455
464
|
|
456
465
|
### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
457
466
|
|
458
|
-
Exibe um diálogo de mensagem comum
|
467
|
+
Exibe um diálogo de mensagem comum.
|
459
468
|
|
460
469
|
#### Returns
|
461
470
|
|
@@ -486,7 +495,7 @@ Type: `Promise<void>`
|
|
486
495
|
|
487
496
|
### `removeClientEvent(eventID: String) => Promise<void>`
|
488
497
|
|
489
|
-
Remove um client event
|
498
|
+
Remove um client event do DataFetcher da aplicação.
|
490
499
|
|
491
500
|
#### Returns
|
492
501
|
|
@@ -502,7 +511,7 @@ Salva a configuração de determinado recurso.
|
|
502
511
|
|
503
512
|
Type: `Promise<any>`
|
504
513
|
|
505
|
-
|
514
|
+
O resultado da operação de salvamento.
|
506
515
|
|
507
516
|
### `setPopUpTitle(title: string) => Promise<void>`
|
508
517
|
|
@@ -526,9 +535,8 @@ Type: `Promise<void>`
|
|
526
535
|
|
527
536
|
### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
|
528
537
|
|
529
|
-
Apresenta uma lista de alertas
|
530
|
-
|
531
|
-
de processamentos em lote.
|
538
|
+
Apresenta uma lista de alertas.
|
539
|
+
Geralmente é utilizado para apresentar resultados de processamentos em lote.
|
532
540
|
|
533
541
|
#### Returns
|
534
542
|
|
@@ -578,13 +586,13 @@ Type: `Promise<boolean>`
|
|
578
586
|
|
579
587
|
### `temOpcional(opcional: string) => Promise<boolean>`
|
580
588
|
|
581
|
-
Verifica se a licença do cliente tem determinado opcional (produto)
|
589
|
+
Verifica se a licença do cliente tem determinado opcional (produto).
|
582
590
|
|
583
591
|
#### Returns
|
584
592
|
|
585
593
|
Type: `Promise<boolean>`
|
586
594
|
|
587
|
-
|
595
|
+
`true` se o cliente tiver o opcional, `false` caso contrário.
|
588
596
|
|
589
597
|
### `updateDataunitCache(oldName: string, dataUnitName: string, dataUnit: DataUnit) => Promise<void>`
|
590
598
|
|
@@ -608,13 +616,13 @@ Type: `Promise<void>`
|
|
608
616
|
|
609
617
|
### `whenApplicationReady() => Promise<SnkApplication>`
|
610
618
|
|
611
|
-
Retorna uma promise que
|
619
|
+
Retorna uma promise que será resolvida quando o snk-application estiver carregado e registrado no ApplicationContext.
|
612
620
|
|
613
621
|
#### Returns
|
614
622
|
|
615
623
|
Type: `Promise<SnkApplication>`
|
616
624
|
|
617
|
-
SnkApplication carregado.
|
625
|
+
O componente SnkApplication carregado.
|
618
626
|
|
619
627
|
|
620
628
|
## Dependencies
|
@@ -7,15 +7,16 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute
|
11
|
-
| -------------------------- |
|
12
|
-
| `dataUnit` | --
|
13
|
-
| `dataUnitBuilder` | --
|
14
|
-
| `entityName` | `entity-name`
|
15
|
-
| `fetcher` | --
|
16
|
-
| `fetcherType` | `fetcher-type`
|
17
|
-
| `
|
18
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| -------------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------- | ----------- |
|
12
|
+
| `dataUnit` | -- | DataUnit responsável por carregar os dados. | `DataUnit` | `undefined` |
|
13
|
+
| `dataUnitBuilder` | -- | DataUnitBuilder responsável por implementar dados a serem utilizados no DataUnit. | `FetcherFacade` | `undefined` |
|
14
|
+
| `entityName` | `entity-name` | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. | `string` | `undefined` |
|
15
|
+
| `fetcher` | -- | Fetcher responsável por carregar os dados do DataUnit. | `AttachFetcherFacadeInterface` | `undefined` |
|
16
|
+
| `fetcherType` | `fetcher-type` | FetcherType define o tipo de fetcher responsável por carregar os dados do DataUnit. | `"AnexoSistema" \| "Another" \| "Attach"` | `undefined` |
|
17
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grid. | `string` | `undefined` |
|
18
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
19
|
+
| `registerKey` _(required)_ | `register-key` | Identificação do registro pai. | `string` | `undefined` |
|
19
20
|
|
20
21
|
|
21
22
|
## Events
|
@@ -12,6 +12,7 @@
|
|
12
12
|
| `config` | -- | Configurações para carregar os dados do componente | `SnkFilterItemConfig` | `undefined` |
|
13
13
|
| `maxHeightList` | `max-height-list` | Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida | `string` | `""` |
|
14
14
|
| `rightListSlotBuilder` | -- | Método que possibilita alterar como o item da lista vai ser apresentado. Observação: No React ele se transforma em VNode e não HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
|
15
|
+
| `value` | -- | Define o valor do componente | `IOption` | `undefined` |
|
15
16
|
|
16
17
|
|
17
18
|
## Events
|
@@ -7,10 +7,11 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description | Type
|
11
|
-
| ----------------- | --------- | ----------- |
|
12
|
-
| `availableFields` | -- | | `IFieldConfig[]`
|
13
|
-
| `dataUnit` | -- | | `DataUnit`
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | --------- | ----------- | ------------------- | ----------- |
|
12
|
+
| `availableFields` | -- | | `IFieldConfig[]` | `[]` |
|
13
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
14
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
14
15
|
|
15
16
|
|
16
17
|
## Events
|
@@ -47,10 +47,11 @@
|
|
47
47
|
|
48
48
|
## Events
|
49
49
|
|
50
|
-
| Event | Description
|
51
|
-
| ----------------- |
|
52
|
-
| `actionClick` | Emitido sempre que houver click de botão ou ação.
|
53
|
-
| `
|
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>` |
|
54
55
|
|
55
56
|
|
56
57
|
## Methods
|
@@ -7,9 +7,10 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ------------------ | -------------------- | ------------------------------------------------------------------------------------ | ------------------- | ------------------- |
|
12
|
+
| `preventAutoFocus` | `prevent-auto-focus` | Se true, impede que o campo de texto receba foco automaticamente ao abrir as opções. | `boolean` | `false` |
|
13
|
+
| `selectedOption` | `selected-option` | Determina a opção selecionada. | `IOption \| string` | `ORDER_VALUES.none` |
|
13
14
|
|
14
15
|
|
15
16
|
## Events
|
@@ -5,6 +5,13 @@
|
|
5
5
|
<!-- Auto Generated Below -->
|
6
6
|
|
7
7
|
|
8
|
+
## Properties
|
9
|
+
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | --------- | ----------- | ------------------- | ----------- |
|
12
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
13
|
+
|
14
|
+
|
8
15
|
## Methods
|
9
16
|
|
10
17
|
### `save() => Promise<void>`
|
@@ -7,12 +7,13 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description
|
11
|
-
| ------------------- | --------------------- |
|
12
|
-
| `allowsNonAnalytic` | `allows-non-analytic` | Define se permite seleção de items não analíticos
|
13
|
-
| `argument` | `argument` | Argumentos que serão usados ao chamar a função treeLoader.
|
14
|
-
| `
|
15
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------- | ----------- |
|
12
|
+
| `allowsNonAnalytic` | `allows-non-analytic` | Define se permite seleção de items não analíticos | `boolean` | `false` |
|
13
|
+
| `argument` | `argument` | Argumentos que serão usados ao chamar a função treeLoader. | `string` | `undefined` |
|
14
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
15
|
+
| `shouldLoadTree` | `should-load-tree` | Informa se a árvore hierárquica deve ou não ser carregada. | `boolean` | `false` |
|
16
|
+
| `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<ITreeItem[]>` | `undefined` |
|
16
17
|
|
17
18
|
|
18
19
|
## Events
|
@@ -7,10 +7,11 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property
|
11
|
-
|
|
12
|
-
| `configName`
|
13
|
-
| `dataUnit`
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ----------------- | ------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
12
|
+
| `configName` | `config-name` | Chave que representa a configuração do formulário | `string` | `undefined` |
|
13
|
+
| `dataUnit` | -- | Data unit responsável pelos campos disponíveis | `DataUnit` | `undefined` |
|
14
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
14
15
|
|
15
16
|
|
16
17
|
## Events
|