@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-KB-5659036.0 → 0.0.0-hotfix-ga-KB-91371.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 +52 -8
- package/components/snk-attach/readme.md +2 -5
- package/components/snk-crud/readme.md +87 -26
- package/components/snk-crud/subcomponents/readme.md +35 -2
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +24 -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-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 +84 -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
|
|
@@ -401,6 +412,16 @@ Type: `Promise<Map<string, number>>`
|
|
|
401
412
|
|
|
402
413
|
|
|
403
414
|
|
|
415
|
+
### `markToReload(templateSkeletonType?: TEMPLATES_SKELETON) => Promise<void>`
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
#### Returns
|
|
420
|
+
|
|
421
|
+
Type: `Promise<void>`
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
404
425
|
### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
|
405
426
|
|
|
406
427
|
Exibe um diálogo de mensagem comum
|
|
@@ -421,6 +442,17 @@ Type: `Promise<void>`
|
|
|
421
442
|
|
|
422
443
|
|
|
423
444
|
|
|
445
|
+
### `preloadMangerRemoveRecord(dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>`
|
|
446
|
+
|
|
447
|
+
Remove registro do cache do PreLoader do dataunit.
|
|
448
|
+
Deve ser usado quando existe um dataunit usando loader do application, mas o removeLoader está sendo sobrescrito.
|
|
449
|
+
|
|
450
|
+
#### Returns
|
|
451
|
+
|
|
452
|
+
Type: `Promise<void>`
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
424
456
|
### `removeClientEvent(eventID: String) => Promise<void>`
|
|
425
457
|
|
|
426
458
|
Remove um client event para o DataFetcher da aplicação.
|
|
@@ -483,6 +515,16 @@ Type: `Promise<void>`
|
|
|
483
515
|
|
|
484
516
|
|
|
485
517
|
|
|
518
|
+
### `showScrimApp(active: boolean) => Promise<void>`
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
#### Returns
|
|
523
|
+
|
|
524
|
+
Type: `Promise<void>`
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
486
528
|
### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
|
487
529
|
|
|
488
530
|
Exibe o diálogo de sucesso de acordo com os parâmetros passados.
|
|
@@ -548,6 +590,8 @@ SnkApplication carregado.
|
|
|
548
590
|
```mermaid
|
|
549
591
|
graph TD;
|
|
550
592
|
snk-application --> snk-pesquisa
|
|
593
|
+
snk-pesquisa --> pesquisa-grid
|
|
594
|
+
snk-pesquisa --> pesquisa-tree
|
|
551
595
|
teste-pesquisa --> snk-application
|
|
552
596
|
style snk-application fill:#f9f,stroke:#333,stroke-width:4px
|
|
553
597
|
```
|
|
@@ -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,6 @@ 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-form-config --> snk-field-config
|
|
58
|
-
snk-form-config --> snk-config-options
|
|
59
|
-
snk-form-config --> snk-tab-config
|
|
60
57
|
snk-grid-config --> snk-select-box
|
|
61
58
|
snk-crud --> snk-attach
|
|
62
59
|
snk-detail-view --> snk-attach
|
|
@@ -7,38 +7,79 @@
|
|
|
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
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
27
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
|
|
28
|
+
| `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
|
|
29
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
|
30
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
31
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
|
32
|
+
| `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
|
|
33
|
+
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
|
|
34
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
|
35
|
+
| `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
|
|
36
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
37
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
28
38
|
|
|
29
39
|
|
|
30
40
|
## Events
|
|
31
41
|
|
|
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[]>`
|
|
42
|
+
| Event | Description | Type |
|
|
43
|
+
| -------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
|
44
|
+
| `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
45
|
+
| `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
|
|
46
|
+
| `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
|
|
47
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
|
48
|
+
| `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
|
|
38
49
|
|
|
39
50
|
|
|
40
51
|
## Methods
|
|
41
52
|
|
|
53
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
|
54
|
+
|
|
55
|
+
Registra um editor customizado para campos da grade e formulário.
|
|
56
|
+
|
|
57
|
+
#### Returns
|
|
58
|
+
|
|
59
|
+
Type: `Promise<void>`
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
64
|
+
|
|
65
|
+
Registra um formatador de valores para uma coluna da grid.
|
|
66
|
+
|
|
67
|
+
#### Returns
|
|
68
|
+
|
|
69
|
+
Type: `Promise<void>`
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
|
74
|
+
|
|
75
|
+
Registra um render customizado para colunas da grid.
|
|
76
|
+
|
|
77
|
+
#### Returns
|
|
78
|
+
|
|
79
|
+
Type: `Promise<void>`
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
42
83
|
### `closeConfigurator() => Promise<void>`
|
|
43
84
|
|
|
44
85
|
Usado para fechar o configurator do CRUD
|
|
@@ -89,6 +130,26 @@ Type: `Promise<void>`
|
|
|
89
130
|
|
|
90
131
|
|
|
91
132
|
|
|
133
|
+
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
134
|
+
|
|
135
|
+
Remove o formatador de valores de uma coluna da grid.
|
|
136
|
+
|
|
137
|
+
#### Returns
|
|
138
|
+
|
|
139
|
+
Type: `Promise<void>`
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
144
|
+
|
|
145
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
146
|
+
|
|
147
|
+
#### Returns
|
|
148
|
+
|
|
149
|
+
Type: `Promise<void>`
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
92
153
|
|
|
93
154
|
## Dependencies
|
|
94
155
|
|
|
@@ -155,9 +216,9 @@ graph TD;
|
|
|
155
216
|
snk-detail-view --> taskbar-actions-button
|
|
156
217
|
snk-attach --> snk-simple-bar
|
|
157
218
|
snk-attach --> snk-simple-crud
|
|
158
|
-
snk-simple-crud --> snk-data-unit
|
|
159
219
|
snk-simple-crud --> snk-taskbar
|
|
160
|
-
snk-simple-crud --> snk-
|
|
220
|
+
snk-simple-crud --> snk-data-unit
|
|
221
|
+
snk-simple-crud --> snk-simple-form-config
|
|
161
222
|
snk-simple-crud --> snk-configurator
|
|
162
223
|
snk-simple-crud --> snk-grid-config
|
|
163
224
|
snk-simple-crud --> snk-data-exporter
|
|
@@ -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,9 +165,9 @@ 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
|
|
@@ -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,14 @@ 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-form-config --> snk-field-config
|
|
132
|
-
snk-form-config --> snk-config-options
|
|
133
|
-
snk-form-config --> snk-tab-config
|
|
134
153
|
snk-guides-viewer --> snk-detail-view
|
|
135
154
|
style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
|
|
136
155
|
```
|
|
@@ -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.
|
|
@@ -7,17 +7,21 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------------------ | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
|
|
12
|
+
| `afterApplyConfig` | -- | Função chamada depois de aplicar os filtros. | `() => void` | `undefined` |
|
|
13
|
+
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
|
14
|
+
| `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
|
|
15
|
+
| `customFilterBarConfig` | -- | Loader customizado para carregar as configurações | `(configName: string, resourceId: string, options: any) => Promise<SnkFilterItemConfig[]>` | `undefined` |
|
|
16
|
+
| `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
|
|
17
|
+
| `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` |
|
|
18
|
+
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento | `boolean` | `false` |
|
|
19
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
|
20
|
+
| `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
|
|
21
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
22
|
+
| `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
|
|
23
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
24
|
+
| `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
|
21
25
|
|
|
22
26
|
|
|
23
27
|
## Events
|
|
@@ -27,6 +27,16 @@
|
|
|
27
27
|
|
|
28
28
|
## Methods
|
|
29
29
|
|
|
30
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
|
31
|
+
|
|
32
|
+
Registra um editor customizado para campos da grade e formulário.
|
|
33
|
+
|
|
34
|
+
#### Returns
|
|
35
|
+
|
|
36
|
+
Type: `Promise<void>`
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
30
40
|
### `hideConfig() => Promise<void>`
|
|
31
41
|
|
|
32
42
|
Fecha a janela de configurações do formulário.
|
|
@@ -37,6 +47,16 @@ Type: `Promise<void>`
|
|
|
37
47
|
|
|
38
48
|
|
|
39
49
|
|
|
50
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
51
|
+
|
|
52
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
53
|
+
|
|
54
|
+
#### Returns
|
|
55
|
+
|
|
56
|
+
Type: `Promise<void>`
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
40
60
|
### `showConfig() => Promise<void>`
|
|
41
61
|
|
|
42
62
|
Exibe a janela de configurações do formulário.
|
|
@@ -7,11 +7,12 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `configManager`
|
|
13
|
-
| `dataUnit`
|
|
14
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------------------- | ------------------------------ | -------------------------------------------------------------------------------------- | ---------------------- | ----------- |
|
|
12
|
+
| `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
|
|
13
|
+
| `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
|
|
14
|
+
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
|
|
15
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
15
16
|
|
|
16
17
|
|
|
17
18
|
## Events
|
|
@@ -28,7 +29,6 @@
|
|
|
28
29
|
|
|
29
30
|
- [snk-form](../snk-form)
|
|
30
31
|
- [snk-guides-viewer](../snk-crud/subcomponents)
|
|
31
|
-
- [snk-simple-crud](../snk-simple-crud)
|
|
32
32
|
|
|
33
33
|
### Depends on
|
|
34
34
|
|
|
@@ -44,7 +44,6 @@ graph TD;
|
|
|
44
44
|
snk-form-config --> snk-tab-config
|
|
45
45
|
snk-form --> snk-form-config
|
|
46
46
|
snk-guides-viewer --> snk-form-config
|
|
47
|
-
snk-simple-crud --> snk-form-config
|
|
48
47
|
style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
49
48
|
```
|
|
50
49
|
|
|
@@ -7,29 +7,37 @@
|
|
|
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
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
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
|
+
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
|
18
|
+
| `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` |
|
|
19
|
+
| `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
|
|
20
|
+
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
|
|
21
|
+
| `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
|
|
22
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
|
23
|
+
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
|
24
|
+
| `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
|
|
25
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
26
|
+
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
|
|
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. | `boolean` | `undefined` |
|
|
29
|
+
| `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` |
|
|
30
|
+
| `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
|
|
31
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
|
32
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
33
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
34
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
|
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
|
+
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
|
|
38
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
39
|
+
| `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
|
|
40
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
33
41
|
|
|
34
42
|
|
|
35
43
|
## Events
|
|
@@ -42,6 +50,36 @@
|
|
|
42
50
|
|
|
43
51
|
## Methods
|
|
44
52
|
|
|
53
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
|
|
54
|
+
|
|
55
|
+
Registra um editor customizado para campos da grade e formulário
|
|
56
|
+
|
|
57
|
+
#### Returns
|
|
58
|
+
|
|
59
|
+
Type: `Promise<void>`
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
64
|
+
|
|
65
|
+
Registra um formatador de valores para uma coluna da grid.
|
|
66
|
+
|
|
67
|
+
#### Returns
|
|
68
|
+
|
|
69
|
+
Type: `Promise<void>`
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
|
|
74
|
+
|
|
75
|
+
Registra um render customizado para colunas da grid.
|
|
76
|
+
|
|
77
|
+
#### Returns
|
|
78
|
+
|
|
79
|
+
Type: `Promise<void>`
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
45
83
|
### `findColumn() => Promise<void>`
|
|
46
84
|
|
|
47
85
|
Abre o localizador de colunas
|
|
@@ -72,6 +110,16 @@ Type: `Promise<void>`
|
|
|
72
110
|
|
|
73
111
|
|
|
74
112
|
|
|
113
|
+
### `reloadConfig() => Promise<void>`
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
#### Returns
|
|
118
|
+
|
|
119
|
+
Type: `Promise<void>`
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
75
123
|
### `reloadFilterBar() => Promise<void>`
|
|
76
124
|
|
|
77
125
|
Faz o recarregamento da filter-bar da grade buscando o state no servidor.
|
|
@@ -82,6 +130,16 @@ Type: `Promise<void>`
|
|
|
82
130
|
|
|
83
131
|
|
|
84
132
|
|
|
133
|
+
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
134
|
+
|
|
135
|
+
Remove o formatador de valores de uma coluna da grid.
|
|
136
|
+
|
|
137
|
+
#### Returns
|
|
138
|
+
|
|
139
|
+
Type: `Promise<void>`
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
85
143
|
### `setConfig(config: IGridConfig) => Promise<void>`
|
|
86
144
|
|
|
87
145
|
Atribui o valor da configuração da grade.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# pesquisa-grid
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------ | -------------------- | ------------------------------------------------- | -------------- | ----------- |
|
|
12
|
+
| `dataSource` | -- | Registros da grade | `Record[]` | `[]` |
|
|
13
|
+
| `descriptionField` | `description-field` | Campo que representa a descrição do registro | `string` | `undefined` |
|
|
14
|
+
| `entityName` | `entity-name` | Nome da entidade representada na grade | `string` | `undefined` |
|
|
15
|
+
| `metadata` | -- | Campos que representam as colunas da grade. | `UnitMetadata` | `undefined` |
|
|
16
|
+
| `pkField` | `pk-field` | Campo que representa a chave primária do registro | `string` | `undefined` |
|
|
17
|
+
| `shouldLoadConfig` | `should-load-config` | Define se deve carregar configurações da grade | `boolean` | `false` |
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## Events
|
|
21
|
+
|
|
22
|
+
| Event | Description | Type |
|
|
23
|
+
| ------------------------ | ----------- | ---------------------- |
|
|
24
|
+
| `pesquisaGridSelectItem` | | `CustomEvent<IOption>` |
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## Dependencies
|
|
28
|
+
|
|
29
|
+
### Used by
|
|
30
|
+
|
|
31
|
+
- [snk-pesquisa](..)
|
|
32
|
+
|
|
33
|
+
### Graph
|
|
34
|
+
```mermaid
|
|
35
|
+
graph TD;
|
|
36
|
+
snk-pesquisa --> pesquisa-grid
|
|
37
|
+
style pesquisa-grid fill:#f9f,stroke:#333,stroke-width:4px
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
----------------------------------------------
|
|
41
|
+
|
|
42
|
+
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# pesquisa-tree
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
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
|
+
| `shouldLoadTree` | `should-load-tree` | Informa se a árvore hierárquica deve ou não ser carregada. | `boolean` | `false` |
|
|
15
|
+
| `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<ITreeItem[]>` | `undefined` |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Events
|
|
19
|
+
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| ------------------------ | ----------- | ---------------------- |
|
|
22
|
+
| `pesquisaTreeSelectItem` | | `CustomEvent<IOption>` |
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## Methods
|
|
26
|
+
|
|
27
|
+
### `applyFilter() => Promise<void>`
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
#### Returns
|
|
32
|
+
|
|
33
|
+
Type: `Promise<void>`
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## Dependencies
|
|
39
|
+
|
|
40
|
+
### Used by
|
|
41
|
+
|
|
42
|
+
- [snk-pesquisa](..)
|
|
43
|
+
|
|
44
|
+
### Graph
|
|
45
|
+
```mermaid
|
|
46
|
+
graph TD;
|
|
47
|
+
snk-pesquisa --> pesquisa-tree
|
|
48
|
+
style pesquisa-tree fill:#f9f,stroke:#333,stroke-width:4px
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
----------------------------------------------
|
|
52
|
+
|
|
53
|
+
|
|
@@ -7,11 +7,15 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
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 searchLoader. | `string` | `undefined` |
|
|
14
|
+
| `entityName` | `entity-name` | Nome da entidade onde a pesquisa é aplicada. | `string` | `undefined` |
|
|
15
|
+
| `isHierarchyEntity` | `is-hierarchy-entity` | Define se a popup de pesquisa possuirá ou não modo Hierarquico. | `boolean` | `false` |
|
|
16
|
+
| `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. | `(text: string) => Promise<any>` | `undefined` |
|
|
17
|
+
| `selectItem` | -- | Função disparada ao selecionar um item. | `(option: IOption) => void` | `undefined` |
|
|
18
|
+
| `treeLoader` | -- | Função responsável por carregar a árvore hierárquica do componente | `(text: string) => Promise<any>` | `undefined` |
|
|
15
19
|
|
|
16
20
|
|
|
17
21
|
## Dependencies
|
|
@@ -20,9 +24,16 @@
|
|
|
20
24
|
|
|
21
25
|
- [snk-application](../snk-application)
|
|
22
26
|
|
|
27
|
+
### Depends on
|
|
28
|
+
|
|
29
|
+
- [pesquisa-grid](pesquisa-grid)
|
|
30
|
+
- [pesquisa-tree](pesquisa-tree)
|
|
31
|
+
|
|
23
32
|
### Graph
|
|
24
33
|
```mermaid
|
|
25
34
|
graph TD;
|
|
35
|
+
snk-pesquisa --> pesquisa-grid
|
|
36
|
+
snk-pesquisa --> pesquisa-tree
|
|
26
37
|
snk-application --> snk-pesquisa
|
|
27
38
|
style snk-pesquisa fill:#f9f,stroke:#333,stroke-width:4px
|
|
28
39
|
```
|
|
@@ -7,25 +7,36 @@
|
|
|
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
|
-
| `
|
|
28
|
-
| `
|
|
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
|
+
| `dataState` | -- | | `DataState` | `undefined` |
|
|
17
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
18
|
+
| `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
|
|
19
|
+
| `enableContinuousInsert` | `enable-continuous-insert` | | `boolean` | `false` |
|
|
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
|
+
| `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
|
|
24
|
+
| `formConfig` | -- | | `IFormConfig` | `undefined` |
|
|
25
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
26
|
+
| `gridConfig` | -- | | `IGridConfig` | `undefined` |
|
|
27
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
28
|
+
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
|
|
29
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
30
|
+
| `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
|
|
31
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
|
|
32
|
+
| `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` |
|
|
33
|
+
| `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
|
|
34
|
+
| `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
|
|
35
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
36
|
+
| `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
|
|
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
|
+
| `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
|
|
39
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
29
40
|
|
|
30
41
|
|
|
31
42
|
## Events
|
|
@@ -42,6 +53,36 @@
|
|
|
42
53
|
|
|
43
54
|
## Methods
|
|
44
55
|
|
|
56
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
|
57
|
+
|
|
58
|
+
Registra um editor customizado para campos da grade e formulário.
|
|
59
|
+
|
|
60
|
+
#### Returns
|
|
61
|
+
|
|
62
|
+
Type: `Promise<void>`
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
67
|
+
|
|
68
|
+
Registra um formatador de valores para uma coluna da grid.
|
|
69
|
+
|
|
70
|
+
#### Returns
|
|
71
|
+
|
|
72
|
+
Type: `Promise<void>`
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
|
77
|
+
|
|
78
|
+
Registra um render customizado para colunas da grid.
|
|
79
|
+
|
|
80
|
+
#### Returns
|
|
81
|
+
|
|
82
|
+
Type: `Promise<void>`
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
45
86
|
### `closeConfigurator() => Promise<void>`
|
|
46
87
|
|
|
47
88
|
Usado para fechar o configurator do CRUD
|
|
@@ -82,6 +123,26 @@ Type: `Promise<void>`
|
|
|
82
123
|
|
|
83
124
|
|
|
84
125
|
|
|
126
|
+
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
127
|
+
|
|
128
|
+
Remove o formatador de valores de uma coluna da grid.
|
|
129
|
+
|
|
130
|
+
#### Returns
|
|
131
|
+
|
|
132
|
+
Type: `Promise<void>`
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
137
|
+
|
|
138
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
139
|
+
|
|
140
|
+
#### Returns
|
|
141
|
+
|
|
142
|
+
Type: `Promise<void>`
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
85
146
|
### `setMetadata(metadata: UnitMetadata) => Promise<void>`
|
|
86
147
|
|
|
87
148
|
|
|
@@ -121,9 +182,9 @@ Type: `Promise<void>`
|
|
|
121
182
|
|
|
122
183
|
### Depends on
|
|
123
184
|
|
|
124
|
-
- [snk-data-unit](../snk-data-unit)
|
|
125
185
|
- [snk-taskbar](../snk-taskbar)
|
|
126
|
-
- [snk-
|
|
186
|
+
- [snk-data-unit](../snk-data-unit)
|
|
187
|
+
- [snk-simple-form-config](../snk-simple-form-config)
|
|
127
188
|
- [snk-configurator](../snk-configurator)
|
|
128
189
|
- [snk-grid-config](../snk-grid-config)
|
|
129
190
|
- [snk-data-exporter](../snk-data-exporter)
|
|
@@ -133,9 +194,9 @@ Type: `Promise<void>`
|
|
|
133
194
|
### Graph
|
|
134
195
|
```mermaid
|
|
135
196
|
graph TD;
|
|
136
|
-
snk-simple-crud --> snk-data-unit
|
|
137
197
|
snk-simple-crud --> snk-taskbar
|
|
138
|
-
snk-simple-crud --> snk-
|
|
198
|
+
snk-simple-crud --> snk-data-unit
|
|
199
|
+
snk-simple-crud --> snk-simple-form-config
|
|
139
200
|
snk-simple-crud --> snk-configurator
|
|
140
201
|
snk-simple-crud --> snk-grid-config
|
|
141
202
|
snk-simple-crud --> snk-data-exporter
|
|
@@ -145,9 +206,6 @@ graph TD;
|
|
|
145
206
|
snk-taskbar --> snk-actions-button
|
|
146
207
|
snk-taskbar --> taskbar-actions-button
|
|
147
208
|
snk-data-exporter --> snk-exporter-email-sender
|
|
148
|
-
snk-form-config --> snk-field-config
|
|
149
|
-
snk-form-config --> snk-config-options
|
|
150
|
-
snk-form-config --> snk-tab-config
|
|
151
209
|
snk-grid-config --> snk-select-box
|
|
152
210
|
snk-attach --> snk-simple-crud
|
|
153
211
|
style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# snk-simple-form-config
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
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
|
+
|
|
15
|
+
|
|
16
|
+
## Events
|
|
17
|
+
|
|
18
|
+
| Event | Description | Type |
|
|
19
|
+
| ---------------- | ----------- | ------------------- |
|
|
20
|
+
| `snkConfigSaved` | | `CustomEvent<void>` |
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## Methods
|
|
24
|
+
|
|
25
|
+
### `show() => Promise<void>`
|
|
26
|
+
|
|
27
|
+
Responsável por abrir o configurador.
|
|
28
|
+
|
|
29
|
+
#### Returns
|
|
30
|
+
|
|
31
|
+
Type: `Promise<void>`
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
## Dependencies
|
|
37
|
+
|
|
38
|
+
### Used by
|
|
39
|
+
|
|
40
|
+
- [snk-simple-crud](../snk-simple-crud)
|
|
41
|
+
|
|
42
|
+
### Graph
|
|
43
|
+
```mermaid
|
|
44
|
+
graph TD;
|
|
45
|
+
snk-simple-crud --> snk-simple-form-config
|
|
46
|
+
style snk-simple-form-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
----------------------------------------------
|
|
50
|
+
|
|
51
|
+
|