@sankhyalabs/sankhyablocks-docs 10.1.0-dev.6 → 10.1.0-dev.60
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 +13 -0
- package/components/snk-application/readme.md +8 -8
- package/components/snk-attach/readme.md +32 -5
- package/components/snk-configurator/readme.md +4 -0
- package/components/snk-crud/readme.md +22 -15
- package/components/snk-crud/subcomponents/readme.md +3 -3
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +2 -1
- package/components/snk-custom-slot-guide/readme.md +24 -0
- package/components/snk-data-exporter/readme.md +11 -4
- 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 +206 -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/filter-item/readme.md +1 -0
- package/components/snk-filter-bar/filter-modal/readme.md +15 -15
- package/components/snk-filter-bar/readme.md +8 -0
- package/components/snk-grid/readme.md +78 -40
- package/components/snk-grid-config/readme.md +9 -7
- package/components/snk-image-input/readme.md +58 -0
- package/components/snk-pesquisa/readme.md +1 -1
- package/components/snk-simple-bar/readme.md +0 -2
- package/components/snk-simple-crud/readme.md +34 -32
- package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +12 -5
- package/components/snk-taskbar/elements/taskbar-split-button/readme.md +17 -10
- package/components/snk-taskbar/readme.md +11 -2
- package/components/snk-taskbar/subcomponents/readme.md +23 -0
- package/package.json +1 -1
|
@@ -0,0 +1,206 @@
|
|
|
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
|
+
| `collapsibleMaster` | `collapsible-master` | Habilita o recolhimento automático do formulário master quando uma aba de detalhe está ativa e o espaço vertical está apertado (zoom alto). | `boolean` | `true` |
|
|
15
|
+
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
|
|
16
|
+
| `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[]` | `[]` |
|
|
17
|
+
| `dataState` | -- | Representa o estado do dataUnit master. | `DataState` | `undefined` |
|
|
18
|
+
| `dataUnit` | -- | Instância do DataUnit master. | `DataUnit` | `undefined` |
|
|
19
|
+
| `detailTaskbarCustomContainerId` | `detail-taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. | `string` | `undefined` |
|
|
20
|
+
| `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
|
|
21
|
+
| `entityPath` | `entity-path` | Determina todo o caminho de entidades. | `string` | `undefined` |
|
|
22
|
+
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
23
|
+
| `getCustomTitle` | -- | Fornece uma função para obter um título customizado do formulário. | `() => string` | `undefined` |
|
|
24
|
+
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
|
|
25
|
+
| `masterCollapseThreshold` | `master-collapse-threshold` | Altura (px) do container abaixo da qual o espaço é considerado "apertado". Em zoom alto o viewport encolhe em px de CSS, disparando o recolhimento. | `number` | `700` |
|
|
26
|
+
| `masterFormConfig` | -- | Configuração do formulário master. | `IFormConfig` | `undefined` |
|
|
27
|
+
| `masterSummaryFieldCount` | `master-summary-field-count` | Máximo de campos considerados para a tira-resumo do master recolhido. A quantidade realmente exibida é dinâmica: mostra quantos couberem na largura disponível, até este limite. | `number` | `12` |
|
|
28
|
+
| `maxOpenedGuides` | `max-opened-guides` | Máximo de abas mantidas montadas ao mesmo tempo. Abas ficam montadas p/ voltar sem recarregar, mas cada aba de detalhe mantém um DataUnit vivo que recarrega ao navegar o registro master. Sem limite, visitar N abas gera N recargas em segundo plano por navegação. Este teto retém a aba ativa + as inseridas mais recentemente (ordem de inserção, não de uso — a lista não é reordenada ao reabrir uma aba); as demais são desmontadas (voltar a elas recarrega). Use <= 0 para não limitar. | `number` | `4` |
|
|
29
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
30
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `undefined` |
|
|
31
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
32
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
33
|
+
| `selectedGuide` | -- | Guia selecionada. | `IGuideItem` | `undefined` |
|
|
34
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
## Events
|
|
38
|
+
|
|
39
|
+
| Event | Description | Type |
|
|
40
|
+
| ----------------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
|
|
41
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
42
|
+
| `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
|
|
43
|
+
| `formConfigVisibilityChanged` | Emitido quando a visibilidade do configurador do formulário é alterada. | `CustomEvent<boolean>` |
|
|
44
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
|
45
|
+
| `snkMasterFormConfigChange` | Emitido quando a configuração do formulário master é definida. | `CustomEvent<IFormConfig>` |
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
## Methods
|
|
49
|
+
|
|
50
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
|
|
51
|
+
|
|
52
|
+
Registra um editor customizado para campos da grade e formulário
|
|
53
|
+
|
|
54
|
+
#### Returns
|
|
55
|
+
|
|
56
|
+
Type: `Promise<void>`
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
|
61
|
+
|
|
62
|
+
Registra um render customizado para colunas da grid.
|
|
63
|
+
|
|
64
|
+
#### Returns
|
|
65
|
+
|
|
66
|
+
Type: `Promise<void>`
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
### `reloadGuides() => Promise<void>`
|
|
71
|
+
|
|
72
|
+
Recarrega os guias baseada nos metadados atuais.
|
|
73
|
+
|
|
74
|
+
#### Returns
|
|
75
|
+
|
|
76
|
+
Type: `Promise<void>`
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
81
|
+
|
|
82
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
83
|
+
|
|
84
|
+
#### Returns
|
|
85
|
+
|
|
86
|
+
Type: `Promise<void>`
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
### `setFocus() => Promise<void>`
|
|
91
|
+
|
|
92
|
+
Atribui o foco para o componente.
|
|
93
|
+
|
|
94
|
+
#### Returns
|
|
95
|
+
|
|
96
|
+
Type: `Promise<void>`
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
### `showFormConfig(detail?: boolean) => Promise<void>`
|
|
101
|
+
|
|
102
|
+
Abre o configurador do formulário
|
|
103
|
+
|
|
104
|
+
#### Returns
|
|
105
|
+
|
|
106
|
+
Type: `Promise<void>`
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
## Dependencies
|
|
112
|
+
|
|
113
|
+
### Used by
|
|
114
|
+
|
|
115
|
+
- [snk-dynaform](../..)
|
|
116
|
+
|
|
117
|
+
### Depends on
|
|
118
|
+
|
|
119
|
+
- [snk-dynaform-form-view](../snk-dynaform-form-view)
|
|
120
|
+
- [snk-dynaform-detail-view](../snk-dynaform-detail-view)
|
|
121
|
+
- [snk-dynaform-form-config](../../../snk-dynaform-form-config)
|
|
122
|
+
- [snk-configurator](../../../snk-configurator)
|
|
123
|
+
- [snk-data-exporter](../../../snk-data-exporter)
|
|
124
|
+
- [snk-actions-button](../../../snk-actions-button)
|
|
125
|
+
- [taskbar-split-button](../../../snk-taskbar/elements/taskbar-split-button)
|
|
126
|
+
- [taskbar-actions-button](../../../snk-taskbar/elements/taskbar-actions-button)
|
|
127
|
+
|
|
128
|
+
### Graph
|
|
129
|
+
```mermaid
|
|
130
|
+
graph TD;
|
|
131
|
+
snk-dynaform-guides-view --> snk-dynaform-form-view
|
|
132
|
+
snk-dynaform-guides-view --> snk-dynaform-detail-view
|
|
133
|
+
snk-dynaform-guides-view --> snk-dynaform-form-config
|
|
134
|
+
snk-dynaform-guides-view --> snk-configurator
|
|
135
|
+
snk-dynaform-guides-view --> snk-data-exporter
|
|
136
|
+
snk-dynaform-guides-view --> snk-actions-button
|
|
137
|
+
snk-dynaform-guides-view --> taskbar-split-button
|
|
138
|
+
snk-dynaform-guides-view --> taskbar-actions-button
|
|
139
|
+
snk-dynaform-form-view --> snk-image-input
|
|
140
|
+
snk-dynaform-detail-view --> snk-dynaform-detail-view
|
|
141
|
+
snk-dynaform-detail-view --> snk-dynaform-form-view
|
|
142
|
+
snk-dynaform-detail-view --> snk-grid
|
|
143
|
+
snk-dynaform-detail-view --> snk-attach
|
|
144
|
+
snk-dynaform-detail-view --> snk-data-unit
|
|
145
|
+
snk-dynaform-detail-view --> snk-taskbar
|
|
146
|
+
snk-dynaform-detail-view --> snk-data-exporter
|
|
147
|
+
snk-dynaform-detail-view --> snk-actions-button
|
|
148
|
+
snk-dynaform-detail-view --> taskbar-split-button
|
|
149
|
+
snk-dynaform-detail-view --> taskbar-actions-button
|
|
150
|
+
snk-grid --> snk-filter-bar
|
|
151
|
+
snk-grid --> snk-taskbar
|
|
152
|
+
snk-grid --> snk-grid-config
|
|
153
|
+
snk-grid --> snk-data-exporter
|
|
154
|
+
snk-grid --> snk-actions-button
|
|
155
|
+
snk-grid --> taskbar-split-button
|
|
156
|
+
snk-grid --> taskbar-actions-button
|
|
157
|
+
snk-filter-bar --> snk-filter-item
|
|
158
|
+
snk-filter-bar --> snk-personalized-filter
|
|
159
|
+
snk-filter-bar --> snk-filter-modal
|
|
160
|
+
snk-filter-item --> snk-filter-detail
|
|
161
|
+
snk-personalized-filter --> snk-filter-field-search
|
|
162
|
+
snk-personalized-filter --> snk-filter-assistent-mode
|
|
163
|
+
snk-personalized-filter --> snk-filter-advanced-mode
|
|
164
|
+
snk-personalized-filter --> snk-simple-bar
|
|
165
|
+
snk-filter-assistent-mode --> snk-expression-group
|
|
166
|
+
snk-expression-group --> snk-expression-item
|
|
167
|
+
snk-expression-group --> snk-expression-group
|
|
168
|
+
snk-expression-item --> snk-filter-field-search
|
|
169
|
+
snk-expression-item --> snk-filter-param-config
|
|
170
|
+
snk-filter-modal --> snk-filter-modal-item
|
|
171
|
+
snk-filter-modal --> snk-default-filter
|
|
172
|
+
snk-taskbar --> snk-taskbar-skeleton
|
|
173
|
+
snk-taskbar --> snk-data-exporter
|
|
174
|
+
snk-taskbar --> snk-actions-button
|
|
175
|
+
snk-taskbar --> taskbar-split-button
|
|
176
|
+
snk-taskbar --> taskbar-actions-button
|
|
177
|
+
snk-data-exporter --> snk-exporter-email-sender
|
|
178
|
+
snk-grid-config --> snk-select-box
|
|
179
|
+
snk-attach --> snk-simple-crud
|
|
180
|
+
snk-simple-crud --> snk-taskbar
|
|
181
|
+
snk-simple-crud --> snk-data-unit
|
|
182
|
+
snk-simple-crud --> snk-simple-form-config
|
|
183
|
+
snk-simple-crud --> snk-configurator
|
|
184
|
+
snk-simple-crud --> snk-grid-config
|
|
185
|
+
snk-simple-crud --> snk-data-exporter
|
|
186
|
+
snk-simple-crud --> snk-actions-button
|
|
187
|
+
snk-simple-crud --> taskbar-split-button
|
|
188
|
+
snk-simple-crud --> taskbar-actions-button
|
|
189
|
+
snk-configurator --> snk-layout-form-config
|
|
190
|
+
snk-configurator --> snk-numbering-config
|
|
191
|
+
snk-layout-form-config --> snk-view-representation
|
|
192
|
+
snk-dynaform-form-config --> snk-dynaform-config-header
|
|
193
|
+
snk-dynaform-form-config --> snk-dynaform-fields-selector
|
|
194
|
+
snk-dynaform-form-config --> snk-dynaform-fields-layout
|
|
195
|
+
snk-dynaform-form-config --> snk-dynaform-guides-configurator
|
|
196
|
+
snk-dynaform-config-header --> snk-dynaform-configs-button
|
|
197
|
+
snk-dynaform-fields-selector --> snk-dynaform-field-item
|
|
198
|
+
snk-dynaform-field-item --> snk-dynaform-field-config
|
|
199
|
+
snk-dynaform-fields-layout --> snk-dynaform-field-item
|
|
200
|
+
snk-dynaform --> snk-dynaform-guides-view
|
|
201
|
+
style snk-dynaform-guides-view fill:#f9f,stroke:#333,stroke-width:4px
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
----------------------------------------------
|
|
205
|
+
|
|
206
|
+
|
|
@@ -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
|
+
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
| `config` | -- | Define as configurações do componente snk-filter-item. | `SnkFilterItemConfig` | `undefined` |
|
|
13
13
|
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
14
14
|
| `showChips` | `show-chips` | Usado para controlar a visibilidade dos chips de filtros | `boolean` | `true` |
|
|
15
|
+
| `sizeChips` | `size-chips` | | `"default" \| "large" \| "medium"` | `'default'` |
|
|
15
16
|
|
|
16
17
|
|
|
17
18
|
## Events
|