@sankhyalabs/sankhyablocks-docs 0.0.0-bugfix-dev-KB-131882.2 → 0.0.0-bugfix-dev-KB-174860.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.
Files changed (33) hide show
  1. package/components/snk-actions-button/readme.md +13 -0
  2. package/components/snk-attach/readme.md +32 -5
  3. package/components/snk-configurator/readme.md +4 -0
  4. package/components/snk-crud/readme.md +19 -14
  5. package/components/snk-crud/subcomponents/readme.md +1 -3
  6. package/components/snk-crud/subcomponents/snk-detail-view/readme.md +1 -1
  7. package/components/snk-data-exporter/readme.md +11 -4
  8. package/components/snk-data-unit/readme.md +2 -0
  9. package/components/snk-dynaform/readme.md +285 -0
  10. package/components/snk-dynaform/subcomponents/snk-dynaform-detail-view/readme.md +154 -0
  11. package/components/snk-dynaform/subcomponents/snk-dynaform-form-view/readme.md +98 -0
  12. package/components/snk-dynaform/subcomponents/snk-dynaform-guides-view/readme.md +206 -0
  13. package/components/snk-dynaform-form-config/readme.md +57 -0
  14. package/components/snk-dynaform-form-config/snk-dynaform-config-header/readme.md +47 -0
  15. package/components/snk-dynaform-form-config/snk-dynaform-config-header/snk-dynaform-configs-button/readme.md +40 -0
  16. package/components/snk-dynaform-form-config/snk-dynaform-field-item/readme.md +48 -0
  17. package/components/snk-dynaform-form-config/snk-dynaform-field-item/snk-dynaform-field-config/readme.md +53 -0
  18. package/components/snk-dynaform-form-config/snk-dynaform-fields-layout/readme.md +65 -0
  19. package/components/snk-dynaform-form-config/snk-dynaform-fields-selector/readme.md +45 -0
  20. package/components/snk-dynaform-form-config/snk-dynaform-guides-configurator/readme.md +43 -0
  21. package/components/snk-filter-bar/filter-item/readme.md +1 -0
  22. package/components/snk-filter-bar/filter-modal/readme.md +15 -15
  23. package/components/snk-filter-bar/readme.md +8 -0
  24. package/components/snk-grid/readme.md +38 -0
  25. package/components/snk-grid-config/readme.md +1 -0
  26. package/components/snk-image-input/readme.md +2 -0
  27. package/components/snk-simple-bar/readme.md +0 -2
  28. package/components/snk-simple-crud/readme.md +1 -0
  29. package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +12 -5
  30. package/components/snk-taskbar/elements/taskbar-split-button/readme.md +17 -10
  31. package/components/snk-taskbar/readme.md +11 -2
  32. package/components/snk-taskbar/subcomponents/readme.md +23 -0
  33. package/package.json +1 -1
package/components/snk-actions-button/readme.md CHANGED
@@ -5,12 +5,22 @@
5
5
  <!-- Auto Generated Below -->
6
6
 
7
7
 
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------- | --------- | -------------------------------------------------------------------- | -------------------------------- | ---------- |
12
+ | `size` | `size` | Define o tamanho do botão, podendo ser 'small', 'medium' ou 'large'. | `"large" \| "medium" \| "small"` | `'medium'` |
13
+
14
+
8
15
  ## Dependencies
9
16
 
10
17
  ### Used by
11
18
 
12
19
  - [snk-crud](../snk-crud)
13
20
  - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
21
+ - [snk-dynaform](../snk-dynaform)
22
+ - [snk-dynaform-detail-view](../snk-dynaform/subcomponents/snk-dynaform-detail-view)
23
+ - [snk-dynaform-guides-view](../snk-dynaform/subcomponents/snk-dynaform-guides-view)
14
24
  - [snk-grid](../snk-grid)
15
25
  - [snk-guides-viewer](../snk-crud/subcomponents)
16
26
  - [snk-simple-crud](../snk-simple-crud)
@@ -21,6 +31,9 @@
21
31
  graph TD;
22
32
  snk-crud --> snk-actions-button
23
33
  snk-detail-view --> snk-actions-button
