@sankhyalabs/sankhyablocks-docs 9.0.3 → 9.1.0-dev.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/components/snk-application/readme.md +31 -0
- package/components/snk-attach/readme.md +12 -9
- package/components/snk-crud/readme.md +17 -4
- package/components/snk-crud/subcomponents/readme.md +20 -18
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +23 -17
- package/components/snk-entity-list/readme.md +1 -0
- package/components/snk-filter-bar/filter-modal/readme.md +15 -12
- package/components/snk-filter-bar/filter-modal/subcomponents/snk-default-filter/readme.md +38 -0
- package/components/snk-form/readme.md +8 -3
- package/components/snk-form-config/config-header/configs-button/readme.md +40 -0
- package/components/snk-form-config/config-header/readme.md +47 -0
- package/components/snk-form-config/field-item/field-config/readme.md +53 -0
- package/components/snk-form-config/field-item/readme.md +48 -0
- package/components/snk-form-config/fields-layout/readme.md +64 -0
- package/components/snk-form-config/fields-selector/readme.md +44 -0
- package/components/snk-form-config/guides-configurator/readme.md +42 -0
- package/components/snk-form-config/readme.md +13 -7
- package/components/snk-grid/readme.md +8 -10
- package/components/snk-grid-config/snk-select-box/readme.md +4 -3
- package/components/snk-personalized-filter/readme.md +8 -7
- package/components/snk-personalized-filter/subcomponents/snk-expression-group/readme.md +8 -7
- package/components/snk-personalized-filter/subcomponents/snk-expression-item/readme.md +7 -6
- package/components/snk-personalized-filter/subcomponents/snk-filter-assistent-mode/readme.md +8 -7
- package/components/snk-simple-crud/readme.md +5 -1
- package/components/snk-taskbar/elements/taskbar-split-button/readme.md +47 -0
- package/components/snk-taskbar/readme.md +19 -16
- package/package.json +1 -1
- package/components/snk-form-config/subcomponents/snk-config-options/readme.md +0 -40
- package/components/snk-form-config/subcomponents/snk-field-config/readme.md +0 -41
- package/components/snk-form-config/subcomponents/snk-tab-config/readme.md +0 -46
@@ -87,6 +87,16 @@ Type: `Promise<any>`
|
|
87
87
|
|
88
88
|
|
89
89
|
|
90
|
+
### `clearPopUpTitle() => Promise<void>`
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
#### Returns
|
95
|
+
|
96
|
+
Type: `Promise<void>`
|
97
|
+
|
98
|
+
|
99
|
+
|
90
100
|
### `closeModal() => Promise<void>`
|
91
101
|
|
92
102
|
Fecha o Modal e limpa o conteúdo.
|
@@ -149,6 +159,17 @@ Type: `Promise<IOption | IOption[]>`
|
|
149
159
|
|
150
160
|
|
151
161
|
|
162
|
+
### `executePreparedSearchPlus(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
|
163
|
+
|
164
|
+
Realiza a pesquisa de registros
|
165
|
+
Ex.: snk-config-options
|
166
|
+
|
167
|
+
#### Returns
|
168
|
+
|
169
|
+
Type: `Promise<IOption | IOption[]>`
|
170
|
+
|
171
|
+
|
172
|
+
|
152
173
|
### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption> | IOption>`
|
153
174
|
|
154
175
|
Obtém as opções em componentes de pesquisa
|
@@ -483,6 +504,16 @@ Type: `Promise<any>`
|
|
483
504
|
|
484
505
|
|
485
506
|
|
507
|
+
### `setPopUpTitle(title: string) => Promise<void>`
|
508
|
+
|
509
|
+
|
510
|
+
|
511
|
+
#### Returns
|
512
|
+
|
513
|
+
Type: `Promise<void>`
|
514
|
+
|
515
|
+
|
516
|
+
|
486
517
|
### `setSearchFilterContext(name: string, value: string) => Promise<void>`
|
487
518
|
|
488
519
|
Atribui valor para parâmetros de contexto no componente de pesquisa.
|
@@ -7,15 +7,16 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute
|
11
|
-
| -------------------------- |
|
12
|
-
| `dataUnit` | --
|
13
|
-
| `dataUnitBuilder` | --
|
14
|
-
| `entityName` | `entity-name`
|
15
|
-
| `fetcher` | --
|
16
|
-
| `fetcherType` | `fetcher-type`
|
17
|
-
| `
|
18
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| -------------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------- | ----------- |
|
12
|
+
| `dataUnit` | -- | DataUnit responsável por carregar os dados. | `DataUnit` | `undefined` |
|
13
|
+
| `dataUnitBuilder` | -- | DataUnitBuilder responsável por implementar dados a serem utilizados no DataUnit. | `FetcherFacade` | `undefined` |
|
14
|
+
| `entityName` | `entity-name` | Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. | `string` | `undefined` |
|
15
|
+
| `fetcher` | -- | Fetcher responsável por carregar os dados do DataUnit. | `AttachFetcherFacadeInterface` | `undefined` |
|
16
|
+
| `fetcherType` | `fetcher-type` | FetcherType define o tipo de fetcher responsável por carregar os dados do DataUnit. | `"AnexoSistema" \| "Another" \| "Attach"` | `undefined` |
|
17
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grid. | `string` | `undefined` |
|
18
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
19
|
+
| `registerKey` _(required)_ | `register-key` | Identificação do registro pai. | `string` | `undefined` |
|
19
20
|
|
20
21
|
|
21
22
|
## Events
|
@@ -49,9 +50,11 @@ graph TD;
|
|
49
50
|
snk-simple-crud --> snk-grid-config
|
50
51
|
snk-simple-crud --> snk-data-exporter
|
51
52
|
snk-simple-crud --> snk-actions-button
|
53
|
+
snk-simple-crud --> taskbar-split-button
|
52
54
|
snk-simple-crud --> taskbar-actions-button
|
53
55
|
snk-taskbar --> snk-data-exporter
|
54
56
|
snk-taskbar --> snk-actions-button
|
57
|
+
snk-taskbar --> taskbar-split-button
|
55
58
|
snk-taskbar --> taskbar-actions-button
|
56
59
|
snk-data-exporter --> snk-exporter-email-sender
|
57
60
|
snk-configurator --> snk-layout-form-config
|
@@ -23,8 +23,9 @@
|
|
23
23
|
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
24
24
|
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
25
25
|
| `ignoreReadOnlyFormFields` | `ignore-read-only-form-fields` | Ignora os campos "somente leitura" no modo de inserção. | `boolean` | `undefined` |
|
26
|
-
| `layoutFormConfig` | `layout-form-config` |
|
26
|
+
| `layoutFormConfig` | `layout-form-config` | Define se o LayoutFormConfig será exibido no configurador. | `boolean` | `false` |
|
27
27
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
28
|
+
| `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
|
28
29
|
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
|
29
30
|
| `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
|
30
31
|
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
@@ -162,6 +163,7 @@ Type: `Promise<void>`
|
|
162
163
|
- [snk-configurator](../snk-configurator)
|
163
164
|
- [snk-data-exporter](../snk-data-exporter)
|
164
165
|
- [snk-actions-button](../snk-actions-button)
|
166
|
+
- [taskbar-split-button](../snk-taskbar/elements/taskbar-split-button)
|
165
167
|
- [taskbar-actions-button](../snk-taskbar/elements/taskbar-actions-button)
|
166
168
|
|
167
169
|
### Graph
|
@@ -173,12 +175,14 @@ graph TD;
|
|
173
175
|
snk-crud --> snk-configurator
|
174
176
|
snk-crud --> snk-data-exporter
|
175
177
|
snk-crud --> snk-actions-button
|
178
|
+
snk-crud --> taskbar-split-button
|
176
179
|
snk-crud --> taskbar-actions-button
|
177
180
|
snk-grid --> snk-filter-bar
|
178
181
|
snk-grid --> snk-taskbar
|
179
182
|
snk-grid --> snk-grid-config
|
180
183
|
snk-grid --> snk-data-exporter
|
181
184
|
snk-grid --> snk-actions-button
|
185
|
+
snk-grid --> taskbar-split-button
|
182
186
|
snk-grid --> taskbar-actions-button
|
183
187
|
snk-filter-bar --> snk-filter-item
|
184
188
|
snk-filter-bar --> snk-personalized-filter
|
@@ -194,6 +198,7 @@ graph TD;
|
|
194
198
|
snk-expression-item --> snk-filter-param-config
|
195
199
|
snk-taskbar --> snk-data-exporter
|
196
200
|
snk-taskbar --> snk-actions-button
|
201
|
+
snk-taskbar --> taskbar-split-button
|
197
202
|
snk-taskbar --> taskbar-actions-button
|
198
203
|
snk-data-exporter --> snk-exporter-email-sender
|
199
204
|
snk-grid-config --> snk-select-box
|
@@ -205,6 +210,7 @@ graph TD;
|
|
205
210
|
snk-guides-viewer --> snk-configurator
|
206
211
|
snk-guides-viewer --> snk-data-exporter
|
207
212
|
snk-guides-viewer --> snk-actions-button
|
213
|
+
snk-guides-viewer --> taskbar-split-button
|
208
214
|
snk-guides-viewer --> taskbar-actions-button
|
209
215
|
snk-form-view --> snk-form-summary
|
210
216
|
snk-detail-view --> snk-data-unit
|
@@ -214,6 +220,7 @@ graph TD;
|
|
214
220
|
snk-detail-view --> snk-attach
|
215
221
|
snk-detail-view --> snk-data-exporter
|
216
222
|
snk-detail-view --> snk-actions-button
|
223
|
+
snk-detail-view --> taskbar-split-button
|
217
224
|
snk-detail-view --> taskbar-actions-button
|
218
225
|
snk-attach --> snk-simple-bar
|
219
226
|
snk-attach --> snk-simple-crud
|
@@ -224,12 +231,18 @@ graph TD;
|
|
224
231
|
snk-simple-crud --> snk-grid-config
|
225
232
|
snk-simple-crud --> snk-data-exporter
|
226
233
|
snk-simple-crud --> snk-actions-button
|
234
|
+
snk-simple-crud --> taskbar-split-button
|
227
235
|
snk-simple-crud --> taskbar-actions-button
|
228
236
|
snk-configurator --> snk-layout-form-config
|
229
237
|
snk-layout-form-config --> snk-view-representation
|
230
|
-
snk-form-config -->
|
231
|
-
snk-form-config -->
|
232
|
-
snk-form-config -->
|
238
|
+
snk-form-config --> config-header
|
239
|
+
snk-form-config --> guides-configurator
|
240
|
+
snk-form-config --> fields-layout
|
241
|
+
snk-form-config --> fields-selector
|
242
|
+
config-header --> configs-button
|
243
|
+
fields-layout --> field-item
|
244
|
+
field-item --> field-config
|
245
|
+
fields-selector --> field-item
|
233
246
|
style snk-crud fill:#f9f,stroke:#333,stroke-width:4px
|
234
247
|
```
|
235
248
|
|
@@ -31,11 +31,12 @@
|
|
31
31
|
|
32
32
|
## Events
|
33
33
|
|
34
|
-
| Event
|
35
|
-
|
|
36
|
-
| `actionClick`
|
37
|
-
| `exit`
|
38
|
-
| `formItemsReady`
|
34
|
+
| Event | Description | Type |
|
35
|
+
| --------------------------- | ------------------------------------------------------------------------------- | ---------------------------- |
|
36
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
37
|
+
| `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
|
38
|
+
| `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
|
39
|
+
| `snkMasterFormConfigChange` | Emitido quando a configuração do formulário master é definida. | `CustomEvent<IFormConfig>` |
|
39
40
|
|
40
41
|
|
41
42
|
## Methods
|
@@ -60,16 +61,6 @@ Type: `Promise<void>`
|
|
60
61
|
|
61
62
|
|
62
63
|
|
63
|
-
### `findField() => Promise<void>`
|
64
|
-
|
65
|
-
Abre o localizador de campos
|
66
|
-
|
67
|
-
#### Returns
|
68
|
-
|
69
|
-
Type: `Promise<void>`
|
70
|
-
|
71
|
-
|
72
|
-
|
73
64
|
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
74
65
|
|
75
66
|
Altera/adiciona uma propriedade nos metadados do campo.
|
@@ -117,6 +108,7 @@ Type: `Promise<void>`
|
|
117
108
|
- [snk-configurator](../../snk-configurator)
|
118
109
|
- [snk-data-exporter](../../snk-data-exporter)
|
119
110
|
- [snk-actions-button](../../snk-actions-button)
|
111
|
+
- [taskbar-split-button](../../snk-taskbar/elements/taskbar-split-button)
|
120
112
|
- [taskbar-actions-button](../../snk-taskbar/elements/taskbar-actions-button)
|
121
113
|
|
122
114
|
### Graph
|
@@ -130,6 +122,7 @@ graph TD;
|
|
130
122
|
snk-guides-viewer --> snk-configurator
|
131
123
|
snk-guides-viewer --> snk-data-exporter
|
132
124
|
snk-guides-viewer --> snk-actions-button
|
125
|
+
snk-guides-viewer --> taskbar-split-button
|
133
126
|
snk-guides-viewer --> taskbar-actions-button
|
134
127
|
snk-form-view --> snk-form-summary
|
135
128
|
snk-detail-view --> snk-data-unit
|
@@ -139,12 +132,14 @@ graph TD;
|
|
139
132
|
snk-detail-view --> snk-attach
|
140
133
|
snk-detail-view --> snk-data-exporter
|
141
134
|
snk-detail-view --> snk-actions-button
|
135
|
+
snk-detail-view --> taskbar-split-button
|
142
136
|
snk-detail-view --> taskbar-actions-button
|
143
137
|
snk-grid --> snk-filter-bar
|
144
138
|
snk-grid --> snk-taskbar
|
145
139
|
snk-grid --> snk-grid-config
|
146
140
|
snk-grid --> snk-data-exporter
|
147
141
|
snk-grid --> snk-actions-button
|
142
|
+
snk-grid --> taskbar-split-button
|
148
143
|
snk-grid --> taskbar-actions-button
|
149
144
|
snk-filter-bar --> snk-filter-item
|
150
145
|
snk-filter-bar --> snk-personalized-filter
|
@@ -160,6 +155,7 @@ graph TD;
|
|
160
155
|
snk-expression-item --> snk-filter-param-config
|
161
156
|
snk-taskbar --> snk-data-exporter
|
162
157
|
snk-taskbar --> snk-actions-button
|
158
|
+
snk-taskbar --> taskbar-split-button
|
163
159
|
snk-taskbar --> taskbar-actions-button
|
164
160
|
snk-data-exporter --> snk-exporter-email-sender
|
165
161
|
snk-grid-config --> snk-select-box
|
@@ -172,12 +168,18 @@ graph TD;
|
|
172
168
|
snk-simple-crud --> snk-grid-config
|
173
169
|
snk-simple-crud --> snk-data-exporter
|
174
170
|
snk-simple-crud --> snk-actions-button
|
171
|
+
snk-simple-crud --> taskbar-split-button
|
175
172
|
snk-simple-crud --> taskbar-actions-button
|
176
173
|
snk-configurator --> snk-layout-form-config
|
177
174
|
snk-layout-form-config --> snk-view-representation
|
178
|
-
snk-form-config -->
|
179
|
-
snk-form-config -->
|
180
|
-
snk-form-config -->
|
175
|
+
snk-form-config --> config-header
|
176
|
+
snk-form-config --> guides-configurator
|
177
|
+
snk-form-config --> fields-layout
|
178
|
+
snk-form-config --> fields-selector
|
179
|
+
config-header --> configs-button
|
180
|
+
fields-layout --> field-item
|
181
|
+
field-item --> field-config
|
182
|
+
fields-selector --> field-item
|
181
183
|
snk-crud --> snk-guides-viewer
|
182
184
|
style snk-guides-viewer fill:#f9f,stroke:#333,stroke-width:4px
|
183
185
|
```
|
@@ -7,23 +7,24 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description | Type
|
11
|
-
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------- |
|
12
|
-
| `branchGuide` | -- | | `IGuideItem`
|
13
|
-
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean`
|
14
|
-
| `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor`
|
15
|
-
| `customRenders` | -- | Render customizados da grade. | `PropsCustomRender`
|
16
|
-
| `dataState` | -- | Representa o estado do dataUnit detail. | `DataState`
|
17
|
-
| `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit`
|
18
|
-
| `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string`
|
19
|
-
| `entityName` | `entity-name` | Nome da entidade detail. | `string`
|
20
|
-
| `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager`
|
21
|
-
| `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]`
|
22
|
-
| `label` | `label` | Descrição amigável do cadastro detalhe. | `string`
|
23
|
-
| `messagesBuilder` | -- | | `SnkMessageBuilder`
|
24
|
-
| `
|
25
|
-
| `
|
26
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------- |
|
12
|
+
| `branchGuide` | -- | | `IGuideItem` | `undefined` |
|
13
|
+
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
14
|
+
| `customEditors` | -- | Registra um editor customizado para campos da grade e formulário. | `PropsCustomEditor` | `undefined` |
|
15
|
+
| `customRenders` | -- | Render customizados da grade. | `PropsCustomRender` | `undefined` |
|
16
|
+
| `dataState` | -- | Representa o estado do dataUnit detail. | `DataState` | `undefined` |
|
17
|
+
| `dataUnit` | -- | Instância do DataUnit detail. | `DataUnit` | `undefined` |
|
18
|
+
| `dataUnitName` | `data-unit-name` | Determina todo o caminho desde o pai até chegar neste nível | `string` | `undefined` |
|
19
|
+
| `entityName` | `entity-name` | Nome da entidade detail. | `string` | `undefined` |
|
20
|
+
| `formConfigManager` | -- | Gerenciador de configuração do formulário. | `SnkFormConfigManager` | `undefined` |
|
21
|
+
| `guideItemPath` | -- | Caminho do identificador da guia vinculada. | `IGuideItem[]` | `undefined` |
|
22
|
+
| `label` | `label` | Descrição amigável do cadastro detalhe. | `string` | `undefined` |
|
23
|
+
| `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
|
24
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.SECONDARY` |
|
25
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
26
|
+
| `selectedForm` | `selected-form` | Representa o formulário selecionado. | `string` | `undefined` |
|
27
|
+
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
|
27
28
|
|
28
29
|
|
29
30
|
## Events
|
@@ -103,6 +104,7 @@ Type: `Promise<void>`
|
|
103
104
|
- [snk-attach](../../../snk-attach)
|
104
105
|
- [snk-data-exporter](../../../snk-data-exporter)
|
105
106
|
- [snk-actions-button](../../../snk-actions-button)
|
107
|
+
- [taskbar-split-button](../../../snk-taskbar/elements/taskbar-split-button)
|
106
108
|
- [taskbar-actions-button](../../../snk-taskbar/elements/taskbar-actions-button)
|
107
109
|
|
108
110
|
### Graph
|
@@ -115,12 +117,14 @@ graph TD;
|
|
115
117
|
snk-detail-view --> snk-attach
|
116
118
|
snk-detail-view --> snk-data-exporter
|
117
119
|
snk-detail-view --> snk-actions-button
|
120
|
+
snk-detail-view --> taskbar-split-button
|
118
121
|
snk-detail-view --> taskbar-actions-button
|
119
122
|
snk-grid --> snk-filter-bar
|
120
123
|
snk-grid --> snk-taskbar
|
121
124
|
snk-grid --> snk-grid-config
|
122
125
|
snk-grid --> snk-data-exporter
|
123
126
|
snk-grid --> snk-actions-button
|
127
|
+
snk-grid --> taskbar-split-button
|
124
128
|
snk-grid --> taskbar-actions-button
|
125
129
|
snk-filter-bar --> snk-filter-item
|
126
130
|
snk-filter-bar --> snk-personalized-filter
|
@@ -136,6 +140,7 @@ graph TD;
|
|
136
140
|
snk-expression-item --> snk-filter-param-config
|
137
141
|
snk-taskbar --> snk-data-exporter
|
138
142
|
snk-taskbar --> snk-actions-button
|
143
|
+
snk-taskbar --> taskbar-split-button
|
139
144
|
snk-taskbar --> taskbar-actions-button
|
140
145
|
snk-data-exporter --> snk-exporter-email-sender
|
141
146
|
snk-grid-config --> snk-select-box
|
@@ -149,6 +154,7 @@ graph TD;
|
|
149
154
|
snk-simple-crud --> snk-grid-config
|
150
155
|
snk-simple-crud --> snk-data-exporter
|
151
156
|
snk-simple-crud --> snk-actions-button
|
157
|
+
snk-simple-crud --> taskbar-split-button
|
152
158
|
snk-simple-crud --> taskbar-actions-button
|
153
159
|
snk-configurator --> snk-layout-form-config
|
154
160
|
snk-layout-form-config --> snk-view-representation
|
@@ -12,6 +12,7 @@
|
|
12
12
|
| `config` | -- | Configurações para carregar os dados do componente | `SnkFilterItemConfig` | `undefined` |
|
13
13
|
| `maxHeightList` | `max-height-list` | Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida | `string` | `""` |
|
14
14
|
| `rightListSlotBuilder` | -- | Método que possibilita alterar como o item da lista vai ser apresentado. Observação: No React ele se transforma em VNode e não HTMLElement. | `(item: ListItem, group?: ListGroup) => string \| HTMLElement` | `undefined` |
|
15
|
+
| `value` | -- | Define o valor do componente | `IOption` | `undefined` |
|
15
16
|
|
16
17
|
|
17
18
|
## Events
|
@@ -7,18 +7,19 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description | Type
|
11
|
-
| --------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
12
|
-
| `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `() => void`
|
13
|
-
| `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void`
|
14
|
-
| `closeModal` | -- | Ação disparada ao fechar o modal | `() => void`
|
15
|
-
| `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string`
|
16
|
-
| `deletePersonalizedFilter` | -- | Ação executada ao deletar um filtro personalizado | `(filter: IPersonalizedFilter, configName: string) => void` | `undefined` |
|
17
|
-
| `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean`
|
18
|
-
| `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string) => void` | `undefined` |
|
19
|
-
| `
|
20
|
-
| `
|
21
|
-
| `
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| --------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | ----------- |
|
12
|
+
| `addPersonalizedFilter` | -- | Ação executada ao adicionar um filtro personalizado | `(isDefault?: boolean) => void` | `undefined` |
|
13
|
+
| `applyFilters` | -- | Ação executada ao aplicar os filtros | `(updatedFilterConfig: SnkFilterItemConfig[]) => void` | `undefined` |
|
14
|
+
| `closeModal` | -- | Ação disparada ao fechar o modal | `() => void` | `undefined` |
|
15
|
+
| `configName` | `config-name` | Nome da configuração. Serve para distinguir várias instâncias do componente. | `string` | `undefined` |
|
16
|
+
| `deletePersonalizedFilter` | -- | Ação executada ao deletar um filtro personalizado | `(filter: IPersonalizedFilter, configName: string, isDefault?: boolean) => void` | `undefined` |
|
17
|
+
| `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
|
18
|
+
| `editPersonalizedFilter` | -- | Ação executada ao editar um filtro personalizado | `(id: string, isDefault?: boolean) => void` | `undefined` |
|
19
|
+
| `filterDefaultToDelete` | -- | Guarda o filtro a ser deletado no Apply do modal | `SnkFilterItemConfig` | `undefined` |
|
20
|
+
| `filters` | -- | Filtros a serem apresentados | `SnkFilterItemConfig[]` | `undefined` |
|
21
|
+
| `filtersToDelete` | -- | Guarda filtros a serem deletados no Apply do modal | `IPersonalizedFilter[]` | `[]` |
|
22
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
22
23
|
|
23
24
|
|
24
25
|
## Dependencies
|
@@ -26,11 +27,13 @@
|
|
26
27
|
### Depends on
|
27
28
|
|
28
29
|
- [snk-filter-modal-item](subcomponents)
|
30
|
+
- [snk-default-filter](./subcomponents/snk-default-filter)
|
29
31
|
|
30
32
|
### Graph
|
31
33
|
```mermaid
|
32
34
|
graph TD;
|
33
35
|
snk-filter-modal --> snk-filter-modal-item
|
36
|
+
snk-filter-modal --> snk-default-filter
|
34
37
|
style snk-filter-modal fill:#f9f,stroke:#333,stroke-width:4px
|
35
38
|
```
|
36
39
|
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# snk-default-filter
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
<!-- Auto Generated Below -->
|
6
|
+
|
7
|
+
|
8
|
+
## Properties
|
9
|
+
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ------------------ | -------------------- | --------------------------------------------------------------------------------- | -------------------------------------- | ----------- |
|
12
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
13
|
+
| `hasDefaultFilter` | `has-default-filter` | Informa se já existe um filtro padrão criado. | `boolean` | `false` |
|
14
|
+
|
15
|
+
|
16
|
+
## Events
|
17
|
+
|
18
|
+
| Event | Description | Type |
|
19
|
+
| ---------------- | ----------- | --------------------------------------------------------------------------------------------------- |
|
20
|
+
| `actionSelected` | | `CustomEvent<ActionDefaultFilter.CREATE \| ActionDefaultFilter.EDIT \| ActionDefaultFilter.REMOVE>` |
|
21
|
+
|
22
|
+
|
23
|
+
## Dependencies
|
24
|
+
|
25
|
+
### Used by
|
26
|
+
|
27
|
+
- [snk-filter-modal](../..)
|
28
|
+
|
29
|
+
### Graph
|
30
|
+
```mermaid
|
31
|
+
graph TD;
|
32
|
+
snk-filter-modal --> snk-default-filter
|
33
|
+
style snk-default-filter fill:#f9f,stroke:#333,stroke-width:4px
|
34
|
+
```
|
35
|
+
|
36
|
+
----------------------------------------------
|
37
|
+
|
38
|
+
|
@@ -78,9 +78,14 @@ Type: `Promise<void>`
|
|
78
78
|
```mermaid
|
79
79
|
graph TD;
|
80
80
|
snk-form --> snk-form-config
|
81
|
-
snk-form-config -->
|
82
|
-
snk-form-config -->
|
83
|
-
snk-form-config -->
|
81
|
+
snk-form-config --> config-header
|
82
|
+
snk-form-config --> guides-configurator
|
83
|
+
snk-form-config --> fields-layout
|
84
|
+
snk-form-config --> fields-selector
|
85
|
+
config-header --> configs-button
|
86
|
+
fields-layout --> field-item
|
87
|
+
field-item --> field-config
|
88
|
+
fields-selector --> field-item
|
84
89
|
style snk-form fill:#f9f,stroke:#333,stroke-width:4px
|
85
90
|
```
|
86
91
|
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# 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
|
+
- [config-header](..)
|
30
|
+
|
31
|
+
### Graph
|
32
|
+
```mermaid
|
33
|
+
graph TD;
|
34
|
+
config-header --> configs-button
|
35
|
+
style configs-button fill:#f9f,stroke:#333,stroke-width:4px
|
36
|
+
```
|
37
|
+
|
38
|
+
----------------------------------------------
|
39
|
+
|
40
|
+
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# 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-form-config](..)
|
32
|
+
|
33
|
+
### Depends on
|
34
|
+
|
35
|
+
- [configs-button](configs-button)
|
36
|
+
|
37
|
+
### Graph
|
38
|
+
```mermaid
|
39
|
+
graph TD;
|
40
|
+
config-header --> configs-button
|
41
|
+
snk-form-config --> config-header
|
42
|
+
style config-header fill:#f9f,stroke:#333,stroke-width:4px
|
43
|
+
```
|
44
|
+
|
45
|
+
----------------------------------------------
|
46
|
+
|
47
|
+
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# 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
|
+
- [field-item](..)
|
43
|
+
|
44
|
+
### Graph
|
45
|
+
```mermaid
|
46
|
+
graph TD;
|
47
|
+
field-item --> field-config
|
48
|
+
style field-config fill:#f9f,stroke:#333,stroke-width:4px
|
49
|
+
```
|
50
|
+
|
51
|
+
----------------------------------------------
|
52
|
+
|
53
|
+
|