@sankhyalabs/sankhyablocks-docs 10.1.0-rc.28 → 10.1.0-rc.29

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 (24) hide show
  1. package/components/snk-actions-button/readme.md +6 -0
  2. package/components/snk-attach/readme.md +4 -0
  3. package/components/snk-configurator/readme.md +4 -0
  4. package/components/snk-data-exporter/readme.md +6 -0
  5. package/components/snk-data-unit/readme.md +2 -0
  6. package/components/snk-dynaform/readme.md +285 -0
  7. package/components/snk-dynaform/subcomponents/snk-dynaform-detail-view/readme.md +154 -0
  8. package/components/snk-dynaform/subcomponents/snk-dynaform-form-view/readme.md +98 -0
  9. package/components/snk-dynaform/subcomponents/snk-dynaform-guides-view/readme.md +202 -0
  10. package/components/snk-dynaform-form-config/readme.md +57 -0
  11. package/components/snk-dynaform-form-config/snk-dynaform-config-header/readme.md +47 -0
  12. package/components/snk-dynaform-form-config/snk-dynaform-config-header/snk-dynaform-configs-button/readme.md +40 -0
  13. package/components/snk-dynaform-form-config/snk-dynaform-field-item/readme.md +48 -0
  14. package/components/snk-dynaform-form-config/snk-dynaform-field-item/snk-dynaform-field-config/readme.md +53 -0
  15. package/components/snk-dynaform-form-config/snk-dynaform-fields-layout/readme.md +65 -0
  16. package/components/snk-dynaform-form-config/snk-dynaform-fields-selector/readme.md +45 -0
  17. package/components/snk-dynaform-form-config/snk-dynaform-guides-configurator/readme.md +43 -0
  18. package/components/snk-filter-bar/readme.md +2 -0
  19. package/components/snk-grid/readme.md +4 -0
  20. package/components/snk-image-input/readme.md +2 -0
  21. package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +6 -0
  22. package/components/snk-taskbar/elements/taskbar-split-button/readme.md +6 -0
  23. package/components/snk-taskbar/readme.md +4 -0
  24. package/package.json +1 -1
package/components/snk-actions-button/readme.md CHANGED
@@ -18,6 +18,9 @@
18
18
 
19
19
  - [snk-crud](../snk-crud)
20
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)
21
24
  - [snk-grid](../snk-grid)
22
25
  - [snk-guides-viewer](../snk-crud/subcomponents)
23
26
  - [snk-simple-crud](../snk-simple-crud)
@@ -28,6 +31,9 @@
28
31
  graph TD;
29
32
  snk-crud --> snk-actions-button
30
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
31
37
  snk-grid --> snk-actions-button
32
38
  snk-guides-viewer --> snk-actions-button
33
39
  snk-simple-crud --> snk-actions-button
package/components/snk-attach/readme.md CHANGED
@@ -56,6 +56,8 @@ Type: `Promise<void>`
56
56
 
57
57
  - [snk-crud](../snk-crud)
58
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)
59
61
 
60
62
  ### Depends on
61
63
 
@@ -86,6 +88,8 @@ graph TD;
86
88
  snk-grid-config --> snk-select-box
87
89
  snk-crud --> snk-attach
88
90
  snk-detail-view --> snk-attach
91
+ snk-dynaform --> snk-attach
92
+ snk-dynaform-detail-view --> snk-attach
89
93
  style snk-attach fill:#f9f,stroke:#333,stroke-width:4px