34
+ snk-dynaform --> snk-actions-button
35
+ snk-dynaform-detail-view --> snk-actions-button
36
+ snk-dynaform-guides-view --> snk-actions-button
24
37
  snk-grid --> snk-actions-button
25
38
  snk-guides-viewer --> snk-actions-button
26
39
  snk-simple-crud --> snk-actions-button
package/components/snk-attach/readme.md CHANGED
@@ -21,9 +21,33 @@
21
21
 
22
22
  ## Events
23
23
 
24
- | Event | Description | Type |
25
- | ------ | -------------------------------------------------------- | ------------------- |
26
- | `back` | Evento disparado quando o usuário clica no botão voltar. | `CustomEvent<void>` |
24
+ | Event | Description | Type |
25
+ | -------------- | ------------------------------------------------------------- | ------------------- |
26
+ | `ezClosePopup` | Evento emitido ao clicar no botão de fechar (onEzClosePopup). | `CustomEvent<void>` |
27
+
28
+
29
+ ## Methods
30
+
31
+ ### `close() => Promise<void>`
32
+
33
+ Fecha o popup do SnkAttach.
34
+
35
+ #### Returns
36
+
37
+ Type: `Promise<void>`
38
+
39
+ ---
40
+
41
+ ### `open() => Promise<void>`
42
+
43
+ Abre o popup do SnkAttach.
44
+ Inicializa o componente apenas na abertura.
45
+
46
+ #### Returns
47
+
48
+ Type: `Promise<void>`
49
+
50
+
27
51
 
28
52
 
29
53
  ## Dependencies
@@ -32,16 +56,16 @@
32
56
 
33
57
  - [snk-crud](../snk-crud)
34
58
  - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
59
+ - [snk-dynaform](../snk-dynaform)
60
+ - [snk-dynaform-detail-view](../snk-dynaform/subcomponents/snk-dynaform-detail-view)
35
61
 
36
62
  ### Depends on
37
63
 
38
- - [snk-simple-bar](../snk-simple-bar)
39
64
  - [snk-simple-crud](../snk-simple-crud)
40
65
 
41
66
  ### Graph
42
67
  ```mermaid
43
68
  graph TD;
44
- snk-attach --> snk-simple-bar
45
69
  snk-attach --> snk-simple-crud
46
70
  snk-simple-crud --> snk-taskbar
47
71
  snk-simple-crud --> snk-data-unit
@@ -52,6 +76,7 @@ graph TD;
52
76
  snk-simple-crud --> snk-actions-button
53
77
  snk-simple-crud --> taskbar-split-button
54
78
  snk-simple-crud --> taskbar-actions-button
79
+ snk-taskbar --> snk-taskbar-skeleton
55
80
  snk-taskbar --> snk-data-exporter
56
81
  snk-taskbar --> snk-actions-button
57
82
  snk-taskbar --> taskbar-split-button
@@ -63,6 +88,8 @@ graph TD;
63
88
  snk-grid-config --> snk-select-box
64
89
  snk-crud --> snk-attach
65
90
  snk-detail-view --> snk-attach
91
+ snk-dynaform --> snk-attach
92
+ snk-dynaform-detail-view --> snk-attach
66
93
  style snk-attach fill:#f9f,stroke:#333,stroke-width:4px
67
94
  ```
68
95
 
package/components/snk-configurator/readme.md CHANGED
@@ -58,6 +58,8 @@ Type: `Promise<void>`
58
58
  ### Used by
59
59
 
60
60
  - [snk-crud](../snk-crud)
61
+ - [snk-dynaform](../snk-dynaform)
62
+ - [snk-dynaform-guides-view](../snk-dynaform/subcomponents/snk-dynaform-guides-view)
61
63
  - [snk-guides-viewer](../snk-crud/subcomponents)
62
64
  - [snk-simple-crud](../snk-simple-crud)
63
65
 
@@ -73,6 +75,8 @@ graph TD;
73
75
  snk-configurator --> snk-numbering-config
74
76
  snk-layout-form-config --> snk-view-representation
75
77
  snk-crud --> snk-configurator
78
+ snk-dynaform --> snk-configurator
79
+ snk-dynaform-guides-view --> snk-configurator
76
80
  snk-guides-viewer --> snk-configurator
