@sankhyalabs/sankhyablocks-docs 2.4.0 → 2.4.1
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 +43 -41
- package/components/snk-configurator/readme.md +10 -10
- package/components/snk-crud/readme.md +6 -6
- package/components/snk-data-unit/readme.md +14 -14
- package/components/snk-filter-bar/filter-item/editors/readme.md +4 -4
- package/components/snk-filter-bar/filter-item/readme.md +10 -10
- package/components/snk-filter-bar/filter-list/readme.md +13 -13
- package/components/snk-filter-bar/filter-modal/readme.md +11 -11
- package/components/snk-filter-bar/readme.md +1 -1
- package/components/snk-form/readme.md +9 -9
- package/components/snk-form/subcomponents/snk-config-options/readme.md +8 -8
- package/components/snk-form/subcomponents/snk-field-config/readme.md +9 -9
- package/components/snk-form/subcomponents/snk-form-config/readme.md +9 -9
- package/components/snk-form/subcomponents/snk-tab-config/readme.md +13 -13
- package/components/snk-grid/readme.md +11 -11
- package/components/snk-grid/subcomponents/snk-grid-config/readme.md +5 -5
- package/components/snk-grid/subcomponents/snk-select-box/readme.md +6 -6
- package/components/snk-pesquisa/readme.md +5 -5
- package/components/snk-taskbar/readme.md +10 -10
- package/package.json +1 -1
|
@@ -7,25 +7,25 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| ----------------- | ------------- |
|
|
12
|
-
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção.
|
|
13
|
-
| `messagesBuilder` | -- |
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | ------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
|
|
12
|
+
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
13
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
## Events
|
|
17
17
|
|
|
18
|
-
| Event | Description
|
|
19
|
-
| -------------------- |
|
|
20
|
-
| `applicationLoaded` |
|
|
21
|
-
| `applicationLoading` |
|
|
18
|
+
| Event | Description | Type |
|
|
19
|
+
| -------------------- | ----------------------------------------- | ---------------------- |
|
|
20
|
+
| `applicationLoaded` | Emitido quando a aplicação for carregada. | `CustomEvent<boolean>` |
|
|
21
|
+
| `applicationLoading` | Emitido ao iniciar a carga do componente. | `CustomEvent<boolean>` |
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
## Methods
|
|
25
25
|
|
|
26
26
|
### `alert(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Exibe o diálogo de alerta de acordo com os parâmetros passados.
|
|
29
29
|
|
|
30
30
|
#### Returns
|
|
31
31
|
|
|
@@ -35,7 +35,7 @@ Type: `Promise<boolean>`
|
|
|
35
35
|
|
|
36
36
|
### `closeModal() => Promise<void>`
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
Fecha o Modal e limpa o conteúdo.
|
|
39
39
|
|
|
40
40
|
#### Returns
|
|
41
41
|
|
|
@@ -45,7 +45,7 @@ Type: `Promise<void>`
|
|
|
45
45
|
|
|
46
46
|
### `closePopUp() => Promise<void>`
|
|
47
47
|
|
|
48
|
-
Fecha o
|
|
48
|
+
Fecha o Popup e limpa o conteúdo.
|
|
49
49
|
|
|
50
50
|
#### Returns
|
|
51
51
|
|
|
@@ -66,7 +66,7 @@ Type: `Promise<boolean>`
|
|
|
66
66
|
### `createDataunit(entityName: string, dataUnitName?: string) => Promise<DataUnit>`
|
|
67
67
|
|
|
68
68
|
Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
|
|
69
|
-
passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado
|
|
69
|
+
passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
|
|
70
70
|
|
|
71
71
|
#### Returns
|
|
72
72
|
|
|
@@ -76,7 +76,7 @@ Type: `Promise<DataUnit>`
|
|
|
76
76
|
|
|
77
77
|
### `error(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
Exibe o diálogo de erro de acordo com os parâmetros passados.
|
|
80
80
|
|
|
81
81
|
#### Returns
|
|
82
82
|
|
|
@@ -86,7 +86,8 @@ Type: `Promise<boolean>`
|
|
|
86
86
|
|
|
87
87
|
### `executePreparedSearch(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
Obtém as opções em componentes de pesquisa
|
|
90
|
+
Ex.: snk-config-options
|
|
90
91
|
|
|
91
92
|
#### Returns
|
|
92
93
|
|
|
@@ -96,7 +97,8 @@ Type: `Promise<IOption | IOption[]>`
|
|
|
96
97
|
|
|
97
98
|
### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit) => Promise<Array<IOption> | IOption>`
|
|
98
99
|
|
|
99
|
-
|
|
100
|
+
Obtém as opções em componentes de pesquisa
|
|
101
|
+
Ex.: snk-config-options
|
|
100
102
|
|
|
101
103
|
#### Returns
|
|
102
104
|
|
|
@@ -106,7 +108,7 @@ Type: `Promise<IOption | IOption[]>`
|
|
|
106
108
|
|
|
107
109
|
### `fetchDefaultConfig(name: string) => Promise<IFormConfig>`
|
|
108
110
|
|
|
109
|
-
|
|
111
|
+
Obtém a configuração padrão de formulário.
|
|
110
112
|
|
|
111
113
|
#### Returns
|
|
112
114
|
|
|
@@ -116,7 +118,7 @@ Type: `Promise<IFormConfig>`
|
|
|
116
118
|
|
|
117
119
|
### `fetchLegacyConfig(name: string) => Promise<IFormConfig>`
|
|
118
120
|
|
|
119
|
-
|
|
121
|
+
Obtém a configuração de formulário do usuário.
|
|
120
122
|
|
|
121
123
|
#### Returns
|
|
122
124
|
|
|
@@ -126,7 +128,7 @@ Type: `Promise<IFormConfig>`
|
|
|
126
128
|
|
|
127
129
|
### `fetchUserAvailableConfigs(name: string) => Promise<Array<IUserConfig>>`
|
|
128
130
|
|
|
129
|
-
|
|
131
|
+
Obtém a lista de configurações de formulário do usuário.
|
|
130
132
|
|
|
131
133
|
#### Returns
|
|
132
134
|
|
|
@@ -136,7 +138,7 @@ Type: `Promise<IUserConfig[]>`
|
|
|
136
138
|
|
|
137
139
|
### `getAllAccess() => Promise<any>`
|
|
138
140
|
|
|
139
|
-
|
|
141
|
+
Obtém todos os acessos do usuário logado.
|
|
140
142
|
|
|
141
143
|
#### Returns
|
|
142
144
|
|
|
@@ -146,7 +148,7 @@ Type: `Promise<any>`
|
|
|
146
148
|
|
|
147
149
|
### `getAttributeFromHTMLWrapper(attribName: string) => Promise<string>`
|
|
148
150
|
|
|
149
|
-
Acessa informações de contexto "empurrados" na abertura da tela
|
|
151
|
+
Acessa informações de contexto "empurrados" na abertura da tela.
|
|
150
152
|
|
|
151
153
|
#### Returns
|
|
152
154
|
|
|
@@ -156,7 +158,7 @@ Type: `Promise<string>`
|
|
|
156
158
|
|
|
157
159
|
### `getBooleanParam(name: string) => Promise<boolean>`
|
|
158
160
|
|
|
159
|
-
|
|
161
|
+
Obtém o valor de um parâmetro do tipo booleano.
|
|
160
162
|
|
|
161
163
|
#### Returns
|
|
162
164
|
|
|
@@ -166,7 +168,7 @@ Type: `Promise<boolean>`
|
|
|
166
168
|
|
|
167
169
|
### `getConfig(key: string) => Promise<any>`
|
|
168
170
|
|
|
169
|
-
|
|
171
|
+
Obtém a configuração de um recurso por service broker
|
|
170
172
|
|
|
171
173
|
#### Returns
|
|
172
174
|
|
|
@@ -186,7 +188,7 @@ Type: `Promise<DataUnit>`
|
|
|
186
188
|
|
|
187
189
|
### `getDateParam(name: string) => Promise<Date>`
|
|
188
190
|
|
|
189
|
-
|
|
191
|
+
Obtém o valor de um parâmetro do tipo data.
|
|
190
192
|
|
|
191
193
|
#### Returns
|
|
192
194
|
|
|
@@ -196,7 +198,7 @@ Type: `Promise<Date>`
|
|
|
196
198
|
|
|
197
199
|
### `getDefaultValue(expression: string) => Promise<any>`
|
|
198
200
|
|
|
199
|
-
|
|
201
|
+
Obtém um valor padrão específico de uma expressão.
|
|
200
202
|
|
|
201
203
|
#### Returns
|
|
202
204
|
|
|
@@ -206,7 +208,7 @@ Type: `Promise<any>`
|
|
|
206
208
|
|
|
207
209
|
### `getDefaultValues() => Promise<string>`
|
|
208
210
|
|
|
209
|
-
|
|
211
|
+
Obtém um objeto com um conjunto de valores padrão.
|
|
210
212
|
|
|
211
213
|
#### Returns
|
|
212
214
|
|
|
@@ -226,7 +228,7 @@ Type: `Promise<SnkFilterItemConfig[]>`
|
|
|
226
228
|
|
|
227
229
|
### `getFloatParam(name: string) => Promise<number>`
|
|
228
230
|
|
|
229
|
-
|
|
231
|
+
Obtém o valor de um parâmetro do tipo Decimal.
|
|
230
232
|
|
|
231
233
|
#### Returns
|
|
232
234
|
|
|
@@ -236,7 +238,7 @@ Type: `Promise<number>`
|
|
|
236
238
|
|
|
237
239
|
### `getIntParam(name: string) => Promise<number>`
|
|
238
240
|
|
|
239
|
-
|
|
241
|
+
Obtém o valor de um parâmetro do tipo Inteiro.
|
|
240
242
|
|
|
241
243
|
#### Returns
|
|
242
244
|
|
|
@@ -246,7 +248,7 @@ Type: `Promise<number>`
|
|
|
246
248
|
|
|
247
249
|
### `getResourceID() => Promise<string>`
|
|
248
250
|
|
|
249
|
-
|
|
251
|
+
Obtém o resourceID da tela em questão.
|
|
250
252
|
|
|
251
253
|
#### Returns
|
|
252
254
|
|
|
@@ -256,7 +258,7 @@ Type: `Promise<string>`
|
|
|
256
258
|
|
|
257
259
|
### `getStringParam(name: string) => Promise<string>`
|
|
258
260
|
|
|
259
|
-
|
|
261
|
+
Obtém o valor de um parâmetro do tipo string.
|
|
260
262
|
|
|
261
263
|
#### Returns
|
|
262
264
|
|
|
@@ -266,7 +268,7 @@ Type: `Promise<string>`
|
|
|
266
268
|
|
|
267
269
|
### `getUserID() => Promise<string>`
|
|
268
270
|
|
|
269
|
-
|
|
271
|
+
Obtém o UserId da tela em questão.
|
|
270
272
|
|
|
271
273
|
#### Returns
|
|
272
274
|
|
|
@@ -276,7 +278,7 @@ Type: `Promise<string>`
|
|
|
276
278
|
|
|
277
279
|
### `hasAccess(access: AutorizationType) => Promise<boolean>`
|
|
278
280
|
|
|
279
|
-
|
|
281
|
+
Obtém `true` caso o usuário logado tem permissão pra determinada ação.
|
|
280
282
|
|
|
281
283
|
#### Returns
|
|
282
284
|
|
|
@@ -286,7 +288,7 @@ Type: `Promise<boolean>`
|
|
|
286
288
|
|
|
287
289
|
### `info(message: string, options?: MessageOptions) => Promise<void>`
|
|
288
290
|
|
|
289
|
-
|
|
291
|
+
Exibe uma informação efêmera (de segundo plano).
|
|
290
292
|
|
|
291
293
|
#### Returns
|
|
292
294
|
|
|
@@ -296,7 +298,7 @@ Type: `Promise<void>`
|
|
|
296
298
|
|
|
297
299
|
### `isDebugMode() => Promise<boolean>`
|
|
298
300
|
|
|
299
|
-
|
|
301
|
+
Obtém `true` caso a tela esteja em modo de debug.
|
|
300
302
|
|
|
301
303
|
#### Returns
|
|
302
304
|
|
|
@@ -306,7 +308,7 @@ Type: `Promise<boolean>`
|
|
|
306
308
|
|
|
307
309
|
### `isUserSup() => Promise<boolean>`
|
|
308
310
|
|
|
309
|
-
|
|
311
|
+
Obtém `true` caso o usuário logado seja o SUP.
|
|
310
312
|
|
|
311
313
|
#### Returns
|
|
312
314
|
|
|
@@ -316,7 +318,7 @@ Type: `Promise<boolean>`
|
|
|
316
318
|
|
|
317
319
|
### `loadFormConfig(name: string) => Promise<IFormConfig>`
|
|
318
320
|
|
|
319
|
-
|
|
321
|
+
Obtém a configuração de formulário.
|
|
320
322
|
|
|
321
323
|
#### Returns
|
|
322
324
|
|
|
@@ -326,7 +328,7 @@ Type: `Promise<IFormConfig>`
|
|
|
326
328
|
|
|
327
329
|
### `loadGridConfig(name: string) => Promise<IGridConfig>`
|
|
328
330
|
|
|
329
|
-
|
|
331
|
+
Obtém a configuração de grade.
|
|
330
332
|
|
|
331
333
|
#### Returns
|
|
332
334
|
|
|
@@ -336,7 +338,7 @@ Type: `Promise<IGridConfig>`
|
|
|
336
338
|
|
|
337
339
|
### `loadTotals(name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>`
|
|
338
340
|
|
|
339
|
-
|
|
341
|
+
Obtém os totalizadores da grade.
|
|
340
342
|
|
|
341
343
|
#### Returns
|
|
342
344
|
|
|
@@ -356,7 +358,7 @@ Type: `Promise<boolean>`
|
|
|
356
358
|
|
|
357
359
|
### `openApp(resourceId: string, pkObject: Object) => Promise<void>`
|
|
358
360
|
|
|
359
|
-
Abre determinada tela, repassando pkObject
|
|
361
|
+
Abre determinada tela, repassando pkObject.
|
|
360
362
|
|
|
361
363
|
#### Returns
|
|
362
364
|
|
|
@@ -406,7 +408,7 @@ Type: `Promise<boolean>`
|
|
|
406
408
|
|
|
407
409
|
### `showModal(content: HTMLElement) => Promise<void>`
|
|
408
410
|
|
|
409
|
-
|
|
411
|
+
Exibe o conteúdo passado em um Modal.
|
|
410
412
|
|
|
411
413
|
#### Returns
|
|
412
414
|
|
|
@@ -416,7 +418,7 @@ Type: `Promise<void>`
|
|
|
416
418
|
|
|
417
419
|
### `showPopUp(content: HTMLElement, size?: string, useHeader?: boolean) => Promise<void>`
|
|
418
420
|
|
|
419
|
-
|
|
421
|
+
Exibe o conteúdo passado em um Popup.
|
|
420
422
|
|
|
421
423
|
#### Returns
|
|
422
424
|
|
|
@@ -426,7 +428,7 @@ Type: `Promise<void>`
|
|
|
426
428
|
|
|
427
429
|
### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
|
428
430
|
|
|
429
|
-
|
|
431
|
+
Exibe o diálogo de sucesso de acordo com os parâmetros passados.
|
|
430
432
|
|
|
431
433
|
#### Returns
|
|
432
434
|
|
|
@@ -7,25 +7,25 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| ------------ | ------------- |
|
|
12
|
-
| `configName` | `config-name` |
|
|
13
|
-
| `viewMode` | `view-mode` | Define qual modo de visualização está ativo.
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------ | ------------- | --------------------------------------------------------------- | -------- | ---------------- |
|
|
12
|
+
| `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
|
|
13
|
+
| `viewMode` | `view-mode` | Define qual modo de visualização está ativo. | `string` | `GRID_MODE.name` |
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
## Events
|
|
17
17
|
|
|
18
|
-
| Event | Description
|
|
19
|
-
| ---------------- |
|
|
20
|
-
| `configSelected` |
|
|
21
|
-
| `openConfig` |
|
|
18
|
+
| Event | Description | Type |
|
|
19
|
+
| ---------------- | ------------------------------------------------ | --------------------- |
|
|
20
|
+
| `configSelected` | Emitido quando seleciona o modo de visualização. | `CustomEvent<string>` |
|
|
21
|
+
| `openConfig` | Emitido quando clica para abrir a configuração. | `CustomEvent<string>` |
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
## Methods
|
|
25
25
|
|
|
26
26
|
### `close() => Promise<void>`
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Fecha a janela de configuração.
|
|
29
29
|
|
|
30
30
|
#### Returns
|
|
31
31
|
|
|
@@ -35,7 +35,7 @@ Type: `Promise<void>`
|
|
|
35
35
|
|
|
36
36
|
### `open() => Promise<void>`
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
Exibe a janela de configuração.
|
|
39
39
|
|
|
40
40
|
#### Returns
|
|
41
41
|
|
|
@@ -9,19 +9,19 @@
|
|
|
9
9
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
|
|
12
|
-
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções".
|
|
12
|
+
| `actionsList` | -- | Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
|
13
13
|
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
14
|
-
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade
|
|
15
|
-
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro
|
|
14
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `true` |
|
|
15
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
16
16
|
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } | `IStatusResolver` | `undefined` |
|
|
17
17
|
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
## Events
|
|
21
21
|
|
|
22
|
-
| Event | Description
|
|
23
|
-
| ------------- |
|
|
24
|
-
| `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação | `CustomEvent<string>` |
|
|
22
|
+
| Event | Description | Type |
|
|
23
|
+
| ------------- | -------------------------------------------------------------- | --------------------- |
|
|
24
|
+
| `actionClick` | Emitido pela taskbar sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
## Methods
|
|
@@ -9,36 +9,36 @@
|
|
|
9
9
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| -------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------- |
|
|
12
|
-
| `afterSave` | -- | Executado após a ação de salvar
|
|
12
|
+
| `afterSave` | -- | Executado após a ação de salvar. | `(dataUnit: DataUnit) => void` | `undefined` |
|
|
13
13
|
| `beforeSave` | -- | Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação. | `(dataUnit: DataUnit) => boolean \| Promise<boolean>` | `undefined` |
|
|
14
|
-
| `dataState` | -- |
|
|
15
|
-
| `dataUnit` | -- | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade
|
|
16
|
-
| `dataUnitName` | `data-unit-name` |
|
|
17
|
-
| `entityName` | `entity-name` | Determina qual a entidade representa os dados em questão.
|
|
18
|
-
| `pageSize` | `page-size` | Determina quantas linhas são retornadas por página
|
|
14
|
+
| `dataState` | -- | Controla o estado atual dos dados. | `DataState` | `undefined` |
|
|
15
|
+
| `dataUnit` | -- | Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. | `DataUnit` | `undefined` |
|
|
16
|
+
| `dataUnitName` | `data-unit-name` | Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. | `string` | `undefined` |
|
|
17
|
+
| `entityName` | `entity-name` | Determina qual a entidade que representa os dados em questão. | `string` | `undefined` |
|
|
18
|
+
| `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
## Events
|
|
22
22
|
|
|
23
|
-
| Event | Description
|
|
24
|
-
| ----------------- |
|
|
25
|
-
| `cancelEdition` |
|
|
26
|
-
| `dataStateChange` |
|
|
27
|
-
| `dataUnitReady` |
|
|
28
|
-
| `insertionMode` |
|
|
23
|
+
| Event | Description | Type |
|
|
24
|
+
| ----------------- | --------------------------------------------------------- | ------------------------ |
|
|
25
|
+
| `cancelEdition` | Emitido quando se cancela uma inserção ou cópia. | `CustomEvent<void>` |
|
|
26
|
+
| `dataStateChange` | Emitido quando há qualquer mudança de estado no DataUnit. | `CustomEvent<DataState>` |
|
|
27
|
+
| `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
|
|
28
|
+
| `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
## Methods
|
|
32
32
|
|
|
33
33
|
### `getDataUnit() => Promise<DataUnit>`
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
Obtém o dataUnit.
|
|
36
36
|
|
|
37
37
|
#### Returns
|
|
38
38
|
|
|
39
39
|
Type: `Promise<DataUnit>`
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
|
|
42
42
|
|
|
43
43
|
|
|
44
44
|
----------------------------------------------
|
|
@@ -7,10 +7,10 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| -------- | --------- |
|
|
12
|
-
| `config` | -- |
|
|
13
|
-
| `value` | `value` |
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------- | --------- | ------------------------------------------------------ | --------------------- | ----------- |
|
|
12
|
+
| `config` | -- | Define as configurações do componente snk-filter-text. | `SnkFilterItemConfig` | `undefined` |
|
|
13
|
+
| `value` | `value` | Define o valor do componente snk-filter-text. | `string` | `undefined` |
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
----------------------------------------------
|
|
@@ -7,25 +7,25 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| ------------ | --------- |
|
|
12
|
-
| `config` | -- |
|
|
13
|
-
| `getMessage` | -- |
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------ | --------- | --------------------------------------------------------------------------------- | -------------------------------------- | ----------- |
|
|
12
|
+
| `config` | -- | Define as configurações do componente snk-filter-item. | `SnkFilterItemConfig` | `undefined` |
|
|
13
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
## Events
|
|
17
17
|
|
|
18
|
-
| Event | Description
|
|
19
|
-
| ---------------- |
|
|
20
|
-
| `filterChange` |
|
|
21
|
-
| `visibleChanged` |
|
|
18
|
+
| Event | Description | Type |
|
|
19
|
+
| ---------------- | ----------------------------------------------------------------- | ---------------------------------- |
|
|
20
|
+
| `filterChange` | Emitido quando há uma alteração nos filtros. | `CustomEvent<SnkFilterItemConfig>` |
|
|
21
|
+
| `visibleChanged` | Emitido quando o detalhe de um item da lista é aberto ou fechado. | `CustomEvent<boolean>` |
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
## Methods
|
|
25
25
|
|
|
26
26
|
### `hideDetail() => Promise<void>`
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Oculta os detalhes de um item da lista.
|
|
29
29
|
|
|
30
30
|
#### Returns
|
|
31
31
|
|
|
@@ -35,7 +35,7 @@ Type: `Promise<void>`
|
|
|
35
35
|
|
|
36
36
|
### `showUp(open?: boolean) => Promise<void>`
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
Exibe os detalhes de um item da lista.
|
|
39
39
|
|
|
40
40
|
#### Returns
|
|
41
41
|
|
|
@@ -7,29 +7,29 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| ---------------- | ------------------ |
|
|
12
|
-
| `buttonClass` | `button-class` |
|
|
13
|
-
| `emptyText` | `empty-text` |
|
|
14
|
-
| `findFilterText` | `find-filter-text` |
|
|
15
|
-
| `getMessage` | -- |
|
|
16
|
-
| `iconName` | `icon-name` |
|
|
17
|
-
| `items` | -- |
|
|
18
|
-
| `label` | `label` |
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ---------------- | ------------------ | ------------------------------------------------------------------------------------------------------ | -------------------------------------- | ----------- |
|
|
12
|
+
| `buttonClass` | `button-class` | Define a classe CSS a ser adicionada no botão (usado principalmente para sinalizar o filtro aplicado). | `string` | `undefined` |
|
|
13
|
+
| `emptyText` | `empty-text` | Define o texto exibido quando a lista está vazia. | `string` | `undefined` |
|
|
14
|
+
| `findFilterText` | `find-filter-text` | Define o texto exibido no componente de busca. | `string` | `undefined` |
|
|
15
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
16
|
+
| `iconName` | `icon-name` | Define o ícone usado no ez-button do filtro. | `string` | `undefined` |
|
|
17
|
+
| `items` | -- | Guarda a lista de filtros. | `ListItem[]` | `undefined` |
|
|
18
|
+
| `label` | `label` | Define o label usado no ez-button do filtro. | `string` | `undefined` |
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
## Events
|
|
22
22
|
|
|
23
|
-
| Event | Description
|
|
24
|
-
| ----------------- |
|
|
25
|
-
| `snkItemSelected` |
|
|
23
|
+
| Event | Description | Type |
|
|
24
|
+
| ----------------- | -------------------------------------------- | --------------------- |
|
|
25
|
+
| `snkItemSelected` | Disparado quando um item da lista é clicado. | `CustomEvent<string>` |
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
## Methods
|
|
29
29
|
|
|
30
30
|
### `hideDetail() => Promise<void>`
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
Oculta os detalhes do componente snk-filter-list.
|
|
33
33
|
|
|
34
34
|
#### Returns
|
|
35
35
|
|
|
@@ -7,17 +7,17 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| -------------------- | --------------------- |
|
|
12
|
-
| `cancelButtonLabel` | `cancel-button-label` |
|
|
13
|
-
| `getMessage` | -- |
|
|
14
|
-
| `infoText` | `info-text` |
|
|
15
|
-
| `items` | -- |
|
|
16
|
-
| `modalSubTitle` | `modal-sub-title` |
|
|
17
|
-
| `modalTitle` | `modal-title` |
|
|
18
|
-
| `okButtonLabel` | `ok-button-label` |
|
|
19
|
-
| `processModalAction` | -- |
|
|
20
|
-
| `useSearch` | `use-search` |
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------------- | --------------------- | --------------------------------------------------------------------------------- | -------------------------------------- | ----------- |
|
|
12
|
+
| `cancelButtonLabel` | `cancel-button-label` | Define o label do botão de cancelar. | `string` | `undefined` |
|
|
13
|
+
| `getMessage` | -- | Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. | `(key: string, props?: any) => string` | `undefined` |
|
|
14
|
+
| `infoText` | `info-text` | Define a descrição do filtro. | `string` | `undefined` |
|
|
15
|
+
| `items` | -- | Guarda a lista de filtros. | `ModalItem[]` | `undefined` |
|
|
16
|
+
| `modalSubTitle` | `modal-sub-title` | Define o subtítulo do filtro. | `string` | `undefined` |
|
|
17
|
+
| `modalTitle` | `modal-title` | Define o título do filtro. | `string` | `undefined` |
|
|
18
|
+
| `okButtonLabel` | `ok-button-label` | Define o label do botão de confirmar. | `string` | `undefined` |
|
|
19
|
+
| `processModalAction` | -- | É disparado em qualquer interação com o filtro. | `(action: ModalAction) => void` | `undefined` |
|
|
20
|
+
| `useSearch` | `use-search` | Se `true`, exibe a barra de pesquisa do filtro. | `boolean` | `undefined` |
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
## Dependencies
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
| -------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ----------- |
|
|
12
12
|
| `configName` | `config-name` | Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. | `string` | `undefined` |
|
|
13
13
|
| `dataUnit` | -- | Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. | `DataUnit` | `undefined` |
|
|
14
|
-
| `filterConfig` | -- | Lista
|
|
14
|
+
| `filterConfig` | -- | Lista todos os filtros disponíveis ao usuário. | `SnkFilterItemConfig[]` | `undefined` |
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
## Dependencies
|
|
@@ -9,25 +9,25 @@
|
|
|
9
9
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| ------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
|
|
12
|
-
| `actionsList` | -- |
|
|
13
|
-
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário
|
|
14
|
-
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro
|
|
12
|
+
| `actionsList` | -- | Define a lista de ações que devem ser usadas no botão "Mais opções" do snk-taskbar. | `Action[]` | `undefined` |
|
|
13
|
+
| `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
|
|
14
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
|
15
15
|
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
## Events
|
|
19
19
|
|
|
20
|
-
| Event | Description
|
|
21
|
-
| ------------- |
|
|
22
|
-
| `actionClick` | Emitido sempre que houver click de botão ou ação | `CustomEvent<string>` |
|
|
23
|
-
| `exit` | Emitido quando o botão de voltar é acionado | `CustomEvent<void>` |
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| ------------- | ------------------------------------------------- | --------------------- |
|
|
22
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
23
|
+
| `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
## Methods
|
|
27
27
|
|
|
28
28
|
### `hideConfig() => Promise<void>`
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
Fecha a janela de configurações do formulário.
|
|
31
31
|
|
|
32
32
|
#### Returns
|
|
33
33
|
|
|
@@ -37,7 +37,7 @@ Type: `Promise<void>`
|
|
|
37
37
|
|
|
38
38
|
### `showConfig() => Promise<void>`
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
Exibe a janela de configurações do formulário.
|
|
41
41
|
|
|
42
42
|
#### Returns
|
|
43
43
|
|
|
@@ -7,18 +7,18 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| ------------- | ----------- |
|
|
12
|
-
| `dataUnit` | -- | Repositório de dados responsável por controlar a manipulação dos dados | `DataUnit` | `undefined` |
|
|
13
|
-
| `fieldConfig` | -- | Armazena as propriedades do campo | `IFieldConfig` | `{} as IFieldConfig` |
|
|
14
|
-
| `idConfig` | `id-config` | Armazena a chave de opções de configuração | `string` | `undefined` |
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------- | ----------- | ----------------------------------------------------------------------- | -------------- | -------------------- |
|
|
12
|
+
| `dataUnit` | -- | Repositório de dados responsável por controlar a manipulação dos dados. | `DataUnit` | `undefined` |
|
|
13
|
+
| `fieldConfig` | -- | Armazena as propriedades do campo. | `IFieldConfig` | `{} as IFieldConfig` |
|
|
14
|
+
| `idConfig` | `id-config` | Armazena a chave de opções de configuração. | `string` | `undefined` |
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
## Events
|
|
18
18
|
|
|
19
|
-
| Event | Description
|
|
20
|
-
| ---------------------- |
|
|
21
|
-
| `configOptionsChanged` |
|
|
19
|
+
| Event | Description | Type |
|
|
20
|
+
| ---------------------- | ------------------------------------------------ | ------------------ |
|
|
21
|
+
| `configOptionsChanged` | Emitido ao realizar alguma alteração nos campos. | `CustomEvent<any>` |
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
## Dependencies
|
|
@@ -7,19 +7,19 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| ---------------- | ---------------- |
|
|
12
|
-
| `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados | `DataUnit` | `undefined` |
|
|
13
|
-
| `fieldConfig` | -- | Armazena as propriedades do campo | `IFieldConfig` | `undefined` |
|
|
14
|
-
| `isConfigActive` | -- | Define se o popover de configuração está ativo.
|
|
15
|
-
| `modeInsertion` | `mode-insertion` | Define se o componente está em modo de inserção | `boolean` | `true` |
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ---------------- | ---------------- | ------------------------------------------------------- | -------------- | ----------- |
|
|
12
|
+
| `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
|
|
13
|
+
| `fieldConfig` | -- | Armazena as propriedades do campo. | `IFieldConfig` | `undefined` |
|
|
14
|
+
| `isConfigActive` | -- | Define se o popover de configuração está ativo. | `Boolean` | `false` |
|
|
15
|
+
| `modeInsertion` | `mode-insertion` | Define se o componente está em modo de inserção. | `boolean` | `true` |
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
## Events
|
|
19
19
|
|
|
20
|
-
| Event | Description
|
|
21
|
-
| ------------- |
|
|
22
|
-
| `ezClickIcon` |
|
|
20
|
+
| Event | Description | Type |
|
|
21
|
+
| ------------- | ------------------------------------ | --------------------- |
|
|
22
|
+
| `ezClickIcon` | Emitido ao clicar no ícone do botão. | `CustomEvent<Object>` |
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
## Dependencies
|
|
@@ -7,19 +7,19 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| ------------ | ------------- |
|
|
12
|
-
| `configName` | `config-name` | Nome usado para guardar
|
|
13
|
-
| `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados
|
|
14
|
-
| `formConfig` | -- | Campos de configuração de formulário.
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------ | ------------- | -------------------------------------------------------------------- | ------------- | ------------------- |
|
|
12
|
+
| `configName` | `config-name` | Nome usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
|
|
13
|
+
| `dataUnit` | -- | Repositório de dados, controla a manipulação dos dados. | `DataUnit` | `undefined` |
|
|
14
|
+
| `formConfig` | -- | Campos de configuração de formulário. | `IFormConfig` | `{} as IFormConfig` |
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
## Events
|
|
18
18
|
|
|
19
|
-
| Event | Description
|
|
20
|
-
| -------------- |
|
|
21
|
-
| `configChange` |
|
|
22
|
-
| `configClose` |
|
|
19
|
+
| Event | Description | Type |
|
|
20
|
+
| -------------- | ----------------------------------- | -------------------------- |
|
|
21
|
+
| `configChange` | Emitido ao salvar as configurações. | `CustomEvent<IFormConfig>` |
|
|
22
|
+
| `configClose` | Emitido ao fechar as configurações. | `CustomEvent<void>` |
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
## Dependencies
|
|
@@ -7,23 +7,23 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| --------------- | ---------------- |
|
|
12
|
-
| `selectedIndex` | `selected-index` | Define o index da aba selecionada.
|
|
13
|
-
| `selectedTab` | `selected-tab` | Define a aba selecionada.
|
|
14
|
-
| `tabs` | `tabs` | Define o nome das abas do componente
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| --------------- | ---------------- | ---------------------------------------------------------------- | -------- | ----------- |
|
|
12
|
+
| `selectedIndex` | `selected-index` | Define o index da aba selecionada. | `number` | `undefined` |
|
|
13
|
+
| `selectedTab` | `selected-tab` | Define a aba selecionada. | `string` | `undefined` |
|
|
14
|
+
| `tabs` | `tabs` | Define o nome das abas do componente separadas por vírgulas ",". | `string` | `undefined` |
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
## Events
|
|
18
18
|
|
|
19
|
-
| Event | Description
|
|
20
|
-
| ----------------- |
|
|
21
|
-
| `canStartDrag` |
|
|
22
|
-
| `deleteTab` |
|
|
23
|
-
| `editionTitleTab` |
|
|
24
|
-
| `ezOrderChange` |
|
|
25
|
-
| `ezTabChange` |
|
|
26
|
-
| `hideTab` |
|
|
19
|
+
| Event | Description | Type |
|
|
20
|
+
| ----------------- | ----------------------------------------------------------- | --------------------- |
|
|
21
|
+
| `canStartDrag` | Emitido ao ocultar uma aba. | `CustomEvent<any>` |
|
|
22
|
+
| `deleteTab` | Emitido ao deletar uma aba. | `CustomEvent<any>` |
|
|
23
|
+
| `editionTitleTab` | Emitido ao salvar uma alteração realizada no título da tab. | `CustomEvent<any>` |
|
|
24
|
+
| `ezOrderChange` | Emitido ao mover a ordem da aba. | `CustomEvent<number>` |
|
|
25
|
+
| `ezTabChange` | Emitido ao clicar para abrir o popup. | `CustomEvent<ITab>` |
|
|
26
|
+
| `hideTab` | Emitido ao ocultar uma aba. | `CustomEvent<any>` |
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
## Dependencies
|
|
@@ -9,26 +9,26 @@
|
|
|
9
9
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------- | ----------------- | ----------- |
|
|
12
|
-
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções"
|
|
13
|
-
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração
|
|
14
|
-
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada
|
|
15
|
-
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }
|
|
12
|
+
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
|
13
|
+
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
|
14
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
|
|
15
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `IStatusResolver` | `undefined` |
|
|
16
16
|
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
## Events
|
|
20
20
|
|
|
21
|
-
| Event | Description
|
|
22
|
-
| ----------------- |
|
|
23
|
-
| `actionClick` | Emitido sempre que houver click de botão ou ação | `CustomEvent<string>` |
|
|
24
|
-
| `gridDoubleClick` | Emitido sempre que houver duplo click na grade | `CustomEvent<void>` |
|
|
21
|
+
| Event | Description | Type |
|
|
22
|
+
| ----------------- | ------------------------------------------------- | --------------------- |
|
|
23
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
24
|
+
| `gridDoubleClick` | Emitido sempre que houver duplo click na grade. | `CustomEvent<void>` |
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
## Methods
|
|
28
28
|
|
|
29
29
|
### `hideConfig() => Promise<void>`
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
Fecha a janela de configurações da grade.
|
|
32
32
|
|
|
33
33
|
#### Returns
|
|
34
34
|
|
|
@@ -38,7 +38,7 @@ Type: `Promise<void>`
|
|
|
38
38
|
|
|
39
39
|
### `setConfig(config: IGridConfig) => Promise<void>`
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
Atribui o valor da configuração da grade.
|
|
42
42
|
|
|
43
43
|
#### Returns
|
|
44
44
|
|
|
@@ -48,7 +48,7 @@ Type: `Promise<void>`
|
|
|
48
48
|
|
|
49
49
|
### `showConfig() => Promise<void>`
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
Exibe a janela de configurações da grade.
|
|
52
52
|
|
|
53
53
|
#### Returns
|
|
54
54
|
|
|
@@ -16,17 +16,17 @@
|
|
|
16
16
|
|
|
17
17
|
## Events
|
|
18
18
|
|
|
19
|
-
| Event | Description
|
|
20
|
-
| -------------- |
|
|
21
|
-
| `configCancel` |
|
|
22
|
-
| `configChange` |
|
|
19
|
+
| Event | Description | Type |
|
|
20
|
+
| -------------- | -------------------------------------------------- | -------------------------- |
|
|
21
|
+
| `configCancel` | Emitido ao cancelar a alteração das configurações. | `CustomEvent<void>` |
|
|
22
|
+
| `configChange` | Emitido ao salvar a alteração das configurações. | `CustomEvent<IGridConfig>` |
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
## Methods
|
|
26
26
|
|
|
27
27
|
### `saveConfig(config: IGridConfig) => Promise<void>`
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
Salva as configurações da grade.
|
|
30
30
|
|
|
31
31
|
#### Returns
|
|
32
32
|
|
|
@@ -7,16 +7,16 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| ---------------- | ----------------- |
|
|
12
|
-
| `selectedOption` | `selected-option` |
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ---------------- | ----------------- | ------------------------------ | ------------------- | ------------------- |
|
|
12
|
+
| `selectedOption` | `selected-option` | Determina a opção selecionada. | `IOption \| string` | `ORDER_VALUES.none` |
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
## Events
|
|
16
16
|
|
|
17
|
-
| Event | Description
|
|
18
|
-
| ---------- |
|
|
19
|
-
| `ezChange` |
|
|
17
|
+
| Event | Description | Type |
|
|
18
|
+
| ---------- | ---------------------------------------------------------- | --------------------- |
|
|
19
|
+
| `ezChange` | Emitido ao alterar a seleção do componente snk-select-box. | `CustomEvent<string>` |
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
## Dependencies
|
|
@@ -7,11 +7,11 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute | Description
|
|
11
|
-
| -------------- | ---------- |
|
|
12
|
-
| `argument` | `argument` |
|
|
13
|
-
| `searchLoader` | -- |
|
|
14
|
-
| `selectItem` | -- |
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| -------------- | ---------- | ------------------------------------------------------------------- | -------------------------------- | ----------- |
|
|
12
|
+
| `argument` | `argument` | Argumentos que serão usados ao chamar a função searchLoader. | `string` | `undefined` |
|
|
13
|
+
| `searchLoader` | -- | Função responsável em carregar os itens do componente snk-pesquisa. | `(text: string) => Promise<any>` | `undefined` |
|
|
14
|
+
| `selectItem` | -- | Função disparada ao selecionar um item. | `(option: IOption) => void` | `undefined` |
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
## Dependencies
|
|
@@ -9,21 +9,21 @@
|
|
|
9
9
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| ----------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ----------- |
|
|
12
|
-
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções"
|
|
13
|
-
| `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados
|
|
14
|
-
| `configName` | `config-name` |
|
|
12
|
+
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
|
13
|
+
| `buttons` | `buttons` | Lista separada por virgula, contendo todos os elementos a serem criados. | `string` | `undefined` |
|
|
14
|
+
| `configName` | `config-name` | Usado para guardar ou recuperar as configurações do formulário. | `string` | `undefined` |
|
|
15
15
|
| `customButtons` | -- | Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer. | `Map<string, CustomButton>` | `undefined` |
|
|
16
|
-
| `dataUnit` | -- | Instância do DataUnit
|
|
17
|
-
| `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados
|
|
18
|
-
| `primaryButton` | `primary-button` |
|
|
16
|
+
| `dataUnit` | -- | Instância do DataUnit. | `DataUnit` | `undefined` |
|
|
17
|
+
| `disabledButtons` | -- | Array contendo todos os botões a serem desabilitados. | `string[]` | `undefined` |
|
|
18
|
+
| `primaryButton` | `primary-button` | Determina qual botão deve ter aparência primária. | `string` | `undefined` |
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
## Events
|
|
22
22
|
|
|
23
|
-
| Event | Description
|
|
24
|
-
| -------------- |
|
|
25
|
-
| `actionChange` | Emitido sempre que houver alteração em algum elemento aberto pelo botão de ação | `CustomEvent<any>` |
|
|
26
|
-
| `actionClick` | Emitido sempre que houver click de botão ou ação | `CustomEvent<string>` |
|
|
23
|
+
| Event | Description | Type |
|
|
24
|
+
| -------------- | -------------------------------------------------------------------------------- | --------------------- |
|
|
25
|
+
| `actionChange` | Emitido sempre que houver alteração em algum elemento aberto pelo botão de ação. | `CustomEvent<any>` |
|
|
26
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
## Dependencies
|