@sankhyalabs/sankhyablocks-docs 8.16.0-dev.11 → 8.16.0-dev.111
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 +93 -8
- package/components/snk-attach/readme.md +6 -5
- package/components/snk-configurator/readme.md +7 -0
- package/components/snk-crud/readme.md +40 -24
- package/components/snk-crud/subcomponents/readme.md +18 -17
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +27 -22
- package/components/snk-filter-bar/readme.md +15 -12
- package/components/snk-form-config/readme.md +6 -7
- package/components/snk-grid/readme.md +43 -33
- package/components/snk-layout-form-config/readme.md +41 -0
- package/components/snk-layout-form-config/snk-view-representation/readme.md +30 -0
- package/components/snk-pesquisa/pesquisa-grid/readme.md +42 -0
- package/components/snk-pesquisa/pesquisa-tree/readme.md +53 -0
- package/components/snk-pesquisa/readme.md +16 -5
- package/components/snk-simple-crud/readme.md +40 -31
- package/components/snk-simple-form-config/readme.md +51 -0
- package/components/snk-taskbar/elements/taskbar-split-button/readme.md +47 -0
- package/components/snk-taskbar/readme.md +24 -19
- package/components/teste-pesquisa/readme.md +2 -0
- package/package.json +1 -1
|
@@ -7,13 +7,14 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `configName`
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------- |
|
|
12
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
13
|
+
| `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `undefined` |
|
|
14
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
15
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
16
|
+
| `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` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
17
18
|
|
|
18
19
|
|
|
19
20
|
## Events
|
|
@@ -36,6 +37,16 @@ Type: `Promise<void>`
|
|
|
36
37
|
|
|
37
38
|
|
|
38
39
|
|
|
40
|
+
### `addLoadingLock(forceReady?: boolean, templateSkeletonType?: TEMPLATES_SKELETON) => Promise<() => void>`
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
#### Returns
|
|
45
|
+
|
|
46
|
+
Type: `Promise<() => void>`
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
39
50
|
### `addPendingAction(actionsLocker: string, action: Function) => Promise<void>`
|
|
40
51
|
|
|
41
52
|
Adiciona uma ação pendente que deve ser executada por um determinado locker.
|
|
@@ -76,6 +87,16 @@ Type: `Promise<any>`
|
|
|
76
87
|
|
|
77
88
|
|
|
78
89
|
|
|
90
|
+
### `clearPopUpTitle() => Promise<void>`
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
#### Returns
|
|
95
|
+
|
|
96
|
+
Type: `Promise<void>`
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
79
100
|
### `closeModal() => Promise<void>`
|
|
80
101
|
|
|
81
102
|
Fecha o Modal e limpa o conteúdo.
|
|
@@ -138,7 +159,18 @@ Type: `Promise<IOption | IOption[]>`
|
|
|
138
159
|
|
|
139
160
|
|
|
140
161
|
|
|
141
|
-
### `
|
|
162
|
+
### `executePreparedSearchPlus(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
|
|
163
|
+
|
|
164
|
+
Realiza a pesquisa de registros
|
|
165
|
+
Ex.: snk-config-options
|
|
166
|
+
|
|
167
|
+
#### Returns
|
|
168
|
+
|
|
169
|
+
Type: `Promise<IOption | IOption[]>`
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption> | IOption>`
|
|
142
174
|
|
|
143
175
|
Obtém as opções em componentes de pesquisa
|
|
144
176
|
Ex.: snk-config-options
|
|
@@ -281,6 +313,16 @@ Type: `Promise<KeyboardManager>`
|
|
|
281
313
|
|
|
282
314
|
the keyboard manager
|
|
283
315
|
|
|
316
|
+
### `getLayoutFormConfig() => Promise<LayoutFormConfig>`
|
|
317
|
+
|
|
318
|
+
Obtém o notificador de Layout de formulario.
|
|
319
|
+
|
|
320
|
+
#### Returns
|
|
321
|
+
|
|
322
|
+
Type: `Promise<LayoutFormConfig>`
|
|
323
|
+
|
|
324
|
+
the Configurador de Layout do Formulario
|
|
325
|
+
|
|
284
326
|
### `getResourceID() => Promise<string>`
|
|
285
327
|
|
|
286
328
|
Obtém o resourceID da tela em questão.
|
|
@@ -401,6 +443,16 @@ Type: `Promise<Map<string, number>>`
|
|
|
401
443
|
|
|
402
444
|
|
|
403
445
|
|
|
446
|
+
### `markToReload(templateSkeletonType?: TEMPLATES_SKELETON) => Promise<void>`
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
#### Returns
|
|
451
|
+
|
|
452
|
+
Type: `Promise<void>`
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
404
456
|
### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
|
405
457
|
|
|
406
458
|
Exibe um diálogo de mensagem comum
|
|
@@ -421,6 +473,17 @@ Type: `Promise<void>`
|
|
|
421
473
|
|
|
422
474
|
|
|
423
475
|
|
|
476
|
+
### `preloadMangerRemoveRecord(dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>`
|
|
477
|
+
|
|
478
|
+
Remove registro do cache do PreLoader do dataunit.
|
|
479
|
+
Deve ser usado quando existe um dataunit usando loader do application, mas o removeLoader está sendo sobrescrito.
|
|
480
|
+
|
|
481
|
+
#### Returns
|
|
482
|
+
|
|
483
|
+
Type: `Promise<void>`
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
424
487
|
### `removeClientEvent(eventID: String) => Promise<void>`
|
|
425
488
|
|
|
426
489
|
Remove um client event para o DataFetcher da aplicação.
|
|
@@ -441,6 +504,16 @@ Type: `Promise<any>`
|
|
|
441
504
|
|
|
442
505
|
|
|
443
506
|
|
|
507
|
+
### `setPopUpTitle(title: string) => Promise<void>`
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
#### Returns
|
|
512
|
+
|
|
513
|
+
Type: `Promise<void>`
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
444
517
|
### `setSearchFilterContext(name: string, value: string) => Promise<void>`
|
|
445
518
|
|
|
446
519
|
Atribui valor para parâmetros de contexto no componente de pesquisa.
|
|
@@ -483,6 +556,16 @@ Type: `Promise<void>`
|
|
|
483
556
|
|
|
484
557
|
|
|
485
558
|
|
|
559
|
+
### `showScrimApp(active: boolean) => Promise<void>`
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
#### Returns
|
|
564
|
+
|
|
565
|
+
Type: `Promise<void>`
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
486
569
|
### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
|
487
570
|
|
|
488
571
|
Exibe o diálogo de sucesso de acordo com os parâmetros passados.
|
|
@@ -548,6 +631,8 @@ SnkApplication carregado.
|
|
|
548
631
|
```mermaid
|
|
549
632
|
graph TD;
|
|
550
633
|
snk-application --> snk-pesquisa
|
|
634
|
+
snk-pesquisa --> pesquisa-grid
|
|
635
|
+
snk-pesquisa --> pesquisa-tree
|
|
551
636
|
teste-pesquisa --> snk-application
|
|
552
637
|
style snk-application fill:#f9f,stroke:#333,stroke-width:4px
|
|
553
638
|
```
|
|
@@ -42,21 +42,22 @@
|
|
|
42
42
|
graph TD;
|
|
43
43
|
snk-attach --> snk-simple-bar
|
|
44
44
|
snk-attach --> snk-simple-crud
|
|
45
|
-
snk-simple-crud --> snk-data-unit
|
|
46
45
|
snk-simple-crud --> snk-taskbar
|
|
47
|
-
snk-simple-crud --> snk-
|
|
46
|
+
snk-simple-crud --> snk-data-unit
|
|
47
|
+
snk-simple-crud --> snk-simple-form-config
|
|
48
48
|
snk-simple-crud --> snk-configurator
|
|
49
49
|
snk-simple-crud --> snk-grid-config
|
|
50
50
|
snk-simple-crud --> snk-data-exporter
|
|
51
51
|
snk-simple-crud --> snk-actions-button
|
|
52
|
+
snk-simple-crud --> taskbar-split-button
|
|
52
53
|
snk-simple-crud --> taskbar-actions-button
|
|
53
54
|
snk-taskbar --> snk-data-exporter
|
|
54
55
|
snk-taskbar --> snk-actions-button
|
|
56
|
+
snk-taskbar --> taskbar-split-button
|
|
55
57
|
snk-taskbar --> taskbar-actions-button
|
|
56
58
|
snk-data-exporter --> snk-exporter-email-sender
|
|
57
|
-
snk-
|
|
58
|
-
snk-form-config --> snk-
|
|
59
|
-
snk-form-config --> snk-tab-config
|
|
59
|
+
snk-configurator --> snk-layout-form-config
|
|
60
|
+
snk-layout-form-config --> snk-view-representation
|
|
60
61
|
snk-grid-config --> snk-select-box
|
|
61
62
|
snk-crud --> snk-attach
|
|
62
63
|
snk-detail-view --> snk-attach
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| ------------------- | --------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------- |
|
|
12
12
|
| `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
|
|
13
13
|
| `customContainerId` | `custom-container-id` | ID do container que contém os elementos customizados do configurator. | `string` | `undefined` |
|
|
14
|
+
| `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
|
|
14
15
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
15
16
|
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
16
17
|
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação | `boolean` | `false` |
|
|
@@ -58,9 +59,15 @@ Type: `Promise<void>`
|
|
|
58
59
|
- [snk-guides-viewer](../snk-crud/subcomponents)
|
|
59
60
|
- [snk-simple-crud](../snk-simple-crud)
|
|
60
61
|
|
|
62
|
+
### Depends on
|
|
63
|
+
|
|
64
|
+
- [snk-layout-form-config](../snk-layout-form-config)
|
|
65
|
+
|
|
61
66
|
### Graph
|
|
62
67
|
```mermaid
|
|
63
68
|
graph TD;
|
|
69
|
+
snk-configurator --> snk-layout-form-config
|
|
70
|
+
snk-layout-form-config --> snk-view-representation
|
|
64
71
|
snk-crud --> snk-configurator
|
|
65
72
|
snk-guides-viewer --> snk-configurator
|
|
66
73
|
snk-simple-crud --> snk-configurator
|
|
@@ -7,28 +7,35 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `actionsList`
|
|
13
|
-
| `autoFocus`
|
|
14
|
-
| `autoLoad`
|
|
15
|
-
| `configName`
|
|
16
|
-
| `disablePersonalizedFilter`
|
|
17
|
-
| `domainMessagesBuilder`
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------------------- | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------ |
|
|
12
|
+
| `actionsList` | -- | Ações a serem colocadas 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
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
16
|
+
| `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` |
|
|
17
|
+
| `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
|
|
18
|
+
| `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
|
|
19
|
+
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
|
|
20
|
+
| `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
|
|
21
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
|
22
|
+
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
|
23
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
24
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
25
|
+
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
|
|
26
|
+
| `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
|
|
27
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
28
|
+
| `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
|
|
29
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
|
|
30
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
|
31
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
32
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
|
33
|
+
| `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
|
|
34
|
+
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
|
|
35
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
|
36
|
+
| `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
|
|
37
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
38
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
32
39
|
|
|
33
40
|
|
|
34
41
|
## Events
|
|
@@ -155,6 +162,7 @@ Type: `Promise<void>`
|
|
|
155
162
|
- [snk-configurator](../snk-configurator)
|
|
156
163
|
- [snk-data-exporter](../snk-data-exporter)
|
|
157
164
|
- [snk-actions-button](../snk-actions-button)
|
|
165
|
+
- [taskbar-split-button](../snk-taskbar/elements/taskbar-split-button)
|
|
158
166
|
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
|
159
167
|
|
|
160
168
|
### Graph
|
|
@@ -166,12 +174,14 @@ graph TD;
|
|
|
166
174
|
snk-crud --> snk-configurator
|
|
167
175
|
snk-crud --> snk-data-exporter
|
|
168
176
|
snk-crud --> snk-actions-button
|
|
177
|
+
snk-crud --> taskbar-split-button
|
|
169
178
|
snk-crud --> taskbar-actions-button
|
|
170
179
|
snk-grid --> snk-filter-bar
|
|
171
180
|
snk-grid --> snk-taskbar
|
|
172
181
|
snk-grid --> snk-grid-config
|
|
173
182
|
snk-grid --> snk-data-exporter
|
|
174
183
|
snk-grid --> snk-actions-button
|
|
184
|
+
snk-grid --> taskbar-split-button
|
|
175
185
|
snk-grid --> taskbar-actions-button
|
|
176
186
|
snk-filter-bar --> snk-filter-item
|
|
177
187
|
snk-filter-bar --> snk-personalized-filter
|
|
@@ -187,6 +197,7 @@ graph TD;
|
|
|
187
197
|
snk-expression-item --> snk-filter-param-config
|
|
188
198
|
snk-taskbar --> snk-data-exporter
|
|
189
199
|
snk-taskbar --> snk-actions-button
|
|
200
|
+
snk-taskbar --> taskbar-split-button
|
|
190
201
|
snk-taskbar --> taskbar-actions-button
|
|
191
202
|
snk-data-exporter --> snk-exporter-email-sender
|
|
192
203
|
snk-grid-config --> snk-select-box
|
|
@@ -198,6 +209,7 @@ graph TD;
|
|
|
198
209
|
snk-guides-viewer --> snk-configurator
|
|
199
210
|
snk-guides-viewer --> snk-data-exporter
|
|
200
211
|
snk-guides-viewer --> snk-actions-button
|
|
212
|
+
snk-guides-viewer --> taskbar-split-button
|
|
201
213
|
snk-guides-viewer --> taskbar-actions-button
|
|
202
214
|
snk-form-view --> snk-form-summary
|
|
203
215
|
snk-detail-view --> snk-data-unit
|
|
@@ -207,17 +219,21 @@ graph TD;
|
|
|
207
219
|
snk-detail-view --> snk-attach
|
|
208
220
|
snk-detail-view --> snk-data-exporter
|
|
209
221
|
snk-detail-view --> snk-actions-button
|
|
222
|
+
snk-detail-view --> taskbar-split-button
|
|
210
223
|
snk-detail-view --> taskbar-actions-button
|
|
211
224
|
snk-attach --> snk-simple-bar
|
|
212
225
|
snk-attach --> snk-simple-crud
|
|
213
|
-
snk-simple-crud --> snk-data-unit
|
|
214
226
|
snk-simple-crud --> snk-taskbar
|
|
215
|
-
snk-simple-crud --> snk-
|
|
227
|
+
snk-simple-crud --> snk-data-unit
|
|
228
|
+
snk-simple-crud --> snk-simple-form-config
|
|
216
229
|
snk-simple-crud --> snk-configurator
|
|
217
230
|
snk-simple-crud --> snk-grid-config
|
|
218
231
|
snk-simple-crud --> snk-data-exporter
|
|
219
232
|
snk-simple-crud --> snk-actions-button
|
|
233
|
+
snk-simple-crud --> taskbar-split-button
|
|
220
234
|
snk-simple-crud --> taskbar-actions-button
|
|
235
|
+
snk-configurator --> snk-layout-form-config
|
|
236
|
+
snk-layout-form-config --> snk-view-representation
|
|
221
237
|
snk-form-config --> snk-field-config
|
|
222
238
|
snk-form-config --> snk-config-options
|
|
223
239
|
snk-form-config --> snk-tab-config
|
|
@@ -15,9 +15,11 @@
|
|
|
15
15
|
| `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
|
|
16
16
|
| `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
|
|
17
17
|
| `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
|
|
18
|
+
| `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
|
|
18
19
|
| `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
|
|
19
20
|
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
20
21
|
| `getCustomTitle` | -- | Fornece uma função para obter um título customizado do formulário. | `() => string` | `undefined` |
|
|
22
|
+
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
|
|
21
23
|
| `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
|
|
22
24
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
23
25
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
|
|
@@ -29,11 +31,12 @@
|
|
|
29
31
|
|
|
30
32
|
## Events
|
|
31
33
|
|
|
32
|
-
| Event
|
|
33
|
-
|
|
|
34
|
-
| `actionClick`
|
|
35
|
-
| `exit`
|
|
36
|
-
| `formItemsReady`
|
|
34
|
+
| Event | Description | Type |
|
|
35
|
+
| --------------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
|
|
36
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
37
|
+
| `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
|
|
38
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
|
39
|
+
| `snkMasterFormConfigChange` | Emitido quando a configuração do formulário master é definida. | `CustomEvent<IFormConfig>` |
|
|
37
40
|
|
|
38
41
|
|
|
39
42
|
## Methods
|
|
@@ -58,16 +61,6 @@ Type: `Promise<void>`
|
|
|
58
61
|
|
|
59
62
|
|
|
60
63
|
|
|
61
|
-
### `findField() => Promise<void>`
|
|
62
|
-
|
|
63
|
-
Abre o localizador de campos
|
|
64
|
-
|
|
65
|
-
#### Returns
|
|
66
|
-
|
|
67
|
-
Type: `Promise<void>`
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
64
|
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
72
65
|
|
|
73
66
|
Altera/adiciona uma propriedade nos metadados do campo.
|
|
@@ -115,6 +108,7 @@ Type: `Promise<void>`
|
|
|
115
108
|
- [snk-configurator](../../snk-configurator)
|
|
116
109
|
- [snk-data-exporter](../../snk-data-exporter)
|
|
117
110
|
- [snk-actions-button](../../snk-actions-button)
|
|
111
|
+
- [taskbar-split-button](../../snk-taskbar/elements/taskbar-split-button)
|
|
118
112
|
- [taskbar-actions-button](../../snk-taskbar/elements/taskbar-actions-button)
|
|
119
113
|
|
|
120
114
|
### Graph
|
|
@@ -128,6 +122,7 @@ graph TD;
|
|
|
128
122
|
snk-guides-viewer --> snk-configurator
|
|
129
123
|
snk-guides-viewer --> snk-data-exporter
|
|
130
124
|
snk-guides-viewer --> snk-actions-button
|
|
125
|
+
snk-guides-viewer --> taskbar-split-button
|
|
131
126
|
snk-guides-viewer --> taskbar-actions-button
|
|
132
127
|
snk-form-view --> snk-form-summary
|
|
133
128
|
snk-detail-view --> snk-data-unit
|
|
@@ -137,12 +132,14 @@ graph TD;
|
|
|
137
132
|
snk-detail-view --> snk-attach
|
|
138
133
|
snk-detail-view --> snk-data-exporter
|
|
139
134
|
snk-detail-view --> snk-actions-button
|
|
135
|
+
snk-detail-view --> taskbar-split-button
|
|
140
136
|
snk-detail-view --> taskbar-actions-button
|
|
141
137
|
snk-grid --> snk-filter-bar
|
|
142
138
|
snk-grid --> snk-taskbar
|
|
143
139
|
snk-grid --> snk-grid-config
|
|
144
140
|
snk-grid --> snk-data-exporter
|
|
145
141
|
snk-grid --> snk-actions-button
|
|
142
|
+
snk-grid --> taskbar-split-button
|
|
146
143
|
snk-grid --> taskbar-actions-button
|
|
147
144
|
snk-filter-bar --> snk-filter-item
|
|
148
145
|
snk-filter-bar --> snk-personalized-filter
|
|
@@ -158,19 +155,23 @@ graph TD;
|
|
|
158
155
|
snk-expression-item --> snk-filter-param-config
|
|
159
156
|
snk-taskbar --> snk-data-exporter
|
|
160
157
|
snk-taskbar --> snk-actions-button
|
|
158
|
+
snk-taskbar --> taskbar-split-button
|
|
161
159
|
snk-taskbar --> taskbar-actions-button
|
|
162
160
|
snk-data-exporter --> snk-exporter-email-sender
|
|
163
161
|
snk-grid-config --> snk-select-box
|
|
164
162
|
snk-attach --> snk-simple-bar
|
|
165
163
|
snk-attach --> snk-simple-crud
|
|
166
|
-
snk-simple-crud --> snk-data-unit
|
|
167
164
|
snk-simple-crud --> snk-taskbar
|
|
168
|
-
snk-simple-crud --> snk-
|
|
165
|
+
snk-simple-crud --> snk-data-unit
|
|
166
|
+
snk-simple-crud --> snk-simple-form-config
|
|
169
167
|
snk-simple-crud --> snk-configurator
|
|
170
168
|
snk-simple-crud --> snk-grid-config
|
|
171
169
|
snk-simple-crud --> snk-data-exporter
|
|
172
170
|
snk-simple-crud --> snk-actions-button
|
|
171
|
+
snk-simple-crud --> taskbar-split-button
|
|
173
172
|
snk-simple-crud --> taskbar-actions-button
|
|
173
|
+
snk-configurator --> snk-layout-form-config
|
|
174
|
+
snk-layout-form-config --> snk-view-representation
|
|
174
175
|
snk-form-config --> snk-field-config
|
|
175
176
|
snk-form-config --> snk-config-options
|
|
176
177
|
snk-form-config --> snk-tab-config
|
|
@@ -7,23 +7,24 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description | Type
|
|
11
|
-
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------- |
|
|
12
|
-
| `branchGuide` | -- | | `IGuideItem`
|
|
13
|
-
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean`
|
|
14
|
-
| `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor`
|
|
15
|
-
| `customRenders` | -- | Render customizados da grade. | `PropsCustomRender`
|
|
16
|
-
| `dataState` | -- | Representa o estado do dataUnit detail. | `DataState`
|
|
17
|
-
| `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit`
|
|
18
|
-
| `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string`
|
|
19
|
-
| `entityName` | `entity-name` | Nome da entidade detail. | `string`
|
|
20
|
-
| `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager`
|
|
21
|
-
| `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]`
|
|
22
|
-
| `label` | `label` | Descrição amigável do cadastro detalhe. | `string`
|
|
23
|
-
| `messagesBuilder` | -- | | `SnkMessageBuilder`
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------- |
|
|
12
|
+
| `branchGuide` | -- | | `IGuideItem` | `undefined` |
|
|
13
|
+
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
|
14
|
+
| `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor` | `undefined` |
|
|
15
|
+
| `customRenders` | -- | Render customizados da grade. | `PropsCustomRender` | `undefined` |
|
|
16
|
+
| `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
|
|
17
|
+
| `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
|
|
18
|
+
| `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
|
|
19
|
+
| `entityName` | `entity-name` | Nome da entidade detail. | `string` | `undefined` |
|
|
20
|
+
| `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager` | `undefined` |
|
|
21
|
+
| `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]` | `undefined` |
|
|
22
|
+
| `label` | `label` | Descrição amigável do cadastro detalhe. | `string` | `undefined` |
|
|
23
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
24
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.SECONDARY` |
|
|
25
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
26
|
+
| `selectedForm` | `selected-form` | Representa o formulário selecionado. | `string` | `undefined` |
|
|
27
|
+
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
|
|
27
28
|
|
|
28
29
|
|
|
29
30
|
## Events
|
|
@@ -103,6 +104,7 @@ Type: `Promise<void>`
|
|
|
103
104
|
- [snk-attach](../../../snk-attach)
|
|
104
105
|
- [snk-data-exporter](../../../snk-data-exporter)
|
|
105
106
|
- [snk-actions-button](../../../snk-actions-button)
|
|
107
|
+
- [taskbar-split-button](../../../snk-taskbar/elements/taskbar-split-button)
|
|
106
108
|
- [taskbar-actions-button](../../../snk-taskbar/elements/taskbar-actions-button)
|
|
107
109
|
|
|
108
110
|
### Graph
|
|
@@ -115,12 +117,14 @@ graph TD;
|
|
|
115
117
|
snk-detail-view --> snk-attach
|
|
116
118
|
snk-detail-view --> snk-data-exporter
|
|
117
119
|
snk-detail-view --> snk-actions-button
|
|
120
|
+
snk-detail-view --> taskbar-split-button
|
|
118
121
|
snk-detail-view --> taskbar-actions-button
|
|
119
122
|
snk-grid --> snk-filter-bar
|
|
120
123
|
snk-grid --> snk-taskbar
|
|
121
124
|
snk-grid --> snk-grid-config
|
|
122
125
|
snk-grid --> snk-data-exporter
|
|
123
126
|
snk-grid --> snk-actions-button
|
|
127
|
+
snk-grid --> taskbar-split-button
|
|
124
128
|
snk-grid --> taskbar-actions-button
|
|
125
129
|
snk-filter-bar --> snk-filter-item
|
|
126
130
|
snk-filter-bar --> snk-personalized-filter
|
|
@@ -136,23 +140,24 @@ graph TD;
|
|
|
136
140
|
snk-expression-item --> snk-filter-param-config
|
|
137
141
|
snk-taskbar --> snk-data-exporter
|
|
138
142
|
snk-taskbar --> snk-actions-button
|
|
143
|
+
snk-taskbar --> taskbar-split-button
|
|
139
144
|
snk-taskbar --> taskbar-actions-button
|
|
140
145
|
snk-data-exporter --> snk-exporter-email-sender
|
|
141
146
|
snk-grid-config --> snk-select-box
|
|
142
147
|
snk-form-view --> snk-form-summary
|
|
143
148
|
snk-attach --> snk-simple-bar
|
|
144
149
|
snk-attach --> snk-simple-crud
|
|
145
|
-
snk-simple-crud --> snk-data-unit
|
|
146
150
|
snk-simple-crud --> snk-taskbar
|
|
147
|
-
snk-simple-crud --> snk-
|
|
151
|
+
snk-simple-crud --> snk-data-unit
|
|
152
|
+
snk-simple-crud --> snk-simple-form-config
|
|
148
153
|
snk-simple-crud --> snk-configurator
|
|
149
154
|
snk-simple-crud --> snk-grid-config
|
|
150
155
|
snk-simple-crud --> snk-data-exporter
|
|
151
156
|
snk-simple-crud --> snk-actions-button
|
|
157
|
+
snk-simple-crud --> taskbar-split-button
|
|
152
158
|
snk-simple-crud --> taskbar-actions-button
|
|
153
|
-
snk-
|
|
154
|
-
snk-form-config --> snk-
|
|
155
|
-
snk-form-config --> snk-tab-config
|
|
159
|
+
snk-configurator --> snk-layout-form-config
|
|
160
|
+
snk-layout-form-config --> snk-view-representation
|
|
156
161
|
snk-guides-viewer --> snk-detail-view
|
|
157
162
|
style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
|
|
158
163
|
```
|