77
81
  snk-simple-crud --> snk-configurator
78
82
  style snk-configurator fill:#f9f,stroke:#333,stroke-width:4px
package/components/snk-crud/readme.md CHANGED
@@ -182,6 +182,9 @@ Type: `Promise<void>`
182
182
 
183
183
  ### Depends on
184
184
 
185
+ - [snk-entity-search](subcomponents)
186
+ - [snk-taskbar](../snk-taskbar)
187
+ - [snk-filter-bar](../snk-filter-bar)
185
188
  - [snk-grid](../snk-grid)
186
189
  - [snk-guides-viewer](subcomponents)
187
190
  - [snk-attach](../snk-attach)
@@ -194,6 +197,9 @@ Type: `Promise<void>`
194
197
  ### Graph
195
198
  ```mermaid
196
199
  graph TD;
200
+ snk-crud --> snk-entity-search
201
+ snk-crud --> snk-taskbar
202
+ snk-crud --> snk-filter-bar
197
203
  snk-crud --> snk-grid
198
204
  snk-crud --> snk-guides-viewer
199
205
  snk-crud --> snk-attach
@@ -202,13 +208,12 @@ graph TD;
202
208
  snk-crud --> snk-actions-button
203
209
  snk-crud --> taskbar-split-button
204
210
  snk-crud --> taskbar-actions-button
205
- snk-grid --> snk-filter-bar
206
- snk-grid --> snk-taskbar
207
- snk-grid --> snk-grid-config
208
- snk-grid --> snk-data-exporter
209
- snk-grid --> snk-actions-button
210
- snk-grid --> taskbar-split-button
211
- snk-grid --> taskbar-actions-button
211
+ snk-taskbar --> snk-taskbar-skeleton
212
+ snk-taskbar --> snk-data-exporter
213
+ snk-taskbar --> snk-actions-button
214
+ snk-taskbar --> taskbar-split-button
215
+ snk-taskbar --> taskbar-actions-button
216
+ snk-data-exporter --> snk-exporter-email-sender
212
217
  snk-filter-bar --> snk-filter-item
213
218
  snk-filter-bar --> snk-personalized-filter
214
219
  snk-filter-bar --> snk-filter-modal
@@ -224,16 +229,17 @@ graph TD;
224
229
  snk-expression-item --> snk-filter-param-config
225
230
  snk-filter-modal --> snk-filter-modal-item
226
231
  snk-filter-modal --> snk-default-filter
227
- snk-taskbar --> snk-data-exporter
228
- snk-taskbar --> snk-actions-button
229
- snk-taskbar --> taskbar-split-button
230
- snk-taskbar --> taskbar-actions-button
231
- snk-data-exporter --> snk-exporter-email-sender
232
+ snk-grid --> snk-filter-bar
233
+ snk-grid --> snk-taskbar
234
+ snk-grid --> snk-grid-config
235
+ snk-grid --> snk-data-exporter
236
+ snk-grid --> snk-actions-button
237
+ snk-grid --> taskbar-split-button
238
+ snk-grid --> taskbar-actions-button
232
239
  snk-grid-config --> snk-select-box
233
240
  snk-guides-viewer --> snk-form-view
234
241
  snk-guides-viewer --> snk-data-unit
235
242
  snk-guides-viewer --> snk-detail-view
236
- snk-guides-viewer --> snk-taskbar
237
243
  snk-guides-viewer --> snk-form-config
238
244
  snk-guides-viewer --> snk-configurator
239
245
  snk-guides-viewer --> snk-data-exporter
@@ -251,7 +257,6 @@ graph TD;
251
257
  snk-detail-view --> snk-actions-button
252
258
  snk-detail-view --> taskbar-split-button
253
259
  snk-detail-view --> taskbar-actions-button
254
- snk-attach --> snk-simple-bar
255
260
  snk-attach --> snk-simple-crud
256
261
  snk-simple-crud --> snk-taskbar
257
262
  snk-simple-crud --> snk-data-unit
package/components/snk-crud/subcomponents/readme.md CHANGED
@@ -116,7 +116,6 @@ Type: `Promise<void>`
116
116
  - [snk-form-view](.)
117
117
  - [snk-data-unit](../../snk-data-unit)
118
118
  - [snk-detail-view](snk-detail-view)
119
- - [snk-taskbar](../../snk-taskbar)
120
119
  - [snk-form-config](../../snk-form-config)
121
120
  - [snk-configurator](../../snk-configurator)
122
121
  - [snk-data-exporter](../../snk-data-exporter)
@@ -130,7 +129,6 @@ graph TD;
130
129
  snk-guides-viewer --> snk-form-view
131
130
  snk-guides-viewer --> snk-data-unit
132
131
  snk-guides-viewer --> snk-detail-view
133
- snk-guides-viewer --> snk-taskbar
134
132
  snk-guides-viewer --> snk-form-config
135
133
  snk-guides-viewer --> snk-configurator
136
134
  snk-guides-viewer --> snk-data-exporter
@@ -170,13 +168,13 @@ graph TD;
170
168
  snk-expression-item --> snk-filter-param-config
171
169
  snk-filter-modal --> snk-filter-modal-item
172
170
  snk-filter-modal --> snk-default-filter
171
+ snk-taskbar --> snk-taskbar-skeleton
173
172
  snk-taskbar --> snk-data-exporter
174
173
  snk-taskbar --> snk-actions-button
175
174
  snk-taskbar --> taskbar-split-button
176
175
  snk-taskbar --> taskbar-actions-button
177
176
  snk-data-exporter --> snk-exporter-email-sender
178
177
  snk-grid-config --> snk-select-box
179
- snk-attach --> snk-simple-bar
180
178
  snk-attach --> snk-simple-crud
181
179
  snk-simple-crud --> snk-taskbar
182
180
  snk-simple-crud --> snk-data-unit
package/components/snk-crud/subcomponents/snk-detail-view/readme.md CHANGED
@@ -141,6 +141,7 @@ graph TD;
141
141
  snk-expression-item --> snk-filter-param-config
142
142
  snk-filter-modal --> snk-filter-modal-item
143
143
  snk-filter-modal --> snk-default-filter
144
+ snk-taskbar --> snk-taskbar-skeleton
144
145
  snk-taskbar --> snk-data-exporter
145
146
  snk-taskbar --> snk-actions-button
146
147
  snk-taskbar --> taskbar-split-button
@@ -149,7 +150,6 @@ graph TD;
149
150
  snk-grid-config --> snk-select-box
150
151
  snk-form-view --> snk-image-input
151
152
  snk-form-view --> snk-form-summary
152
- snk-attach --> snk-simple-bar
153
153
  snk-attach --> snk-simple-crud
154
154
  snk-simple-crud --> snk-taskbar
155
155
  snk-simple-crud --> snk-data-unit
package/components/snk-data-exporter/readme.md CHANGED
@@ -7,10 +7,11 @@
7
7
 
8
8
  ## Properties
9
9
 
10
- | Property | Attribute | Description | Type | Default |
11
- | ----------------- | --------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
- | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
13
- | `provider` | -- | Provedor das informações para exportação dos dados. | `IExporterProvider` | `null` |
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | --------- | -------------------------------------------------------------------------------------- | -------------------------------- | ----------- |
12
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
13
+ | `provider` | -- | Provedor das informações para exportação dos dados. | `IExporterProvider` | `null` |
14
+ | `size` | `size` | Define o tamanho do botão, podendo ser 'small', 'medium' ou 'large'. | `"large" \| "medium" \| "small"` | `'medium'` |
14
15
 
15
16
 
16
17
  ## Dependencies
@@ -19,6 +20,9 @@
19
20
 
20
21
  - [snk-crud](../snk-crud)
21
22
  - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
23
+ - [snk-dynaform](../snk-dynaform)
24
+ - [snk-dynaform-detail-view](../snk-dynaform/subcomponents/snk-dynaform-detail-view)
25
+ - [snk-dynaform-guides-view](../snk-dynaform/subcomponents/snk-dynaform-guides-view)
22
26
  - [snk-grid](../snk-grid)
23
27
  - [snk-guides-viewer](../snk-crud/subcomponents)
24
28
  - [snk-simple-crud](../snk-simple-crud)
@@ -34,6 +38,9 @@ graph TD;
34
38
  snk-data-exporter --> snk-exporter-email-sender
35
39
  snk-crud --> snk-data-exporter
36
40
  snk-detail-view --> snk-data-exporter
41
+ snk-dynaform --> snk-data-exporter
42
+ snk-dynaform-detail-view --> snk-data-exporter
43
+ snk-dynaform-guides-view --> snk-data-exporter
37
44
  snk-grid --> snk-data-exporter
38
45
  snk-guides-viewer --> snk-data-exporter
39
46
  snk-simple-crud --> snk-data-exporter
package/components/snk-data-unit/readme.md CHANGED
@@ -102,6 +102,7 @@ Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
102
102
  ### Used by
103
103
 
104
104
  - [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
105
+ - [snk-dynaform-detail-view](../snk-dynaform/subcomponents/snk-dynaform-detail-view)
105
106
  - [snk-guides-viewer](../snk-crud/subcomponents)
106
107
  - [snk-simple-crud](../snk-simple-crud)
107
108
 
@@ -109,6 +110,7 @@ Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
109
110
  ```mermaid