90
94
  ```
91
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-data-exporter/readme.md CHANGED
@@ -20,6 +20,9 @@
20
20
 
21
21
  - [snk-crud](../snk-crud)
22
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)
23
26
  - [snk-grid](../snk-grid)
24
27
  - [snk-guides-viewer](../snk-crud/subcomponents)
25
28
  - [snk-simple-crud](../snk-simple-crud)
@@ -35,6 +38,9 @@ graph TD;
35
38
  snk-data-exporter --> snk-exporter-email-sender
36
39
  snk-crud --> snk-data-exporter
37
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
38
44
  snk-grid --> snk-data-exporter
39
45
  snk-guides-viewer --> snk-data-exporter
40
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
+
package/components/snk-dynaform/subcomponents/snk-dynaform-detail-view/readme.md ADDED
@@ -0,0 +1,154 @@
1
+ # snk-dynaform-detail-view
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | -------------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------- |
12
+ | `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
13
+ | `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor` | `undefined` |
14
+ | `customRenders` | -- | Render customizados da grade. | `PropsCustomRender` | `undefined` |
15
+ | `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
16
+ | `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
17
+ | `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
18
+ | `entityName` | `entity-name` | Nome da entidade detail. | `string` | `undefined` |
19
+ | `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager` | `undefined` |
20
+ | `label` | `label` | Descrição amigável do cadastro detalhe. | `string` | `undefined` |
21
+ | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
22
+ | `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.SECONDARY` |
23
+ | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
24
+ | `selectedForm` | `selected-form` | Representa o formulário selecionado na inicialização. Após o primeiro render, o estado interno _selectedSheet assume o controle. | `string` | `undefined` |
25
+ | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
26
+
27
+
28
+ ## Methods
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
+
40
+ ### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
41
+
42
+ Registra um render customizado para colunas da grid.
43
+
44
+ #### Returns
45
+
46
+ Type: `Promise<void>`
47
+
48
+ ---
49
+
50
+ ### `changeViewMode(mode: VIEW_MODE) => Promise<void>`
51
+
52
+ Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FORM
53
+
54
+ #### Returns
55
+
56
+ Type: `Promise<void>`
57
+
58
+ ---
59
+
60
+ ### `configGrid() => Promise<void>`
61
+
62
+ Abre o configurador de grid.
63
+
64
+ #### Returns
65
+
66
+ Type: `Promise<void>`
67
+
68
+ ---
69
+
70
+ ### `showUp() => Promise<void>`
71
+
72
+
73
+
74
+ #### Returns
75
+
76
+ Type: `Promise<void>`
77
+
78
+
79
+
80
+
81
+ ## Dependencies
82
+
83
+ ### Used by
84
+
85
+ - [snk-dynaform-detail-view](.)
86
+ - [snk-dynaform-guides-view](../snk-dynaform-guides-view)
87
+
88
+ ### Depends on
89
+
90
+ - [snk-dynaform-detail-view](.)
91
+ - [snk-dynaform-form-view](../snk-dynaform-form-view)
92
+ - [snk-grid](../../../snk-grid)
93
+ - [snk-attach](../../../snk-attach)
94
+ - [snk-data-unit](../../../snk-data-unit)
95
+ - [snk-taskbar](../../../snk-taskbar)
96
+ - [snk-data-exporter](../../../snk-data-exporter)
97
+ - [snk-actions-button](../../../snk-actions-button)
98
+ - [taskbar-split-button](../../../snk-taskbar/elements/taskbar-split-button)
99
+ - [taskbar-actions-button](../../../snk-taskbar/elements/taskbar-actions-button)
100
+
101
+ ### Graph
102
+ ```mermaid
103
+ graph TD;
104
+ snk-dynaform-detail-view --> snk-dynaform-detail-view
105
+ snk-dynaform-form-view --> snk-image-input
106
+ snk-grid --> snk-filter-bar
107
+ snk-grid --> snk-taskbar
108
+ snk-grid --> snk-grid-config
109
+ snk-grid --> snk-data-exporter
110
+ snk-grid --> snk-actions-button
111
+ snk-grid --> taskbar-split-button
112
+ snk-grid --> taskbar-actions-button
113
+ snk-filter-bar --> snk-filter-item
114
+ snk-filter-bar --> snk-personalized-filter
115
+ snk-filter-bar --> snk-filter-modal
116
+ snk-filter-item --> snk-filter-detail
117
+ snk-personalized-filter --> snk-filter-field-search
118
+ snk-personalized-filter --> snk-filter-assistent-mode
119
+ snk-personalized-filter --> snk-filter-advanced-mode
120
+ snk-personalized-filter --> snk-simple-bar
121
+ snk-filter-assistent-mode --> snk-expression-group
122
+ snk-expression-group --> snk-expression-item
123
+ snk-expression-group --> snk-expression-group
124
+ snk-expression-item --> snk-filter-field-search
125
+ snk-expression-item --> snk-filter-param-config
126
+ snk-filter-modal --> snk-filter-modal-item
127
+ snk-filter-modal --> snk-default-filter
128
+ snk-taskbar --> snk-taskbar-skeleton
129
+ snk-taskbar --> snk-data-exporter
130
+ snk-taskbar --> snk-actions-button
131
+ snk-taskbar --> taskbar-split-button
132
+ snk-taskbar --> taskbar-actions-button
133
+ snk-data-exporter --> snk-exporter-email-sender
134
+ snk-grid-config --> snk-select-box
135
+ snk-attach --> snk-simple-crud
136
+ snk-simple-crud --> snk-taskbar
137
+ snk-simple-crud --> snk-data-unit
138
+ snk-simple-crud --> snk-simple-form-config
139
+ snk-simple-crud --> snk-configurator
140
+ snk-simple-crud --> snk-grid-config
141
+ snk-simple-crud --> snk-data-exporter
142
+ snk-simple-crud --> snk-actions-button
143
+ snk-simple-crud --> taskbar-split-button
144
+ snk-simple-crud --> taskbar-actions-button
145
+ snk-configurator --> snk-layout-form-config
146
+ snk-configurator --> snk-numbering-config
147
+ snk-layout-form-config --> snk-view-representation
148
+ snk-dynaform-guides-view --> snk-dynaform-detail-view
149
+ style snk-dynaform-detail-view fill:#f9f,stroke:#333,stroke-width:4px
150
+ ```
151
+
152
+ ----------------------------------------------
153
+
154
+
package/components/snk-dynaform/subcomponents/snk-dynaform-form-view/readme.md ADDED
@@ -0,0 +1,98 @@
1
+ # snk-dynaform-form-view
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | ----------- |
12
+ | `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor` | `undefined` |
13
+ | `dataUnit` | -- | Define a instância do DataUnit que deve se ligar ao formulário. | `DataUnit` | `undefined` |
14
+ | `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
15
+ | `fieldSearch` | -- | Campo para o buscador de campos. | `HTMLEzSearchElement` | `undefined` |
16
+ | `fieldToFocus` | `field-to-focus` | Determina o campo que deve ficar em evidência. | `string` | `undefined` |
17
+ | `fields` | -- | Lista de campos para serem apresentados no formulário. | `IFormViewField[]` | `undefined` |
18
+ | `fieldsProps` | -- | Lista de propriedades que serão alteradas/adicionadas por coluna. | `object` | `undefined` |
19
+ | `formMetadata` | `form-metadata` | Metadados de campos que definem quais campos são obrigatórios, quais devem ser limpos durante a cópia de registros e valores padões dos campos. | `FormMetadata` | `undefined` |
20
+ | `label` | `label` | Texto para ser apresentado como título do componente | `string` | `undefined` |
21
+ | `name` | `name` | Identificador único do componente, esse é utilizado para identificar o componente no evento de `snkContentCardChanged` | `string` | `undefined` |
22
+ | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
23
+
24
+
25
+ ## Events
26
+
27
+ | Event | Description | Type |
28
+ | ----------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------ |
29
+ | `snkContentCardChanged` | Emitido quando a configuração do card é alterada. | `CustomEvent<{ formName: string; cardConfig: IFormCardConfig; propertyChanged: string; }>` |
30
+ | `snkRequestClearFieldToFocus` | Emitido quando o campo recebe foco | `CustomEvent<void>` |
31
+
32
+
33
+ ## Methods
34
+
35
+ ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
36
+
37
+ Registra um editor customizado para campos da grade e formulário
38
+
39
+ #### Returns
40
+
41
+ Type: `Promise<void>`
42
+
43
+ ---
44
+
45
+ ### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
46
+
47
+ Altera/adiciona uma propriedade nos metadados do campo.
48
+
49
+ #### Returns
50
+
51
+ Type: `Promise<void>`
52
+
53
+ ---
54
+
55
+ ### `showSearchField() => Promise<void>`
56
+
57
+ Exibe a busca de campos ancorada ao container de cabeçalho do snk-dynaform-form-view.
58
+
59
+ #### Returns
60
+
61
+ Type: `Promise<void>`
62
+
63
+ ---
64
+
65
+ ### `showUp() => Promise<void>`
66
+
67
+
68
+
69
+ #### Returns
70
+
71
+ Type: `Promise<void>`
72
+
73
+
74
+
75
+
76
+ ## Dependencies
77
+
78
+ ### Used by
79
+
80
+ - [snk-dynaform-detail-view](../snk-dynaform-detail-view)
81
+ - [snk-dynaform-guides-view](../snk-dynaform-guides-view)
82
+
83
+ ### Depends on
84
+
85
+ - [snk-image-input](../../../snk-image-input)
86
+
87
+ ### Graph
88
+ ```mermaid
89
+ graph TD;
90
+ snk-dynaform-form-view --> snk-image-input
91
+ snk-dynaform-detail-view --> snk-dynaform-form-view
92
+ snk-dynaform-guides-view --> snk-dynaform-form-view
93
+ style snk-dynaform-form-view fill:#f9f,stroke:#333,stroke-width:4px
94
+ ```
95
+
96
+ ----------------------------------------------
97
+
98
+