@sankhyalabs/sankhyablocks-docs 8.15.0-dev.7 → 8.15.0-dev.71
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 +19 -7
- package/components/snk-attach/readme.md +16 -5
- package/components/snk-configurator/readme.md +2 -0
- package/components/snk-crud/readme.md +72 -13
- package/components/snk-crud/subcomponents/readme.md +45 -1
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +28 -0
- package/components/snk-data-unit/readme.md +38 -7
- package/components/snk-filter-bar/filter-item/readme.md +5 -4
- package/components/snk-filter-bar/filter-modal/readme.md +12 -11
- package/components/snk-filter-bar/readme.md +22 -7
- package/components/snk-form/readme.md +28 -7
- package/components/{snk-form/subcomponents/snk-form-config → snk-form-config}/readme.md +7 -5
- package/components/{snk-form → snk-form-config}/subcomponents/snk-config-options/readme.md +1 -1
- package/components/{snk-form → snk-form-config}/subcomponents/snk-field-config/readme.md +1 -1
- package/components/{snk-form → snk-form-config}/subcomponents/snk-tab-config/readme.md +1 -1
- package/components/snk-grid/readme.md +75 -20
- package/components/{snk-grid/subcomponents/snk-grid-config → snk-grid-config}/readme.md +4 -3
- package/components/{snk-grid/subcomponents → snk-grid-config}/snk-select-box/readme.md +1 -1
- package/components/snk-simple-crud/readme.md +120 -18
- package/components/snk-taskbar/readme.md +2 -0
- package/package.json +1 -1
|
@@ -7,11 +7,13 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `configName`
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
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
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
14
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
15
|
+
| `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: Record<string, any>; }) => void` | `undefined` |
|
|
16
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
15
17
|
|
|
16
18
|
|
|
17
19
|
## Events
|
|
@@ -104,7 +106,7 @@ Type: `Promise<boolean>`
|
|
|
104
106
|
|
|
105
107
|
|
|
106
108
|
|
|
107
|
-
### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
|
|
109
|
+
### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string, options?: GetDataUnitOptions) => Promise<DataUnit>`
|
|
108
110
|
|
|
109
111
|
Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
|
|
110
112
|
passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
|
|
@@ -229,7 +231,7 @@ Type: `Promise<DataFetcher>`
|
|
|
229
231
|
|
|
230
232
|
DataFetcher do application
|
|
231
233
|
|
|
232
|
-
### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
|
|
234
|
+
### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string, options?: GetDataUnitOptions) => Promise<DataUnit>`
|
|
233
235
|
|
|
234
236
|
Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
|
|
235
237
|
|
|
@@ -439,6 +441,16 @@ Type: `Promise<any>`
|
|
|
439
441
|
|
|
440
442
|
|
|
441
443
|
|
|
444
|
+
### `setSearchFilterContext(name: string, value: string) => Promise<void>`
|
|
445
|
+
|
|
446
|
+
Atribui valor para parâmetros de contexto no componente de pesquisa.
|
|
447
|
+
|
|
448
|
+
#### Returns
|
|
449
|
+
|
|
450
|
+
Type: `Promise<void>`
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
442
454
|
### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
|
|
443
455
|
|
|
444
456
|
Apresenta uma lista de alertas,
|
|
@@ -7,11 +7,15 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description | Type
|
|
11
|
-
| -------------------------- | -------------- | -------------------------------------------------------------------------------------- |
|
|
12
|
-
| `
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------------------- | -------------- | -------------------------------------------------------------------------------------- | ----------------------------------------- | ----------- |
|
|
12
|
+
| `dataUnit` | -- | DataUnit responsável por carregar os dados. | `DataUnit` | `undefined` |
|
|
13
|
+
| `dataUnitBuilder` | -- | DataUnitBuilder responsável por implementar dados a serem utilizados no DataUnit. | `FetcherFacade` | `undefined` |
|
|
14
|
+
| `entityName` | `entity-name` | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. | `string` | `undefined` |
|
|
15
|
+
| `fetcher` | -- | Fetcher responsável por carregar os dados do DataUnit. | `AttachFetcherFacadeInterface` | `undefined` |
|
|
16
|
+
| `fetcherType` | `fetcher-type` | FetcherType define o tipo de fetcher responsável por carregar os dados do DataUnit. | `"AnexoSistema" \| "Another" \| "Attach"` | `undefined` |
|
|
17
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
18
|
+
| `registerKey` _(required)_ | `register-key` | Identificação do registro pai. | `string` | `undefined` |
|
|
15
19
|
|
|
16
20
|
|
|
17
21
|
## Events
|
|
@@ -40,6 +44,9 @@ graph TD;
|
|
|
40
44
|
snk-attach --> snk-simple-crud
|
|
41
45
|
snk-simple-crud --> snk-data-unit
|
|
42
46
|
snk-simple-crud --> snk-taskbar
|
|
47
|
+
snk-simple-crud --> snk-form-config
|
|
48
|
+
snk-simple-crud --> snk-configurator
|
|
49
|
+
snk-simple-crud --> snk-grid-config
|
|
43
50
|
snk-simple-crud --> snk-data-exporter
|
|
44
51
|
snk-simple-crud --> snk-actions-button
|
|
45
52
|
snk-simple-crud --> taskbar-actions-button
|
|
@@ -47,6 +54,10 @@ graph TD;
|
|
|
47
54
|
snk-taskbar --> snk-actions-button
|
|
48
55
|
snk-taskbar --> taskbar-actions-button
|
|
49
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
|
+
snk-grid-config --> snk-select-box
|
|
50
61
|
snk-crud --> snk-attach
|
|
51
62
|
snk-detail-view --> snk-attach
|
|
52
63
|
style snk-attach fill:#f9f,stroke:#333,stroke-width:4px
|
|
@@ -56,12 +56,14 @@ Type: `Promise<void>`
|
|
|
56
56
|
|
|
57
57
|
- [snk-crud](../snk-crud)
|
|
58
58
|
- [snk-guides-viewer](../snk-crud/subcomponents)
|
|
59
|
+
- [snk-simple-crud](../snk-simple-crud)
|
|
59
60
|
|
|
60
61
|
### Graph
|
|
61
62
|
```mermaid
|
|
62
63
|
graph TD;
|
|
63
64
|
snk-crud --> snk-configurator
|
|
64
65
|
snk-guides-viewer --> snk-configurator
|
|
66
|
+
snk-simple-crud --> snk-configurator
|
|
65
67
|
style snk-configurator fill:#f9f,stroke:#333,stroke-width:4px
|
|
66
68
|
```
|
|
67
69
|
|
|
@@ -7,19 +7,25 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `actionsList`
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
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
|
+
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
|
14
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
15
|
+
| `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` |
|
|
16
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
|
17
|
+
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
|
18
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
19
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
20
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
21
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
|
|
22
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
|
23
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
24
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
|
25
|
+
| `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `false` |
|
|
26
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
|
27
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
28
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
23
29
|
|
|
24
30
|
|
|
25
31
|
## Events
|
|
@@ -34,6 +40,36 @@
|
|
|
34
40
|
|
|
35
41
|
## Methods
|
|
36
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
|
+
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
54
|
+
|
|
55
|
+
Registra um formatador de valores para uma coluna da grid.
|
|
56
|
+
|
|
57
|
+
#### Returns
|
|
58
|
+
|
|
59
|
+
Type: `Promise<void>`
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
|
64
|
+
|
|
65
|
+
Registra um render customizado para colunas da grid.
|
|
66
|
+
|
|
67
|
+
#### Returns
|
|
68
|
+
|
|
69
|
+
Type: `Promise<void>`
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
37
73
|
### `closeConfigurator() => Promise<void>`
|
|
38
74
|
|
|
39
75
|
Usado para fechar o configurator do CRUD
|
|
@@ -84,6 +120,26 @@ Type: `Promise<void>`
|
|
|
84
120
|
|
|
85
121
|
|
|
86
122
|
|
|
123
|
+
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
124
|
+
|
|
125
|
+
Remove o formatador de valores de uma coluna da grid.
|
|
126
|
+
|
|
127
|
+
#### Returns
|
|
128
|
+
|
|
129
|
+
Type: `Promise<void>`
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
134
|
+
|
|
135
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
136
|
+
|
|
137
|
+
#### Returns
|
|
138
|
+
|
|
139
|
+
Type: `Promise<void>`
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
87
143
|
|
|
88
144
|
## Dependencies
|
|
89
145
|
|
|
@@ -152,6 +208,9 @@ graph TD;
|
|
|
152
208
|
snk-attach --> snk-simple-crud
|
|
153
209
|
snk-simple-crud --> snk-data-unit
|
|
154
210
|
snk-simple-crud --> snk-taskbar
|
|
211
|
+
snk-simple-crud --> snk-form-config
|
|
212
|
+
snk-simple-crud --> snk-configurator
|
|
213
|
+
snk-simple-crud --> snk-grid-config
|
|
155
214
|
snk-simple-crud --> snk-data-exporter
|
|
156
215
|
snk-simple-crud --> snk-actions-button
|
|
157
216
|
snk-simple-crud --> taskbar-actions-button
|
|
@@ -16,6 +16,7 @@
|
|
|
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
18
|
| `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
|
|
19
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
19
20
|
| `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
|
|
20
21
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
21
22
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
|
|
@@ -36,6 +37,26 @@
|
|
|
36
37
|
|
|
37
38
|
## Methods
|
|
38
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
|
+
|
|
39
60
|
### `findField() => Promise<void>`
|
|
40
61
|
|
|
41
62
|
Abre o localizador de campos
|
|
@@ -46,6 +67,26 @@ Type: `Promise<void>`
|
|
|
46
67
|
|
|
47
68
|
|
|
48
69
|
|
|
70
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
71
|
+
|
|
72
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
73
|
+
|
|
74
|
+
#### Returns
|
|
75
|
+
|
|
76
|
+
Type: `Promise<void>`
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
### `setFocus() => Promise<void>`
|
|
81
|
+
|
|
82
|
+
Atribui o foco para o componente.
|
|
83
|
+
|
|
84
|
+
#### Returns
|
|
85
|
+
|
|
86
|
+
Type: `Promise<void>`
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
49
90
|
### `showFormConfig(detail?: boolean) => Promise<void>`
|
|
50
91
|
|
|
51
92
|
Abre o configurador do formulário
|
|
@@ -69,7 +110,7 @@ Type: `Promise<void>`
|
|
|
69
110
|
- [snk-data-unit](../../snk-data-unit)
|
|
70
111
|
- [snk-detail-view](snk-detail-view)
|
|
71
112
|
- [snk-taskbar](../../snk-taskbar)
|
|
72
|
-
- [snk-form-config](../../snk-form
|
|
113
|
+
- [snk-form-config](../../snk-form-config)
|
|
73
114
|
- [snk-configurator](../../snk-configurator)
|
|
74
115
|
- [snk-data-exporter](../../snk-data-exporter)
|
|
75
116
|
- [snk-actions-button](../../snk-actions-button)
|
|
@@ -123,6 +164,9 @@ graph TD;
|
|
|
123
164
|
snk-attach --> snk-simple-crud
|
|
124
165
|
snk-simple-crud --> snk-data-unit
|
|
125
166
|
snk-simple-crud --> snk-taskbar
|
|
167
|
+
snk-simple-crud --> snk-form-config
|
|
168
|
+
snk-simple-crud --> snk-configurator
|
|
169
|
+
snk-simple-crud --> snk-grid-config
|
|
126
170
|
snk-simple-crud --> snk-data-exporter
|
|
127
171
|
snk-simple-crud --> snk-actions-button
|
|
128
172
|
snk-simple-crud --> taskbar-actions-button
|
|
@@ -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
|
|
@@ -122,9 +144,15 @@ graph TD;
|
|
|
122
144
|
snk-attach --> snk-simple-crud
|
|
123
145
|
snk-simple-crud --> snk-data-unit
|
|
124
146
|
snk-simple-crud --> snk-taskbar
|
|
147
|
+
snk-simple-crud --> snk-form-config
|
|
148
|
+
snk-simple-crud --> snk-configurator
|
|
149
|
+
snk-simple-crud --> snk-grid-config
|
|
125
150
|
snk-simple-crud --> snk-data-exporter
|
|
126
151
|
snk-simple-crud --> snk-actions-button
|
|
127
152
|
snk-simple-crud --> taskbar-actions-button
|
|
153
|
+
snk-form-config --> snk-field-config
|
|
154
|
+
snk-form-config --> snk-config-options
|
|
155
|
+
snk-form-config --> snk-tab-config
|
|
128
156
|
snk-guides-viewer --> snk-detail-view
|
|
129
157
|
style snk-detail-view fill:#f9f,stroke:#333,stroke-width:4px
|
|
130
158
|
```
|
|
@@ -25,13 +25,14 @@
|
|
|
25
25
|
|
|
26
26
|
## Events
|
|
27
27
|
|
|
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
|
-
| `
|
|
28
|
+
| Event | Description | Type |
|
|
29
|
+
| ------------------------ | ------------------------------------------------------------- | -------------------------------- |
|
|
30
|
+
| `cancelEdition` | Emitido quando se cancela uma inserção ou cópia. | `CustomEvent<void>` |
|
|
31
|
+
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
|
|
32
|
+
| `dataUnitFieldsHidded` | Emitido quando há campos no DataUnit que devem ser ocultados. | `CustomEvent<void>` |
|
|
33
|
+
| `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
|
|
34
|
+
| `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
|
|
35
|
+
| `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
|
|
35
36
|
|
|
36
37
|
|
|
37
38
|
## Methods
|
|
@@ -46,6 +47,36 @@ Type: `Promise<DataUnit>`
|
|
|
46
47
|
|
|
47
48
|
|
|
48
49
|
|
|
50
|
+
### `getFieldsWithRmPrecision() => Promise<string[]>`
|
|
51
|
+
|
|
52
|
+
Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
|
|
53
|
+
|
|
54
|
+
#### Returns
|
|
55
|
+
|
|
56
|
+
Type: `Promise<string[]>`
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### `getFieldsWithRmp() => Promise<string[]>`
|
|
61
|
+
|
|
62
|
+
Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
|
|
63
|
+
|
|
64
|
+
#### Returns
|
|
65
|
+
|
|
66
|
+
Type: `Promise<string[]>`
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
|
|
71
|
+
|
|
72
|
+
Busca os metadados da linha selecionada.
|
|
73
|
+
|
|
74
|
+
#### Returns
|
|
75
|
+
|
|
76
|
+
Type: `Promise<RowMetadata>`
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
49
80
|
### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
|
|
50
81
|
|
|
51
82
|
Método que retorna a lista de IDs dos registros selecionados.
|
|
@@ -7,10 +7,11 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute
|
|
11
|
-
| ------------ |
|
|
12
|
-
| `config` | --
|
|
13
|
-
| `getMessage` | --
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------ | ------------ | --------------------------------------------------------------------------------- | -------------------------------------- | ----------- |
|
|
12
|
+
| `config` | -- | Define as configurações do componente snk-filter-item. | `SnkFilterItemConfig` | `undefined` |
|
|
13
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
14
|
+
| `showChips` | `show-chips` | Usado para controlar a visibilidade dos chips de filtros | `boolean` | `true` |
|
|
14
15
|
|
|
15
16
|
|
|
16
17
|
## Events
|
|
@@ -7,17 +7,18 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `addPersonalizedFilter`
|
|
13
|
-
| `applyFilters`
|
|
14
|
-
| `closeModal`
|
|
15
|
-
| `configName`
|
|
16
|
-
| `deletePersonalizedFilter`
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| --------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | ----------- |
|
|
12
|
+
| `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void` | `undefined` |
|
|
13
|
+
| `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
|
|
14
|
+
| `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
|
|
15
|
+
| `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
|
|
16
|
+
| `deletePersonalizedFilter` | -- | Ação executada ao deletar um filtro personalizado | `(filter: IPersonalizedFilter, configName: string) => void` | `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
|
+
| `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string) => void` | `undefined` |
|
|
19
|
+
| `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
|
|
20
|
+
| `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
|
|
21
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
21
22
|
|
|
22
23
|
|
|
23
24
|
## Dependencies
|
|
@@ -7,13 +7,18 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| --------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----------- |
|
|
12
|
+
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
|
13
|
+
| `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` |
|
|
14
|
+
| `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` |
|
|
15
|
+
| `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` |
|
|
16
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
|
17
|
+
| `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
|
|
18
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
19
|
+
| `mode` | `mode` | Modo de apresentação da filterbar. | `"button" \| "hidden" \| "regular"` | `"regular"` |
|
|
20
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
21
|
+
| `title` | `title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
|
17
22
|
|
|
18
23
|
|
|
19
24
|
## Events
|
|
@@ -65,6 +70,16 @@ Type: `Promise<SnkFilterItemConfig>`
|
|
|
65
70
|
|
|
66
71
|
- Retorna o item de filtro removido, ou undefined caso não encontrado.
|
|
67
72
|
|
|
73
|
+
### `showFilterModal() => Promise<void>`
|
|
74
|
+
|
|
75
|
+
Abre o modal de filtros
|
|
76
|
+
|
|
77
|
+
#### Returns
|
|
78
|
+
|
|
79
|
+
Type: `Promise<void>`
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
68
83
|
### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
|
|
69
84
|
|
|
70
85
|
Atualiza um item do filtro.
|
|
@@ -7,12 +7,13 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `configName`
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ---------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
|
12
|
+
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
|
|
13
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
14
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
15
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
16
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
16
17
|
|
|
17
18
|
|
|
18
19
|
## Events
|
|
@@ -26,6 +27,16 @@
|
|
|
26
27
|
|
|
27
28
|
## Methods
|
|
28
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
|
+
|
|
29
40
|
### `hideConfig() => Promise<void>`
|
|
30
41
|
|
|
31
42
|
Fecha a janela de configurações do formulário.
|
|
@@ -36,6 +47,16 @@ Type: `Promise<void>`
|
|
|
36
47
|
|
|
37
48
|
|
|
38
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
|
+
|
|
39
60
|
### `showConfig() => Promise<void>`
|
|
40
61
|
|
|
41
62
|
Exibe a janela de configurações do formulário.
|
|
@@ -51,7 +72,7 @@ Type: `Promise<void>`
|
|
|
51
72
|
|
|
52
73
|
### Depends on
|
|
53
74
|
|
|
54
|
-
- [snk-form-config](
|
|
75
|
+
- [snk-form-config](../snk-form-config)
|
|
55
76
|
|
|
56
77
|
### Graph
|
|
57
78
|
```mermaid
|
|
@@ -26,14 +26,15 @@
|
|
|
26
26
|
|
|
27
27
|
### Used by
|
|
28
28
|
|
|
29
|
-
- [snk-form](
|
|
30
|
-
- [snk-guides-viewer](
|
|
29
|
+
- [snk-form](../snk-form)
|
|
30
|
+
- [snk-guides-viewer](../snk-crud/subcomponents)
|
|
31
|
+
- [snk-simple-crud](../snk-simple-crud)
|
|
31
32
|
|
|
32
33
|
### Depends on
|
|
33
34
|
|
|
34
|
-
- [snk-field-config](
|
|
35
|
-
- [snk-config-options](
|
|
36
|
-
- [snk-tab-config](
|
|
35
|
+
- [snk-field-config](./subcomponents/snk-field-config)
|
|
36
|
+
- [snk-config-options](./subcomponents/snk-config-options)
|
|
37
|
+
- [snk-tab-config](./subcomponents/snk-tab-config)
|
|
37
38
|
|
|
38
39
|
### Graph
|
|
39
40
|
```mermaid
|
|
@@ -43,6 +44,7 @@ graph TD;
|
|
|
43
44
|
snk-form-config --> snk-tab-config
|
|
44
45
|
snk-form --> snk-form-config
|
|
45
46
|
snk-guides-viewer --> snk-form-config
|
|
47
|
+
snk-simple-crud --> snk-form-config
|
|
46
48
|
style snk-form-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
47
49
|
```
|
|
48
50
|
|
|
@@ -7,25 +7,30 @@
|
|
|
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` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
|
13
|
+
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
|
14
|
+
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
|
15
|
+
| `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
|
|
16
|
+
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `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
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
|
19
|
+
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
|
20
|
+
| `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
|
|
21
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
22
|
+
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
|
|
23
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
24
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
|
|
25
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
|
26
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
27
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
28
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
|
29
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
|
30
|
+
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
|
|
31
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
32
|
+
| `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
|
|
33
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
29
34
|
|
|
30
35
|
|
|
31
36
|
## Events
|
|
@@ -38,6 +43,36 @@
|
|
|
38
43
|
|
|
39
44
|
## Methods
|
|
40
45
|
|
|
46
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
|
|
47
|
+
|
|
48
|
+
Registra um editor customizado para campos da grade e formulário
|
|
49
|
+
|
|
50
|
+
#### Returns
|
|
51
|
+
|
|
52
|
+
Type: `Promise<void>`
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
57
|
+
|
|
58
|
+
Registra um formatador de valores para uma coluna da grid.
|
|
59
|
+
|
|
60
|
+
#### Returns
|
|
61
|
+
|
|
62
|
+
Type: `Promise<void>`
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
|
|
67
|
+
|
|
68
|
+
Registra um render customizado para colunas da grid.
|
|
69
|
+
|
|
70
|
+
#### Returns
|
|
71
|
+
|
|
72
|
+
Type: `Promise<void>`
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
41
76
|
### `findColumn() => Promise<void>`
|
|
42
77
|
|
|
43
78
|
Abre o localizador de colunas
|
|
@@ -78,6 +113,16 @@ Type: `Promise<void>`
|
|
|
78
113
|
|
|
79
114
|
|
|
80
115
|
|
|
116
|
+
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
117
|
+
|
|
118
|
+
Remove o formatador de valores de uma coluna da grid.
|
|
119
|
+
|
|
120
|
+
#### Returns
|
|
121
|
+
|
|
122
|
+
Type: `Promise<void>`
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
81
126
|
### `setConfig(config: IGridConfig) => Promise<void>`
|
|
82
127
|
|
|
83
128
|
Atribui o valor da configuração da grade.
|
|
@@ -88,6 +133,16 @@ Type: `Promise<void>`
|
|
|
88
133
|
|
|
89
134
|
|
|
90
135
|
|
|
136
|
+
### `setFocus() => Promise<void>`
|
|
137
|
+
|
|
138
|
+
Atribui o foco para a grade.
|
|
139
|
+
|
|
140
|
+
#### Returns
|
|
141
|
+
|
|
142
|
+
Type: `Promise<void>`
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
91
146
|
### `showConfig() => Promise<void>`
|
|
92
147
|
|
|
93
148
|
Exibe a janela de configurações da grade.
|
|
@@ -110,7 +165,7 @@ Type: `Promise<void>`
|
|
|
110
165
|
|
|
111
166
|
- [snk-filter-bar](../snk-filter-bar)
|
|
112
167
|
- [snk-taskbar](../snk-taskbar)
|
|
113
|
-
- [snk-grid-config](
|
|
168
|
+
- [snk-grid-config](../snk-grid-config)
|
|
114
169
|
- [snk-data-exporter](../snk-data-exporter)
|
|
115
170
|
- [snk-actions-button](../snk-actions-button)
|
|
116
171
|
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
|
@@ -9,7 +9,6 @@
|
|
|
9
9
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| --------------- | ---------------- | ------------------------------------------------ | ---------------- | ----------- |
|
|
12
|
-
| `application` | -- | Referência para o SnkApplication | `SnkApplication` | `undefined` |
|
|
13
12
|
| `columns` | -- | Colunas da grade. | `EzGridColumn[]` | `undefined` |
|
|
14
13
|
| `config` | -- | Configurações da grade. | `IGridConfig` | `undefined` |
|
|
15
14
|
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
|
@@ -29,17 +28,19 @@
|
|
|
29
28
|
|
|
30
29
|
### Used by
|
|
31
30
|
|
|
32
|
-
- [snk-grid](
|
|
31
|
+
- [snk-grid](../snk-grid)
|
|
32
|
+
- [snk-simple-crud](../snk-simple-crud)
|
|
33
33
|
|
|
34
34
|
### Depends on
|
|
35
35
|
|
|
36
|
-
- [snk-select-box](
|
|
36
|
+
- [snk-select-box](snk-select-box)
|
|
37
37
|
|
|
38
38
|
### Graph
|
|
39
39
|
```mermaid
|
|
40
40
|
graph TD;
|
|
41
41
|
snk-grid-config --> snk-select-box
|
|
42
42
|
snk-grid --> snk-grid-config
|
|
43
|
+
snk-simple-crud --> snk-grid-config
|
|
43
44
|
style snk-grid-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
44
45
|
```
|
|
45
46
|
|
|
@@ -7,32 +7,84 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
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
|
+
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
|
14
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
15
|
+
| `dataState` | -- | | `DataState` | `undefined` |
|
|
16
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
17
|
+
| `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
|
|
18
|
+
| `formConfig` | -- | | `IFormConfig` | `undefined` |
|
|
19
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
20
|
+
| `gridConfig` | -- | | `IGridConfig` | `undefined` |
|
|
21
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
|
22
|
+
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `false` |
|
|
23
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
24
|
+
| `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
|
|
25
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
|
|
26
|
+
| `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
|
|
27
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
28
|
+
| `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
|
|
29
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
30
|
+
| `useCancelConfirm` | `use-cancel-confirm` | | `boolean` | `true` |
|
|
31
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
|
22
32
|
|
|
23
33
|
|
|
24
34
|
## Events
|
|
25
35
|
|
|
26
|
-
| Event
|
|
27
|
-
|
|
|
28
|
-
| `actionClick`
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
36
|
+
| Event | Description | Type |
|
|
37
|
+
| -------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
|
|
38
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
39
|
+
| `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
|
|
40
|
+
| `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
|
|
41
|
+
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
|
|
42
|
+
| `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
|
|
43
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
|
32
44
|
|
|
33
45
|
|
|
34
46
|
## Methods
|
|
35
47
|
|
|
48
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
|
49
|
+
|
|
50
|
+
Registra um editor customizado para campos da grade e formulário.
|
|
51
|
+
|
|
52
|
+
#### Returns
|
|
53
|
+
|
|
54
|
+
Type: `Promise<void>`
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
59
|
+
|
|
60
|
+
Registra um formatador de valores para uma coluna da grid.
|
|
61
|
+
|
|
62
|
+
#### Returns
|
|
63
|
+
|
|
64
|
+
Type: `Promise<void>`
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
|
69
|
+
|
|
70
|
+
Registra um render customizado para colunas da grid.
|
|
71
|
+
|
|
72
|
+
#### Returns
|
|
73
|
+
|
|
74
|
+
Type: `Promise<void>`
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
### `closeConfigurator() => Promise<void>`
|
|
79
|
+
|
|
80
|
+
Usado para fechar o configurator do CRUD
|
|
81
|
+
|
|
82
|
+
#### Returns
|
|
83
|
+
|
|
84
|
+
Type: `Promise<void>`
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
36
88
|
### `getRecords() => Promise<Array<Record>>`
|
|
37
89
|
|
|
38
90
|
|
|
@@ -53,6 +105,36 @@ Type: `Promise<void>`
|
|
|
53
105
|
|
|
54
106
|
|
|
55
107
|
|
|
108
|
+
### `openConfigurator() => Promise<void>`
|
|
109
|
+
|
|
110
|
+
Usado para abrir o configurator do CRUD
|
|
111
|
+
|
|
112
|
+
#### Returns
|
|
113
|
+
|
|
114
|
+
Type: `Promise<void>`
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
119
|
+
|
|
120
|
+
Remove o formatador de valores de uma coluna da grid.
|
|
121
|
+
|
|
122
|
+
#### Returns
|
|
123
|
+
|
|
124
|
+
Type: `Promise<void>`
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
129
|
+
|
|
130
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
131
|
+
|
|
132
|
+
#### Returns
|
|
133
|
+
|
|
134
|
+
Type: `Promise<void>`
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
56
138
|
### `setMetadata(metadata: UnitMetadata) => Promise<void>`
|
|
57
139
|
|
|
58
140
|
|
|
@@ -73,6 +155,16 @@ Type: `Promise<void>`
|
|
|
73
155
|
|
|
74
156
|
|
|
75
157
|
|
|
158
|
+
### `updateConfig() => Promise<void>`
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
#### Returns
|
|
163
|
+
|
|
164
|
+
Type: `Promise<void>`
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
76
168
|
|
|
77
169
|
## Dependencies
|
|
78
170
|
|
|
@@ -84,6 +176,9 @@ Type: `Promise<void>`
|
|
|
84
176
|
|
|
85
177
|
- [snk-data-unit](../snk-data-unit)
|
|
86
178
|
- [snk-taskbar](../snk-taskbar)
|
|
179
|
+
- [snk-form-config](../snk-form-config)
|
|
180
|
+
- [snk-configurator](../snk-configurator)
|
|
181
|
+
- [snk-grid-config](../snk-grid-config)
|
|
87
182
|
- [snk-data-exporter](../snk-data-exporter)
|
|
88
183
|
- [snk-actions-button](../snk-actions-button)
|
|
89
184
|
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
|
@@ -93,6 +188,9 @@ Type: `Promise<void>`
|
|
|
93
188
|
graph TD;
|
|
94
189
|
snk-simple-crud --> snk-data-unit
|
|
95
190
|
snk-simple-crud --> snk-taskbar
|
|
191
|
+
snk-simple-crud --> snk-form-config
|
|
192
|
+
snk-simple-crud --> snk-configurator
|
|
193
|
+
snk-simple-crud --> snk-grid-config
|
|
96
194
|
snk-simple-crud --> snk-data-exporter
|
|
97
195
|
snk-simple-crud --> snk-actions-button
|
|
98
196
|
snk-simple-crud --> taskbar-actions-button
|
|
@@ -100,6 +198,10 @@ graph TD;
|
|
|
100
198
|
snk-taskbar --> snk-actions-button
|
|
101
199
|
snk-taskbar --> taskbar-actions-button
|
|
102
200
|
snk-data-exporter --> snk-exporter-email-sender
|
|
201
|
+
snk-form-config --> snk-field-config
|
|
202
|
+
snk-form-config --> snk-config-options
|
|
203
|
+
snk-form-config --> snk-tab-config
|
|
204
|
+
snk-grid-config --> snk-select-box
|
|
103
205
|
snk-attach --> snk-simple-crud
|
|
104
206
|
style snk-simple-crud fill:#f9f,stroke:#333,stroke-width:4px
|
|
105
207
|
```
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| ------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | --------------------------- |
|
|
12
12
|
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
|
13
|
+
| `alignRigth` | `align-rigth` | Usado para determinar O alinhamento dos items na taskbar. | `boolean` | `false` |
|
|
13
14
|
| `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
|
|
14
15
|
| `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
|
|
15
16
|
| `customButtons` | -- | Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer. | `Map<string, CustomButton>` | `undefined` |
|
|
@@ -18,6 +19,7 @@
|
|
|
18
19
|
| `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
|
|
19
20
|
| `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
|
|
20
21
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
22
|
+
| `overflowStrategy` | `overflow-strategy` | Define como será o comportamento da taskbar quando ocorrer overflow | `"hiddenItems" \| "none"` | `'hiddenItems'` |
|
|
21
23
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
|
22
24
|
| `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
|
|
23
25
|
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|