110
111
  graph TD;
111
112
  snk-detail-view --> snk-data-unit
113
+ snk-dynaform-detail-view --> snk-data-unit
112
114
  snk-guides-viewer --> snk-data-unit
113
115
  snk-simple-crud --> snk-data-unit
114
116
  style snk-data-unit fill:#f9f,stroke:#333,stroke-width:4px
package/components/snk-dynaform/readme.md ADDED
@@ -0,0 +1,285 @@
1
+ # snk-dynaform
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
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
+ | `customGuidesConfig` | -- | Fornece as informações das guias personalizadas. | `CustomGuideItem[]` | `[]` |
17
+ | `disableNumberingConfig` | `disable-numbering-config` | Define se a configuração de numeração será desabilitada. | `boolean` | `false` |
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
+ | `domainMessagesBuilder` | `domain-messages-builder` | Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) | `string` | `undefined` |
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
+ | `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
24
+ | `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
25
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
26
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
27
+ | `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
28
+ | `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `true` |
29
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
30
+ | `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
31
+ | `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
32
+ | `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
33
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
34
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
35
+ | `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
36
+ | `setCustomFormTitle` | -- | Define uma função para configurar um título cusotmizado no modo formulário. | `() => string` | `undefined` |
37
+ | `showActionButtons` | `show-action-buttons` | Usado para exibir os botões de ação do snk-configurator | `boolean` | `true` |
38
+ | `showEntitySearch` | `show-entity-search` | Define se o campo de busca de entidades será exibido na barra superior. | `boolean` | `true` |
39
+ | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `((data: object) => string) \| IStatusResolver` | `undefined` |
40
+ | `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
41
+ | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
42
+ | `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
43
+
44
+
45
+ ## Events
46
+
47
+ | Event | Description | Type |
48
+ | ------------------------ | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
49
+ | `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
50
+ | `configuratorCancel` | Emitido quando cancela o salvamento da configuração no configurator do CRUD. | `CustomEvent<any>` |
51
+ | `configuratorSave` | Emitido quando salva a configuração no configurator do CRUD. | `CustomEvent<any>` |
52
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
53
+ | `numberingConfigChanged` | Emitido quando a configuração de numeração é alterada. | `CustomEvent<ResponseGetConfig>` |
54
+ | `snkShowGuide` | Emitido pelo guides-viewer sempre que houver mudança de guia. | `CustomEvent<string>` |
55
+ | `viewModeChanged` | | `CustomEvent<VIEW_MODE.ATTACHMENT \| VIEW_MODE.FORM \| VIEW_MODE.GRID>` |
56
+
57
+
58
+ ## Methods
59
+
60
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
61
+
62
+ Registra um editor customizado para campos da grade e formulário.
63
+
64
+ #### Returns
65
+
66
+ Type: `Promise<void>`
67
+
68
+ ---
69
+
70
+ ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
71
+
72
+ Registra um formatador de valores para uma coluna da grid.
73
+
74
+ #### Returns
75
+
76
+ Type: `Promise<void>`
77
+
78
+ ---
79
+
80
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
81
+
82
+ Registra um render customizado para colunas da grid.
83
+
84
+ #### Returns
85
+
86
+ Type: `Promise<void>`
87
+
88
+ ---
89
+
90
+ ### `closeConfigurator() => Promise<void>`
91
+
92
+ Usado para fechar o configurator do CRUD
93
+
94
+ #### Returns
95
+
96
+ Type: `Promise<void>`
97
+
98
+ ---
99
+
100
+ ### `getFilterBar() => Promise<HTMLSnkFilterBarElement | undefined>`
101
+
102
+ Retorna o elemento da filter-bar da grade.
103
+
104
+ #### Returns
105
+
106
+ Type: `Promise<HTMLSnkFilterBarElement>`
107
+
108
+ ---
109
+
110
+ ### `getNumberingConfig() => Promise<ResponseGetConfig | undefined>`
111
+
112
+ Retorna a configuração de numeração atual.
113
+
114
+ #### Returns
115
+
116
+ Type: `Promise<ResponseGetConfig>`
117
+
118
+ ---
119
+
120
+ ### `goToView(mode: string) => Promise<void>`
121
+
122
+ Usado para alternar a visão entre GRID e FORM externamente.
123
+
124
+ #### Returns
125
+
126
+ Type: `Promise<void>`
127
+
128
+ ---
129
+
130
+ ### `openConfigurator() => Promise<void>`
131
+
132
+ Usado para abrir o configurator do CRUD
133
+
134
+ #### Returns
135
+
136
+ Type: `Promise<void>`
137
+
138
+ ---
139
+
140
+ ### `reloadFilterBar() => Promise<void>`
141
+
142
+ Faz o recarregamento da filter-bar do crud, buscando o state no servidor.
143
+
144
+ #### Returns
145
+
146
+ Type: `Promise<void>`
147
+
148
+ ---
149
+
150
+ ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
151
+
152
+ Remove o formatador de valores de uma coluna da grid.
153
+
154
+ #### Returns
155
+
156
+ Type: `Promise<void>`
157
+
158
+ ---
159
+
160
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
161
+
162
+ Altera/adiciona uma propriedade nos metadados do campo.
163
+
164
+ #### Returns
165
+
166
+ Type: `Promise<void>`
167
+
168
+ ---
169
+
170
+ ### `updateNumberingConfig(config: ResponseGetConfig) => Promise<void>`
171
+
172
+ Atualiza a configuração de numeração.
173
+
174
+ #### Returns
175
+
176
+ Type: `Promise<void>`
177
+
178
+
179
+
180
+
181
+ ## Dependencies
182
+
183
+ ### Depends on
184
+
185
+ - [snk-entity-search](../snk-crud/subcomponents)
186
+ - [snk-taskbar](../snk-taskbar)
187
+ - [snk-filter-bar](../snk-filter-bar)
188
+ - [snk-grid](../snk-grid)
189
+ - [snk-dynaform-guides-view](./subcomponents/snk-dynaform-guides-view)
190
+ - [snk-attach](../snk-attach)
191
+ - [snk-configurator](../snk-configurator)
192
+ - [snk-data-exporter](../snk-data-exporter)
193
+ - [snk-actions-button](../snk-actions-button)
194
+ - [taskbar-split-button](../snk-taskbar/elements/taskbar-split-button)
195
+ - [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
196
+
197
+ ### Graph
198
+ ```mermaid
199
+ graph TD;
200
+ snk-dynaform --> snk-entity-search
201
+ snk-dynaform --> snk-taskbar
202
+ snk-dynaform --> snk-filter-bar
203
+ snk-dynaform --> snk-grid
204
+ snk-dynaform --> snk-dynaform-guides-view
205
+ snk-dynaform --> snk-attach
206
+ snk-dynaform --> snk-configurator
207
+ snk-dynaform --> snk-data-exporter
208
+ snk-dynaform --> snk-actions-button
209
+ snk-dynaform --> taskbar-split-button
210
+ snk-dynaform --> taskbar-actions-button
211
+ snk-taskbar --> snk-taskbar-skeleton
212
+ snk-taskbar --> snk-data-exporter
213
+ snk-taskbar --> snk-actions-button
214
+ snk-taskbar --> taskbar-split-button
215
+ snk-taskbar --> taskbar-actions-button
216
+ snk-data-exporter --> snk-exporter-email-sender
217
+ snk-filter-bar --> snk-filter-item
218
+ snk-filter-bar --> snk-personalized-filter
219
+ snk-filter-bar --> snk-filter-modal
220
+ snk-filter-item --> snk-filter-detail
221
+ snk-personalized-filter --> snk-filter-field-search
222
+ snk-personalized-filter --> snk-filter-assistent-mode
223
+ snk-personalized-filter --> snk-filter-advanced-mode
224
+ snk-personalized-filter --> snk-simple-bar
225
+ snk-filter-assistent-mode --> snk-expression-group
226
+ snk-expression-group --> snk-expression-item
227
+ snk-expression-group --> snk-expression-group
228
+ snk-expression-item --> snk-filter-field-search
229
+ snk-expression-item --> snk-filter-param-config
230
+ snk-filter-modal --> snk-filter-modal-item
231
+ snk-filter-modal --> snk-default-filter
232
+ snk-grid --> snk-filter-bar
233
+ snk-grid --> snk-taskbar
234
+ snk-grid --> snk-grid-config
235
+ snk-grid --> snk-data-exporter
236
+ snk-grid --> snk-actions-button
237
+ snk-grid --> taskbar-split-button
238
+ snk-grid --> taskbar-actions-button
239
+ snk-grid-config --> snk-select-box
240
+ snk-dynaform-guides-view --> snk-dynaform-form-view
241
+ snk-dynaform-guides-view --> snk-dynaform-detail-view
242
+ snk-dynaform-guides-view --> snk-dynaform-form-config
243
+ snk-dynaform-guides-view --> snk-configurator
244
+ snk-dynaform-guides-view --> snk-data-exporter
245
+ snk-dynaform-guides-view --> snk-actions-button
246
+ snk-dynaform-guides-view --> taskbar-split-button
247
+ snk-dynaform-guides-view --> taskbar-actions-button
248
+ snk-dynaform-form-view --> snk-image-input
249
+ snk-dynaform-detail-view --> snk-dynaform-detail-view
250
+ snk-dynaform-detail-view --> snk-dynaform-form-view
251
+ snk-dynaform-detail-view --> snk-grid
252
+ snk-dynaform-detail-view --> snk-attach
253
+ snk-dynaform-detail-view --> snk-data-unit
254
+ snk-dynaform-detail-view --> snk-taskbar
255
+ snk-dynaform-detail-view --> snk-data-exporter
256
+ snk-dynaform-detail-view --> snk-actions-button
257
+ snk-dynaform-detail-view --> taskbar-split-button
258
+ snk-dynaform-detail-view --> taskbar-actions-button
259
+ snk-attach --> snk-simple-crud
260
+ snk-simple-crud --> snk-taskbar
261
+ snk-simple-crud --> snk-data-unit
262
+ snk-simple-crud --> snk-simple-form-config
263
+ snk-simple-crud --> snk-configurator
264
+ snk-simple-crud --> snk-grid-config
265
+ snk-simple-crud --> snk-data-exporter
266
+ snk-simple-crud --> snk-actions-button
267
+ snk-simple-crud --> taskbar-split-button
268
+ snk-simple-crud --> taskbar-actions-button
269
+ snk-configurator --> snk-layout-form-config
270
+ snk-configurator --> snk-numbering-config
271
+ snk-layout-form-config --> snk-view-representation
272
+ snk-dynaform-form-config --> snk-dynaform-config-header
273
+ snk-dynaform-form-config --> snk-dynaform-fields-selector
274
+ snk-dynaform-form-config --> snk-dynaform-fields-layout
275
+ snk-dynaform-form-config --> snk-dynaform-guides-configurator
276
+ snk-dynaform-config-header --> snk-dynaform-configs-button
277
+ snk-dynaform-fields-selector --> snk-dynaform-field-item
278
+ snk-dynaform-field-item --> snk-dynaform-field-config
279
+ snk-dynaform-fields-layout --> snk-dynaform-field-item
280
+ style snk-dynaform fill:#f9f,stroke:#333,stroke-width:4px
281
+ ```
282
+
283
+ ----------------------------------------------
284
+
285
+