@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-5693172.1 → 0.0.0-hotfix-ga-5726442.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/components/snk-application/readme.md +62 -8
- package/components/snk-attach/readme.md +4 -5
- package/components/snk-configurator/readme.md +7 -0
- package/components/snk-crud/readme.md +90 -26
- package/components/snk-crud/subcomponents/readme.md +37 -2
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +26 -5
- package/components/snk-data-unit/readme.md +53 -21
- package/components/snk-filter-bar/readme.md +15 -11
- package/components/snk-form/readme.md +20 -0
- package/components/snk-form-config/readme.md +6 -7
- package/components/snk-grid/readme.md +81 -23
- 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 +87 -26
- package/components/snk-simple-form-config/readme.md +51 -0
- 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.
|
|
@@ -138,7 +149,7 @@ Type: `Promise<IOption | IOption[]>`
|
|
|
138
149
|
|
|
139
150
|
|
|
140
151
|
|
|
141
|
-
### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit) => Promise<Array<IOption> | IOption>`
|
|
152
|
+
### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption> | IOption>`
|
|
142
153
|
|
|
143
154
|
Obtém as opções em componentes de pesquisa
|
|
144
155
|
Ex.: snk-config-options
|
|
@@ -281,6 +292,16 @@ Type: `Promise<KeyboardManager>`
|
|
|
281
292
|
|
|
282
293
|
the keyboard manager
|
|
283
294
|
|
|
295
|
+
### `getLayoutFormConfig() => Promise<LayoutFormConfig>`
|
|
296
|
+
|
|
297
|
+
Obtém o notificador de Layout de formulario.
|
|
298
|
+
|
|
299
|
+
#### Returns
|
|
300
|
+
|
|
301
|
+
Type: `Promise<LayoutFormConfig>`
|
|
302
|
+
|
|
303
|
+
the Configurador de Layout do Formulario
|
|
304
|
+
|
|
284
305
|
### `getResourceID() => Promise<string>`
|
|
285
306
|
|
|
286
307
|
Obtém o resourceID da tela em questão.
|
|
@@ -401,6 +422,16 @@ Type: `Promise<Map<string, number>>`
|
|
|
401
422
|
|
|
402
423
|
|
|
403
424
|
|
|
425
|
+
### `markToReload(templateSkeletonType?: TEMPLATES_SKELETON) => Promise<void>`
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
#### Returns
|
|
430
|
+
|
|
431
|
+
Type: `Promise<void>`
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
404
435
|
### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
|
405
436
|
|
|
406
437
|
Exibe um diálogo de mensagem comum
|
|
@@ -421,6 +452,17 @@ Type: `Promise<void>`
|
|
|
421
452
|
|
|
422
453
|
|
|
423
454
|
|
|
455
|
+
### `preloadMangerRemoveRecord(dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>`
|
|
456
|
+
|
|
457
|
+
Remove registro do cache do PreLoader do dataunit.
|
|
458
|
+
Deve ser usado quando existe um dataunit usando loader do application, mas o removeLoader está sendo sobrescrito.
|
|
459
|
+
|
|
460
|
+
#### Returns
|
|
461
|
+
|
|
462
|
+
Type: `Promise<void>`
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
424
466
|
### `removeClientEvent(eventID: String) => Promise<void>`
|
|
425
467
|
|
|
426
468
|
Remove um client event para o DataFetcher da aplicação.
|
|
@@ -483,6 +525,16 @@ Type: `Promise<void>`
|
|
|
483
525
|
|
|
484
526
|
|
|
485
527
|
|
|
528
|
+
### `showScrimApp(active: boolean) => Promise<void>`
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
#### Returns
|
|
533
|
+
|
|
534
|
+
Type: `Promise<void>`
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
486
538
|
### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
|
487
539
|
|
|
488
540
|
Exibe o diálogo de sucesso de acordo com os parâmetros passados.
|
|
@@ -548,6 +600,8 @@ SnkApplication carregado.
|
|
|
548
600
|
```mermaid
|
|
549
601
|
graph TD;
|
|
550
602
|
snk-application --> snk-pesquisa
|
|
603
|
+
snk-pesquisa --> pesquisa-grid
|
|
604
|
+
snk-pesquisa --> pesquisa-tree
|
|
551
605
|
teste-pesquisa --> snk-application
|
|
552
606
|
style snk-application fill:#f9f,stroke:#333,stroke-width:4px
|
|
553
607
|
```
|
|
@@ -42,9 +42,9 @@
|
|
|
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
|
|
@@ -54,9 +54,8 @@ graph TD;
|
|
|
54
54
|
snk-taskbar --> snk-actions-button
|
|
55
55
|
snk-taskbar --> taskbar-actions-button
|
|
56
56
|
snk-data-exporter --> snk-exporter-email-sender
|
|
57
|
-
snk-
|
|
58
|
-
snk-form-config --> snk-
|
|
59
|
-
snk-form-config --> snk-tab-config
|
|
57
|
+
snk-configurator --> snk-layout-form-config
|
|
58
|
+
snk-layout-form-config --> snk-view-representation
|
|
60
59
|
snk-grid-config --> snk-select-box
|
|
61
60
|
snk-crud --> snk-attach
|
|
62
61
|
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,38 +7,80 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `actionsList`
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
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` | | `boolean` | `false` |
|
|
27
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
28
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
|
|
29
|
+
| `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
|
|
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` |
|
|
28
39
|
|
|
29
40
|
|
|
30
41
|
## Events
|
|
31
42
|
|
|
32
|
-
| Event | Description | Type
|
|
33
|
-
| -------------------- | ------------------------------------------------------------------------------- |
|
|
34
|
-
| `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>`
|
|
35
|
-
| `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>`
|
|
36
|
-
| `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>`
|
|
37
|
-
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>`
|
|
43
|
+
| Event | Description | Type |
|
|
44
|
+
| -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
|
45
|
+
| `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
46
|
+
| `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
|
|
47
|
+
| `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
|
|
48
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
|
49
|
+
| `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
|
|
38
50
|
|
|
39
51
|
|
|
40
52
|
## Methods
|
|
41
53
|
|
|
54
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
|
55
|
+
|
|
56
|
+
Registra um editor customizado para campos da grade e formulário.
|
|
57
|
+
|
|
58
|
+
#### Returns
|
|
59
|
+
|
|
60
|
+
Type: `Promise<void>`
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
65
|
+
|
|
66
|
+
Registra um formatador de valores para uma coluna da grid.
|
|
67
|
+
|
|
68
|
+
#### Returns
|
|
69
|
+
|
|
70
|
+
Type: `Promise<void>`
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
|
75
|
+
|
|
76
|
+
Registra um render customizado para colunas da grid.
|
|
77
|
+
|
|
78
|
+
#### Returns
|
|
79
|
+
|
|
80
|
+
Type: `Promise<void>`
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
42
84
|
### `closeConfigurator() => Promise<void>`
|
|
43
85
|
|
|
44
86
|
Usado para fechar o configurator do CRUD
|
|
@@ -89,6 +131,26 @@ Type: `Promise<void>`
|
|
|
89
131
|
|
|
90
132
|
|
|
91
133
|
|
|
134
|
+
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
135
|
+
|
|
136
|
+
Remove o formatador de valores de uma coluna da grid.
|
|
137
|
+
|
|
138
|
+
#### Returns
|
|
139
|
+
|
|
140
|
+
Type: `Promise<void>`
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
145
|
+
|
|
146
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
147
|
+
|
|
148
|
+
#### Returns
|
|
149
|
+
|
|
150
|
+
Type: `Promise<void>`
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
92
154
|
|
|
93
155
|
## Dependencies
|
|
94
156
|
|
|
@@ -155,14 +217,16 @@ graph TD;
|
|
|
155
217
|
snk-detail-view --> taskbar-actions-button
|
|
156
218
|
snk-attach --> snk-simple-bar
|
|
157
219
|
snk-attach --> snk-simple-crud
|
|
158
|
-
snk-simple-crud --> snk-data-unit
|
|
159
220
|
snk-simple-crud --> snk-taskbar
|
|
160
|
-
snk-simple-crud --> snk-
|
|
221
|
+
snk-simple-crud --> snk-data-unit
|
|
222
|
+
snk-simple-crud --> snk-simple-form-config
|
|
161
223
|
snk-simple-crud --> snk-configurator
|
|
162
224
|
snk-simple-crud --> snk-grid-config
|
|
163
225
|
snk-simple-crud --> snk-data-exporter
|
|
164
226
|
snk-simple-crud --> snk-actions-button
|
|
165
227
|
snk-simple-crud --> taskbar-actions-button
|
|
228
|
+
snk-configurator --> snk-layout-form-config
|
|
229
|
+
snk-layout-form-config --> snk-view-representation
|
|
166
230
|
snk-form-config --> snk-field-config
|
|
167
231
|
snk-form-config --> snk-config-options
|
|
168
232
|
snk-form-config --> snk-tab-config
|
|
@@ -15,8 +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` |
|
|
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` |
|
|
20
23
|
| `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
|
|
21
24
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
22
25
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
|
|
@@ -37,6 +40,26 @@
|
|
|
37
40
|
|
|
38
41
|
## Methods
|
|
39
42
|
|
|
43
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
|
44
|
+
|
|
45
|
+
Registra um editor customizado para campos da grade e formulário
|
|
46
|
+
|
|
47
|
+
#### Returns
|
|
48
|
+
|
|
49
|
+
Type: `Promise<void>`
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
|
54
|
+
|
|
55
|
+
Registra um render customizado para colunas da grid.
|
|
56
|
+
|
|
57
|
+
#### Returns
|
|
58
|
+
|
|
59
|
+
Type: `Promise<void>`
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
40
63
|
### `findField() => Promise<void>`
|
|
41
64
|
|
|
42
65
|
Abre o localizador de campos
|
|
@@ -47,6 +70,16 @@ Type: `Promise<void>`
|
|
|
47
70
|
|
|
48
71
|
|
|
49
72
|
|
|
73
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
74
|
+
|
|
75
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
76
|
+
|
|
77
|
+
#### Returns
|
|
78
|
+
|
|
79
|
+
Type: `Promise<void>`
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
50
83
|
### `setFocus() => Promise<void>`
|
|
51
84
|
|
|
52
85
|
Atribui o foco para o componente.
|
|
@@ -132,14 +165,16 @@ graph TD;
|
|
|
132
165
|
snk-grid-config --> snk-select-box
|
|
133
166
|
snk-attach --> snk-simple-bar
|
|
134
167
|
snk-attach --> snk-simple-crud
|
|
135
|
-
snk-simple-crud --> snk-data-unit
|
|
136
168
|
snk-simple-crud --> snk-taskbar
|
|
137
|
-
snk-simple-crud --> snk-
|
|
169
|
+
snk-simple-crud --> snk-data-unit
|
|
170
|
+
snk-simple-crud --> snk-simple-form-config
|
|
138
171
|
snk-simple-crud --> snk-configurator
|
|
139
172
|
snk-simple-crud --> snk-grid-config
|
|
140
173
|
snk-simple-crud --> snk-data-exporter
|
|
141
174
|
snk-simple-crud --> snk-actions-button
|
|
142
175
|
snk-simple-crud --> taskbar-actions-button
|
|
176
|
+
snk-configurator --> snk-layout-form-config
|
|
177
|
+
snk-layout-form-config --> snk-view-representation
|
|
143
178
|
snk-form-config --> snk-field-config
|
|
144
179
|
snk-form-config --> snk-config-options
|
|
145
180
|
snk-form-config --> snk-tab-config
|
|
@@ -11,6 +11,8 @@
|
|
|
11
11
|
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------- | ---------------------- | ----------- |
|
|
12
12
|
| `branchGuide` | -- | | `IGuideItem` | `undefined` |
|
|
13
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` |
|
|
14
16
|
| `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
|
|
15
17
|
| `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
|
|
16
18
|
| `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
|
|
@@ -35,6 +37,26 @@
|
|
|
35
37
|
|
|
36
38
|
## Methods
|
|
37
39
|
|
|
40
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
|
41
|
+
|
|
42
|
+
Registra um editor customizado para campos da grade e formulário.
|
|
43
|
+
|
|
44
|
+
#### Returns
|
|
45
|
+
|
|
46
|
+
Type: `Promise<void>`
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
|
51
|
+
|
|
52
|
+
Registra um render customizado para colunas da grid.
|
|
53
|
+
|
|
54
|
+
#### Returns
|
|
55
|
+
|
|
56
|
+
Type: `Promise<void>`
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
38
60
|
### `changeViewMode(mode: VIEW_MODE) => Promise<void>`
|
|
39
61
|
|
|
40
62
|
Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FORM
|
|
@@ -120,17 +142,16 @@ graph TD;
|
|
|
120
142
|
snk-form-view --> snk-form-summary
|
|
121
143
|
snk-attach --> snk-simple-bar
|
|
122
144
|
snk-attach --> snk-simple-crud
|
|
123
|
-
snk-simple-crud --> snk-data-unit
|
|
124
145
|
snk-simple-crud --> snk-taskbar
|
|
125
|
-
snk-simple-crud --> snk-
|
|
146
|
+
snk-simple-crud --> snk-data-unit
|
|
147
|
+
snk-simple-crud --> snk-simple-form-config
|
|
126
148
|
snk-simple-crud --> snk-configurator
|
|
127
149
|
snk-simple-crud --> snk-grid-config
|
|
128
150
|
snk-simple-crud --> snk-data-exporter
|
|
129
151
|
snk-simple-crud --> snk-actions-button
|
|
130
152
|
snk-simple-crud --> taskbar-actions-button
|
|
131
|
-
snk-
|
|
132
|
-
snk-form-config --> snk-
|
|
133
|
-
snk-form-config --> snk-tab-config
|
|
153
|
+
snk-configurator --> snk-layout-form-config
|
|
154
|
+
snk-layout-form-config --> snk-view-representation
|
|
134
155
|
snk-guides-viewer --> snk-detail-view
|
|
135
156
|
style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
|
|
136
157
|
```
|
|
@@ -7,31 +7,33 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `afterSave`
|
|
13
|
-
| `beforeSave`
|
|
14
|
-
| `configName`
|
|
15
|
-
| `dataState`
|
|
16
|
-
| `dataUnit`
|
|
17
|
-
| `dataUnitName`
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------- |
|
|
12
|
+
| `afterSave` | -- | Executado após a ação de salvar. | `(dataUnit: DataUnit) => void` | `undefined` |
|
|
13
|
+
| `beforeSave` | -- | Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação. | `(dataUnit: DataUnit) => boolean \| Promise<boolean>` | `undefined` |
|
|
14
|
+
| `configName` | `config-name` | Usado para obter configuração de metadados. | `string` | `undefined` |
|
|
15
|
+
| `dataState` | -- | Controla o estado atual dos dados. | `DataState` | `undefined` |
|
|
16
|
+
| `dataUnit` | -- | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. | `DataUnit` | `undefined` |
|
|
17
|
+
| `dataUnitName` | `data-unit-name` | Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. | `string` | `undefined` |
|
|
18
|
+
| `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
|
|
19
|
+
| `entityName` | `entity-name` | Determina qual a entidade que representa os dados em questão. | `string` | `undefined` |
|
|
20
|
+
| `ignoreSaveMessage` | `ignore-save-message` | Responsável por evitar a mensagem de sucesso ao salvar. | `boolean` | `undefined` |
|
|
21
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
22
|
+
| `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
|
|
23
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
24
|
+
| `useCancelConfirm` | `use-cancel-confirm` | Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. | `boolean` | `true` |
|
|
24
25
|
|
|
25
26
|
|
|
26
27
|
## Events
|
|
27
28
|
|
|
28
|
-
| Event | Description
|
|
29
|
-
| ------------------------ |
|
|
30
|
-
| `cancelEdition` | Emitido quando se cancela uma inserção ou cópia.
|
|
31
|
-
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit.
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
| `
|
|
29
|
+
| Event | Description | Type |
|
|
30
|
+
| ------------------------ | ------------------------------------------------------------- | -------------------------------- |
|
|
31
|
+
| `cancelEdition` | Emitido quando se cancela uma inserção ou cópia. | `CustomEvent<void>` |
|
|
32
|
+
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
|
|
33
|
+
| `dataUnitFieldsHidded` | Emitido quando há campos no DataUnit que devem ser ocultados. | `CustomEvent<void>` |
|
|
34
|
+
| `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
|
|
35
|
+
| `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
|
|
36
|
+
| `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
|
|
35
37
|
|
|
36
38
|
|
|
37
39
|
## Methods
|
|
@@ -46,6 +48,36 @@ Type: `Promise<DataUnit>`
|
|
|
46
48
|
|
|
47
49
|
|
|
48
50
|
|
|
51
|
+
### `getFieldsWithRmPrecision() => Promise<string[]>`
|
|
52
|
+
|
|
53
|
+
Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
|
|
54
|
+
|
|
55
|
+
#### Returns
|
|
56
|
+
|
|
57
|
+
Type: `Promise<string[]>`
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### `getFieldsWithRmp() => Promise<string[]>`
|
|
62
|
+
|
|
63
|
+
Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
|
|
64
|
+
|
|
65
|
+
#### Returns
|
|
66
|
+
|
|
67
|
+
Type: `Promise<string[]>`
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
|
|
72
|
+
|
|
73
|
+
Busca os metadados da linha selecionada.
|
|
74
|
+
|
|
75
|
+
#### Returns
|
|
76
|
+
|
|
77
|
+
Type: `Promise<RowMetadata>`
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
49
81
|
### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
|
|
50
82
|
|
|
51
83
|
Método que retorna a lista de IDs dos registros selecionados.
|