@sankhyalabs/sankhyablocks-docs 10.1.0-dev.52 → 10.1.0-dev.53
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-actions-button/readme.md +6 -0
- package/components/snk-attach/readme.md +4 -0
- package/components/snk-configurator/readme.md +4 -0
- package/components/snk-data-exporter/readme.md +6 -0
- package/components/snk-data-unit/readme.md +2 -0
- package/components/snk-dynaform/readme.md +285 -0
- package/components/snk-dynaform/subcomponents/snk-dynaform-detail-view/readme.md +154 -0
- package/components/snk-dynaform/subcomponents/snk-dynaform-form-view/readme.md +98 -0
- package/components/snk-dynaform/subcomponents/snk-dynaform-guides-view/readme.md +202 -0
- package/components/snk-dynaform-form-config/readme.md +57 -0
- package/components/snk-dynaform-form-config/snk-dynaform-config-header/readme.md +47 -0
- package/components/snk-dynaform-form-config/snk-dynaform-config-header/snk-dynaform-configs-button/readme.md +40 -0
- package/components/snk-dynaform-form-config/snk-dynaform-field-item/readme.md +48 -0
- package/components/snk-dynaform-form-config/snk-dynaform-field-item/snk-dynaform-field-config/readme.md +53 -0
- package/components/snk-dynaform-form-config/snk-dynaform-fields-layout/readme.md +65 -0
- package/components/snk-dynaform-form-config/snk-dynaform-fields-selector/readme.md +45 -0
- package/components/snk-dynaform-form-config/snk-dynaform-guides-configurator/readme.md +43 -0
- package/components/snk-filter-bar/readme.md +2 -0
- package/components/snk-grid/readme.md +4 -0
- package/components/snk-image-input/readme.md +2 -0
- package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +6 -0
- package/components/snk-taskbar/elements/taskbar-split-button/readme.md +6 -0
- package/components/snk-taskbar/readme.md +4 -0
- package/package.json +1 -1
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
# snk-dynaform-guides-view
|
|
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
|
+
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
|
14
|
+
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
|
|
15
|
+
| `customGuidesConfig` | -- | Fornece as informações das guias personalizadas. Cada guia personalizada será adicionada como uma aba do tabselector. O conteúdo de cada aba é renderizado através de um slot cujo nome corresponde ao `id` da guia. | `CustomGuideItem[]` | `[]` |
|
|
16
|
+
| `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
|
|
17
|
+
| `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
|
|
18
|
+
| `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
|
|
19
|
+
| `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
|
|
20
|
+
| `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
|
|
21
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
22
|
+
| `getCustomTitle` | -- | Fornece uma função para obter um título customizado do formulário. | `() => string` | `undefined` |
|
|
23
|
+
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
|
|
24
|
+
| `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
|
|
25
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
26
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
|
|
27
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
28
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
29
|
+
| `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
|
|
30
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
## Events
|
|
34
|
+
|
|
35
|
+
| Event | Description | Type |
|
|
36
|
+
| ----------------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
|
|
37
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
38
|
+
| `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
|
|
39
|
+
| `formConfigVisibilityChanged` | Emitido quando a visibilidade do configurador do formulário é alterada. | `CustomEvent<boolean>` |
|
|
40
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
|
41
|
+
| `snkMasterFormConfigChange` | Emitido quando a configuração do formulário master é definida. | `CustomEvent<IFormConfig>` |
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
## Methods
|
|
45
|
+
|
|
46
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => 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
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
|
57
|
+
|
|
58
|
+
Registra um render customizado para colunas da grid.
|
|
59
|
+
|
|
60
|
+
#### Returns
|
|
61
|
+
|
|
62
|
+
Type: `Promise<void>`
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
### `reloadGuides() => Promise<void>`
|
|
67
|
+
|
|
68
|
+
Recarrega os guias baseada nos metadados atuais.
|
|
69
|
+
|
|
70
|
+
#### Returns
|
|
71
|
+
|
|
72
|
+
Type: `Promise<void>`
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
77
|
+
|
|
78
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
79
|
+
|
|
80
|
+
#### Returns
|
|
81
|
+
|
|
82
|
+
Type: `Promise<void>`
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
### `setFocus() => Promise<void>`
|
|
87
|
+
|
|
88
|
+
Atribui o foco para o componente.
|
|
89
|
+
|
|
90
|
+
#### Returns
|
|
91
|
+
|
|
92
|
+
Type: `Promise<void>`
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
### `showFormConfig(detail?: boolean) => Promise<void>`
|
|
97
|
+
|
|
98
|
+
Abre o configurador do formulário
|
|
99
|
+
|
|
100
|
+
#### Returns
|
|
101
|
+
|
|
102
|
+
Type: `Promise<void>`
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
## Dependencies
|
|
108
|
+
|
|
109
|
+
### Used by
|
|
110
|
+
|
|
111
|
+
- [snk-dynaform](../..)
|
|
112
|
+
|
|
113
|
+
### Depends on
|
|
114
|
+
|
|
115
|
+
- [snk-dynaform-form-view](../snk-dynaform-form-view)
|
|
116
|
+
- [snk-dynaform-detail-view](../snk-dynaform-detail-view)
|
|
117
|
+
- [snk-dynaform-form-config](../../../snk-dynaform-form-config)
|
|
118
|
+
- [snk-configurator](../../../snk-configurator)
|
|
119
|
+
- [snk-data-exporter](../../../snk-data-exporter)
|
|
120
|
+
- [snk-actions-button](../../../snk-actions-button)
|
|
121
|
+
- [taskbar-split-button](../../../snk-taskbar/elements/taskbar-split-button)
|
|
122
|
+
- [taskbar-actions-button](../../../snk-taskbar/elements/taskbar-actions-button)
|
|
123
|
+
|
|
124
|
+
### Graph
|
|
125
|
+
```mermaid
|
|
126
|
+
graph TD;
|
|
127
|
+
snk-dynaform-guides-view --> snk-dynaform-form-view
|
|
128
|
+
snk-dynaform-guides-view --> snk-dynaform-detail-view
|
|
129
|
+
snk-dynaform-guides-view --> snk-dynaform-form-config
|
|
130
|
+
snk-dynaform-guides-view --> snk-configurator
|
|
131
|
+
snk-dynaform-guides-view --> snk-data-exporter
|
|
132
|
+
snk-dynaform-guides-view --> snk-actions-button
|
|
133
|
+
snk-dynaform-guides-view --> taskbar-split-button
|
|
134
|
+
snk-dynaform-guides-view --> taskbar-actions-button
|
|
135
|
+
snk-dynaform-form-view --> snk-image-input
|
|
136
|
+
snk-dynaform-detail-view --> snk-dynaform-detail-view
|
|
137
|
+
snk-dynaform-detail-view --> snk-dynaform-form-view
|
|
138
|
+
snk-dynaform-detail-view --> snk-grid
|
|
139
|
+
snk-dynaform-detail-view --> snk-attach
|
|
140
|
+
snk-dynaform-detail-view --> snk-data-unit
|
|
141
|
+
snk-dynaform-detail-view --> snk-taskbar
|
|
142
|
+
snk-dynaform-detail-view --> snk-data-exporter
|
|
143
|
+
snk-dynaform-detail-view --> snk-actions-button
|
|
144
|
+
snk-dynaform-detail-view --> taskbar-split-button
|
|
145
|
+
snk-dynaform-detail-view --> taskbar-actions-button
|
|
146
|
+
snk-grid --> snk-filter-bar
|
|
147
|
+
snk-grid --> snk-taskbar
|
|
148
|
+
snk-grid --> snk-grid-config
|
|
149
|
+
snk-grid --> snk-data-exporter
|
|
150
|
+
snk-grid --> snk-actions-button
|
|
151
|
+
snk-grid --> taskbar-split-button
|
|
152
|
+
snk-grid --> taskbar-actions-button
|
|
153
|
+
snk-filter-bar --> snk-filter-item
|
|
154
|
+
snk-filter-bar --> snk-personalized-filter
|
|
155
|
+
snk-filter-bar --> snk-filter-modal
|
|
156
|
+
snk-filter-item --> snk-filter-detail
|
|
157
|
+
snk-personalized-filter --> snk-filter-field-search
|
|
158
|
+
snk-personalized-filter --> snk-filter-assistent-mode
|
|
159
|
+
snk-personalized-filter --> snk-filter-advanced-mode
|
|
160
|
+
snk-personalized-filter --> snk-simple-bar
|
|
161
|
+
snk-filter-assistent-mode --> snk-expression-group
|
|
162
|
+
snk-expression-group --> snk-expression-item
|
|
163
|
+
snk-expression-group --> snk-expression-group
|
|
164
|
+
snk-expression-item --> snk-filter-field-search
|
|
165
|
+
snk-expression-item --> snk-filter-param-config
|
|
166
|
+
snk-filter-modal --> snk-filter-modal-item
|
|
167
|
+
snk-filter-modal --> snk-default-filter
|
|
168
|
+
snk-taskbar --> snk-taskbar-skeleton
|
|
169
|
+
snk-taskbar --> snk-data-exporter
|
|
170
|
+
snk-taskbar --> snk-actions-button
|
|
171
|
+
snk-taskbar --> taskbar-split-button
|
|
172
|
+
snk-taskbar --> taskbar-actions-button
|
|
173
|
+
snk-data-exporter --> snk-exporter-email-sender
|
|
174
|
+
snk-grid-config --> snk-select-box
|
|
175
|
+
snk-attach --> snk-simple-crud
|
|
176
|
+
snk-simple-crud --> snk-taskbar
|
|
177
|
+
snk-simple-crud --> snk-data-unit
|
|
178
|
+
snk-simple-crud --> snk-simple-form-config
|
|
179
|
+
snk-simple-crud --> snk-configurator
|
|
180
|
+
snk-simple-crud --> snk-grid-config
|
|
181
|
+
snk-simple-crud --> snk-data-exporter
|
|
182
|
+
snk-simple-crud --> snk-actions-button
|
|
183
|
+
snk-simple-crud --> taskbar-split-button
|
|
184
|
+
snk-simple-crud --> taskbar-actions-button
|
|
185
|
+
snk-configurator --> snk-layout-form-config
|
|
186
|
+
snk-configurator --> snk-numbering-config
|
|
187
|
+
snk-layout-form-config --> snk-view-representation
|
|
188
|
+
snk-dynaform-form-config --> snk-dynaform-config-header
|
|
189
|
+
snk-dynaform-form-config --> snk-dynaform-fields-selector
|
|
190
|
+
snk-dynaform-form-config --> snk-dynaform-fields-layout
|
|
191
|
+
snk-dynaform-form-config --> snk-dynaform-guides-configurator
|
|
192
|
+
snk-dynaform-config-header --> snk-dynaform-configs-button
|
|
193
|
+
snk-dynaform-fields-selector --> snk-dynaform-field-item
|
|
194
|
+
snk-dynaform-field-item --> snk-dynaform-field-config
|
|
195
|
+
snk-dynaform-fields-layout --> snk-dynaform-field-item
|
|
196
|
+
snk-dynaform --> snk-dynaform-guides-view
|
|
197
|
+
style snk-dynaform-guides-view fill:#f9f,stroke:#333,stroke-width:4px
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
----------------------------------------------
|
|
201
|
+
|
|
202
|
+
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# snk-dynaform-form-config
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------------------- | ------------------------------ | -------------------------------------------------------------------------------------- | ---------------------- | ----------- |
|
|
12
|
+
| `configManager` | -- | Campos de configuração de formulário. | `SnkFormConfigManager` | `undefined` |
|
|
13
|
+
| `customGuidesConfig` | -- | Informações das guias personalizadas. | `CustomGuideItem[]` | `[]` |
|
|
14
|
+
| `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
|
|
15
|
+
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
|
|
16
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Events
|
|
20
|
+
|
|
21
|
+
| Event | Description | Type |
|
|
22
|
+
| -------------- | ----------------------------------- | -------------------------- |
|
|
23
|
+
| `configChange` | Emitido ao salvar as configurações. | `CustomEvent<IFormConfig>` |
|
|
24
|
+
| `configClose` | Emitido ao fechar as configurações. | `CustomEvent<void>` |
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## Dependencies
|
|
28
|
+
|
|
29
|
+
### Used by
|
|
30
|
+
|
|
31
|
+
- [snk-dynaform-guides-view](../snk-dynaform/subcomponents/snk-dynaform-guides-view)
|
|
32
|
+
|
|
33
|
+
### Depends on
|
|
34
|
+
|
|
35
|
+
- [snk-dynaform-config-header](snk-dynaform-config-header)
|
|
36
|
+
- [snk-dynaform-fields-selector](snk-dynaform-fields-selector)
|
|
37
|
+
- [snk-dynaform-fields-layout](snk-dynaform-fields-layout)
|
|
38
|
+
- [snk-dynaform-guides-configurator](snk-dynaform-guides-configurator)
|
|
39
|
+
|
|
40
|
+
### Graph
|
|
41
|
+
```mermaid
|
|
42
|
+
graph TD;
|
|
43
|
+
snk-dynaform-form-config --> snk-dynaform-config-header
|
|
44
|
+
snk-dynaform-form-config --> snk-dynaform-fields-selector
|
|
45
|
+
snk-dynaform-form-config --> snk-dynaform-fields-layout
|
|
46
|
+
snk-dynaform-form-config --> snk-dynaform-guides-configurator
|
|
47
|
+
snk-dynaform-config-header --> snk-dynaform-configs-button
|
|
48
|
+
snk-dynaform-fields-selector --> snk-dynaform-field-item
|
|
49
|
+
snk-dynaform-field-item --> snk-dynaform-field-config
|
|
50
|
+
snk-dynaform-fields-layout --> snk-dynaform-field-item
|
|
51
|
+
snk-dynaform-guides-view --> snk-dynaform-form-config
|
|
52
|
+
style snk-dynaform-form-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
----------------------------------------------
|
|
56
|
+
|
|
57
|
+
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# snk-dynaform-config-header
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| --------------------- | ----------------------- | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `configOptions` | -- | | `IUserConfig[]` | `[]` |
|
|
13
|
+
| `hasChanges` | `has-changes` | | `boolean` | `false` |
|
|
14
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
15
|
+
| `optionConfigChanged` | `option-config-changed` | | `boolean` | `false` |
|
|
16
|
+
| `selectedConfig` | -- | | `IUserConfig` | `undefined` |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Events
|
|
20
|
+
|
|
21
|
+
| Event | Description | Type |
|
|
22
|
+
| ------------- | ----------- | ------------------- |
|
|
23
|
+
| `configClose` | | `CustomEvent<void>` |
|
|
24
|
+
| `saveConfig` | | `CustomEvent<void>` |
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## Dependencies
|
|
28
|
+
|
|
29
|
+
### Used by
|
|
30
|
+
|
|
31
|
+
- [snk-dynaform-form-config](..)
|
|
32
|
+
|
|
33
|
+
### Depends on
|
|
34
|
+
|
|
35
|
+
- [snk-dynaform-configs-button](snk-dynaform-configs-button)
|
|
36
|
+
|
|
37
|
+
### Graph
|
|
38
|
+
```mermaid
|
|
39
|
+
graph TD;
|
|
40
|
+
snk-dynaform-config-header --> snk-dynaform-configs-button
|
|
41
|
+
snk-dynaform-form-config --> snk-dynaform-config-header
|
|
42
|
+
style snk-dynaform-config-header fill:#f9f,stroke:#333,stroke-width:4px
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
----------------------------------------------
|
|
46
|
+
|
|
47
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# snk-dynaform-configs-button
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | ------------- | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `configOptions` | -- | | `IUserConfig[]` | `[]` |
|
|
13
|
+
| `hasChanges` | `has-changes` | | `boolean` | `false` |
|
|
14
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
15
|
+
| `selectedConfig` | -- | | `IUserConfig` | `undefined` |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Events
|
|
19
|
+
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| -------------------------- | ----------- | -------------------------- |
|
|
22
|
+
| `formConfigOptionSelected` | | `CustomEvent<IUserConfig>` |
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## Dependencies
|
|
26
|
+
|
|
27
|
+
### Used by
|
|
28
|
+
|
|
29
|
+
- [snk-dynaform-config-header](..)
|
|
30
|
+
|
|
31
|
+
### Graph
|
|
32
|
+
```mermaid
|
|
33
|
+
graph TD;
|
|
34
|
+
snk-dynaform-config-header --> snk-dynaform-configs-button
|
|
35
|
+
style snk-dynaform-configs-button fill:#f9f,stroke:#333,stroke-width:4px
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
----------------------------------------------
|
|
39
|
+
|
|
40
|
+
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# snk-dynaform-field-item
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | ------------------ | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
13
|
+
| `fieldConfig` | `field-config` | | `IFieldConfig` | `undefined` |
|
|
14
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
15
|
+
| `onLayoutConfig` | `on-layout-config` | | `boolean` | `false` |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Events
|
|
19
|
+
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| --------------------- | ----------- | --------------------------- |
|
|
22
|
+
| `addFieldToGuide` | | `CustomEvent<IFieldConfig>` |
|
|
23
|
+
| `setFieldAsAvailable` | | `CustomEvent<IFieldConfig>` |
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
## Dependencies
|
|
27
|
+
|
|
28
|
+
### Used by
|
|
29
|
+
|
|
30
|
+
- [snk-dynaform-fields-layout](../snk-dynaform-fields-layout)
|
|
31
|
+
- [snk-dynaform-fields-selector](../snk-dynaform-fields-selector)
|
|
32
|
+
|
|
33
|
+
### Depends on
|
|
34
|
+
|
|
35
|
+
- [snk-dynaform-field-config](snk-dynaform-field-config)
|
|
36
|
+
|
|
37
|
+
### Graph
|
|
38
|
+
```mermaid
|
|
39
|
+
graph TD;
|
|
40
|
+
snk-dynaform-field-item --> snk-dynaform-field-config
|
|
41
|
+
snk-dynaform-fields-layout --> snk-dynaform-field-item
|
|
42
|
+
snk-dynaform-fields-selector --> snk-dynaform-field-item
|
|
43
|
+
style snk-dynaform-field-item fill:#f9f,stroke:#333,stroke-width:4px
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
----------------------------------------------
|
|
47
|
+
|
|
48
|
+
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# snk-dynaform-field-config
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | -------------- | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
13
|
+
| `fieldConfig` | `field-config` | | `IFieldConfig` | `undefined` |
|
|
14
|
+
| `fieldDescriptor` | -- | | `FieldDescriptor` | `undefined` |
|
|
15
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Events
|
|
19
|
+
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| -------------------- | ----------- | --------------------------- |
|
|
22
|
+
| `fieldConfigChanged` | | `CustomEvent<IFieldConfig>` |
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## Methods
|
|
26
|
+
|
|
27
|
+
### `show(_anchorElement: HTMLElement) => Promise<void>`
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
#### Returns
|
|
32
|
+
|
|
33
|
+
Type: `Promise<void>`
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## Dependencies
|
|
39
|
+
|
|
40
|
+
### Used by
|
|
41
|
+
|
|
42
|
+
- [snk-dynaform-field-item](..)
|
|
43
|
+
|
|
44
|
+
### Graph
|
|
45
|
+
```mermaid
|
|
46
|
+
graph TD;
|
|
47
|
+
snk-dynaform-field-item --> snk-dynaform-field-config
|
|
48
|
+
style snk-dynaform-field-config fill:#f9f,stroke:#333,stroke-width:4px
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
----------------------------------------------
|
|
52
|
+
|
|
53
|
+
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# snk-dynaform-fields-layout
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | ----------------- | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
13
|
+
| `groupsList` | -- | | `IGroupConfig[]` | `[]` |
|
|
14
|
+
| `guideNames` | -- | | `string[]` | `[]` |
|
|
15
|
+
| `isMainSection` | `is-main-section` | | `boolean` | `false` |
|
|
16
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
17
|
+
| `selectedGuide` | -- | | `IGuideConfig` | `undefined` |
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## Events
|
|
21
|
+
|
|
22
|
+
| Event | Description | Type |
|
|
23
|
+
| ------------------------- | ----------- | ----------------------------- |
|
|
24
|
+
| `guideRenamed` | | `CustomEvent<string>` |
|
|
25
|
+
| `isEditingGroupName` | | `CustomEvent<boolean>` |
|
|
26
|
+
| `isEditingGuideName` | | `CustomEvent<boolean>` |
|
|
27
|
+
| `layoutChanged` | | `CustomEvent<IGroupConfig[]>` |
|
|
28
|
+
| `setFieldListAsAvailable` | | `CustomEvent<IFieldConfig[]>` |
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## Methods
|
|
32
|
+
|
|
33
|
+
### `addFieldToLayout(incomingField: IFieldConfig) => Promise<void>`
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
#### Returns
|
|
38
|
+
|
|
39
|
+
Type: `Promise<void>`
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
## Dependencies
|
|
45
|
+
|
|
46
|
+
### Used by
|
|
47
|
+
|
|
48
|
+
- [snk-dynaform-form-config](..)
|
|
49
|
+
|
|
50
|
+
### Depends on
|
|
51
|
+
|
|
52
|
+
- [snk-dynaform-field-item](../snk-dynaform-field-item)
|
|
53
|
+
|
|
54
|
+
### Graph
|
|
55
|
+
```mermaid
|
|
56
|
+
graph TD;
|
|
57
|
+
snk-dynaform-fields-layout --> snk-dynaform-field-item
|
|
58
|
+
snk-dynaform-field-item --> snk-dynaform-field-config
|
|
59
|
+
snk-dynaform-form-config --> snk-dynaform-fields-layout
|
|
60
|
+
style snk-dynaform-fields-layout fill:#f9f,stroke:#333,stroke-width:4px
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
----------------------------------------------
|
|
64
|
+
|
|
65
|
+
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# snk-dynaform-fields-selector
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | --------- | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `availableFields` | -- | | `IFieldConfig[]` | `[]` |
|
|
13
|
+
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
14
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## Events
|
|
18
|
+
|
|
19
|
+
| Event | Description | Type |
|
|
20
|
+
| ------------------ | ----------- | ----------------------------- |
|
|
21
|
+
| `fieldListChanged` | | `CustomEvent<IFieldConfig[]>` |
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
## Dependencies
|
|
25
|
+
|
|
26
|
+
### Used by
|
|
27
|
+
|
|
28
|
+
- [snk-dynaform-form-config](..)
|
|
29
|
+
|
|
30
|
+
### Depends on
|
|
31
|
+
|
|
32
|
+
- [snk-dynaform-field-item](../snk-dynaform-field-item)
|
|
33
|
+
|
|
34
|
+
### Graph
|
|
35
|
+
```mermaid
|
|
36
|
+
graph TD;
|
|
37
|
+
snk-dynaform-fields-selector --> snk-dynaform-field-item
|
|
38
|
+
snk-dynaform-field-item --> snk-dynaform-field-config
|
|
39
|
+
snk-dynaform-form-config --> snk-dynaform-fields-selector
|
|
40
|
+
style snk-dynaform-fields-selector fill:#f9f,stroke:#333,stroke-width:4px
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
----------------------------------------------
|
|
44
|
+
|
|
45
|
+
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# snk-dynaform-guides-configurator
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | ----------------- | ----------- | ------------------- | ----------- |
|
|
12
|
+
| `guidesList` | -- | | `IGuideConfig[]` | `[]` |
|
|
13
|
+
| `mainGuideName` | `main-guide-name` | | `string` | `undefined` |
|
|
14
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
|
15
|
+
| `selectedGuide` | -- | | `IGuideConfig` | `undefined` |
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Events
|
|
19
|
+
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| ------------------ | ----------- | ----------------------------- |
|
|
22
|
+
| `createNewGuide` | | `CustomEvent<void>` |
|
|
23
|
+
| `guideDeleted` | | `CustomEvent<IGuideConfig>` |
|
|
24
|
+
| `guideListChanged` | | `CustomEvent<IGuideConfig[]>` |
|
|
25
|
+
| `guideSelected` | | `CustomEvent<IGuideConfig>` |
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## Dependencies
|
|
29
|
+
|
|
30
|
+
### Used by
|
|
31
|
+
|
|
32
|
+
- [snk-dynaform-form-config](..)
|
|
33
|
+
|
|
34
|
+
### Graph
|
|
35
|
+
```mermaid
|
|
36
|
+
graph TD;
|
|
37
|
+
snk-dynaform-form-config --> snk-dynaform-guides-configurator
|
|
38
|
+
style snk-dynaform-guides-configurator fill:#f9f,stroke:#333,stroke-width:4px
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
----------------------------------------------
|
|
42
|
+
|
|
43
|
+
|
|
@@ -123,6 +123,7 @@ Retorna uma Promise que resolve quando a atualização for concluída.
|
|
|
123
123
|
### Used by
|
|
124
124
|
|
|
125
125
|
- [snk-crud](../snk-crud)
|
|
126
|
+
- [snk-dynaform](../snk-dynaform)
|
|
126
127
|
- [snk-grid](../snk-grid)
|
|
127
128
|
|
|
128
129
|
### Depends on
|
|
@@ -150,6 +151,7 @@ graph TD;
|
|
|
150
151
|
snk-filter-modal --> snk-filter-modal-item
|
|
151
152
|
snk-filter-modal --> snk-default-filter
|
|
152
153
|
snk-crud --> snk-filter-bar
|
|
154
|
+
snk-dynaform --> snk-filter-bar
|
|
153
155
|
snk-grid --> snk-filter-bar
|
|
154
156
|
style snk-filter-bar fill:#f9f,stroke:#333,stroke-width:4px
|
|
155
157
|
```
|
|
@@ -238,6 +238,8 @@ Uma promessa que é resolvida quando a janela de configuração é exibida.
|
|
|
238
238
|
|
|
239
239
|
- [snk-crud](../snk-crud)
|
|
240
240
|
- [snk-detail-view](../snk-crud/subcomponents/snk-detail-view)
|
|
241
|
+
- [snk-dynaform](../snk-dynaform)
|
|
242
|
+
- [snk-dynaform-detail-view](../snk-dynaform/subcomponents/snk-dynaform-detail-view)
|
|
241
243
|
|
|
242
244
|
### Depends on
|
|
243
245
|
|
|
@@ -283,6 +285,8 @@ graph TD;
|
|
|
283
285
|
snk-grid-config --> snk-select-box
|
|
284
286
|
snk-crud --> snk-grid
|
|
285
287
|
snk-detail-view --> snk-grid
|
|
288
|
+
snk-dynaform --> snk-grid
|
|
289
|
+
snk-dynaform-detail-view --> snk-grid
|
|
286
290
|
style snk-grid fill:#f9f,stroke:#333,stroke-width:4px
|
|
287
291
|
```
|
|
288
292
|
|
|
@@ -42,11 +42,13 @@ Type: `Promise<void>`
|
|
|
42
42
|
|
|
43
43
|
### Used by
|
|
44
44
|
|
|
45
|
+
- [snk-dynaform-form-view](../snk-dynaform/subcomponents/snk-dynaform-form-view)
|
|
45
46
|
- [snk-form-view](../snk-crud/subcomponents)
|
|
46
47
|
|
|
47
48
|
### Graph
|
|
48
49
|
```mermaid
|
|
49
50
|
graph TD;
|
|
51
|
+
snk-dynaform-form-view --> snk-image-input
|
|
50
52
|
snk-form-view --> snk-image-input
|
|
51
53
|
style snk-image-input fill:#f9f,stroke:#333,stroke-width:4px
|
|
52
54
|
```
|