@sankhyalabs/sankhyablocks 2.4.0 → 2.4.2-SKA-61927.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.
Files changed (105) hide show
  1. package/dist/cjs/snk-application.cjs.entry.js +45 -28
  2. package/dist/cjs/snk-config-options.cjs.entry.js +1 -1
  3. package/dist/cjs/snk-configurator_3.cjs.entry.js +11 -5
  4. package/dist/cjs/snk-crud.cjs.entry.js +1 -1
  5. package/dist/cjs/snk-data-unit.cjs.entry.js +2 -4
  6. package/dist/cjs/snk-filter-bar_7.cjs.entry.js +21 -0
  7. package/dist/cjs/snk-filter-binary-select.cjs.entry.js +6 -0
  8. package/dist/cjs/snk-filter-detail.cjs.entry.js +3 -0
  9. package/dist/cjs/snk-filter-multi-select.cjs.entry.js +6 -0
  10. package/dist/cjs/snk-filter-number.cjs.entry.js +6 -0
  11. package/dist/cjs/snk-filter-period.cjs.entry.js +6 -0
  12. package/dist/cjs/snk-filter-personalized.cjs.entry.js +3 -0
  13. package/dist/cjs/snk-filter-search.cjs.entry.js +6 -0
  14. package/dist/cjs/snk-filter-text.cjs.entry.js +3 -0
  15. package/dist/cjs/snk-form.cjs.entry.js +2 -2
  16. package/dist/collection/components/snk-application/snk-application.js +81 -64
  17. package/dist/collection/components/snk-configurator/snk-configurator.js +11 -5
  18. package/dist/collection/components/snk-crud/snk-crud.js +5 -5
  19. package/dist/collection/components/snk-data-unit/snk-data-unit.js +14 -19
  20. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-binary-select.js +9 -3
  21. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-multi-select.js +9 -3
  22. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-number.js +9 -3
  23. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-period.js +9 -3
  24. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-personalized.js +6 -3
  25. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-search.js +9 -3
  26. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-text.js +5 -2
  27. package/dist/collection/components/snk-filter-bar/filter-item/snk-filter-detail.js +7 -4
  28. package/dist/collection/components/snk-filter-bar/filter-item/snk-filter-item.js +15 -6
  29. package/dist/collection/components/snk-filter-bar/filter-list/snk-filter-list.js +12 -9
  30. package/dist/collection/components/snk-filter-bar/filter-modal/snk-filter-modal.js +9 -9
  31. package/dist/collection/components/snk-filter-bar/snk-filter-bar.js +4 -1
  32. package/dist/collection/components/snk-form/snk-form.js +9 -9
  33. package/dist/collection/components/snk-form/subcomponents/snk-config-options/snk-config-options.js +5 -5
  34. package/dist/collection/components/snk-form/subcomponents/snk-field-config/snk-field-config.js +6 -6
  35. package/dist/collection/components/snk-form/subcomponents/snk-form-config/snk-form-config.js +4 -4
  36. package/dist/collection/components/snk-form/subcomponents/snk-tab-config/snk-tab-config.js +7 -7
  37. package/dist/collection/components/snk-grid/snk-grid.js +12 -12
  38. package/dist/collection/components/snk-grid/subcomponents/snk-grid-config/snk-grid-config.js +6 -3
  39. package/dist/collection/components/snk-grid/subcomponents/snk-select-box/snk-select-box.js +5 -2
  40. package/dist/collection/components/snk-pesquisa/snk-pesquisa.js +11 -10
  41. package/dist/collection/components/snk-taskbar/snk-taskbar.js +8 -8
  42. package/dist/components/snk-application2.js +45 -28
  43. package/dist/components/snk-config-options2.js +1 -1
  44. package/dist/components/snk-configurator2.js +6 -0
  45. package/dist/components/snk-crud.js +1 -1
  46. package/dist/components/snk-data-unit.js +2 -4
  47. package/dist/components/snk-field-config2.js +2 -2
  48. package/dist/components/snk-filter-bar2.js +3 -0
  49. package/dist/components/snk-filter-binary-select.js +6 -0
  50. package/dist/components/snk-filter-detail2.js +3 -0
  51. package/dist/components/snk-filter-item2.js +9 -0
  52. package/dist/components/snk-filter-list2.js +3 -0
  53. package/dist/components/snk-filter-multi-select.js +6 -0
  54. package/dist/components/snk-filter-number.js +6 -0
  55. package/dist/components/snk-filter-period.js +6 -0
  56. package/dist/components/snk-filter-personalized.js +3 -0
  57. package/dist/components/snk-filter-search.js +6 -0
  58. package/dist/components/snk-filter-text.js +3 -0
  59. package/dist/components/snk-form2.js +2 -2
  60. package/dist/components/snk-grid-config2.js +3 -0
  61. package/dist/components/snk-grid2.js +3 -3
  62. package/dist/components/snk-select-box2.js +3 -0
  63. package/dist/esm/snk-application.entry.js +45 -28
  64. package/dist/esm/snk-config-options.entry.js +1 -1
  65. package/dist/esm/snk-configurator_3.entry.js +11 -5
  66. package/dist/esm/snk-crud.entry.js +1 -1
  67. package/dist/esm/snk-data-unit.entry.js +2 -4
  68. package/dist/esm/snk-filter-bar_7.entry.js +21 -0
  69. package/dist/esm/snk-filter-binary-select.entry.js +6 -0
  70. package/dist/esm/snk-filter-detail.entry.js +3 -0
  71. package/dist/esm/snk-filter-multi-select.entry.js +6 -0
  72. package/dist/esm/snk-filter-number.entry.js +6 -0
  73. package/dist/esm/snk-filter-period.entry.js +6 -0
  74. package/dist/esm/snk-filter-personalized.entry.js +3 -0
  75. package/dist/esm/snk-filter-search.entry.js +6 -0
  76. package/dist/esm/snk-filter-text.entry.js +3 -0
  77. package/dist/esm/snk-form.entry.js +2 -2
  78. package/dist/types/components/snk-application/snk-application.d.ts +48 -32
  79. package/dist/types/components/snk-configurator/snk-configurator.d.ts +9 -3
  80. package/dist/types/components/snk-crud/snk-crud.d.ts +4 -4
  81. package/dist/types/components/snk-data-unit/snk-data-unit.d.ts +12 -14
  82. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-binary-select.d.ts +12 -0
  83. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-multi-select.d.ts +12 -0
  84. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-number.d.ts +12 -0
  85. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-period.d.ts +12 -0
  86. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-personalized.d.ts +9 -0
  87. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-search.d.ts +12 -0
  88. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-text.d.ts +9 -0
  89. package/dist/types/components/snk-filter-bar/filter-item/snk-filter-detail.d.ts +12 -0
  90. package/dist/types/components/snk-filter-bar/filter-item/snk-filter-item.d.ts +20 -2
  91. package/dist/types/components/snk-filter-bar/filter-list/snk-filter-list.d.ts +27 -0
  92. package/dist/types/components/snk-filter-bar/filter-modal/snk-filter-modal.d.ts +28 -1
  93. package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts +4 -1
  94. package/dist/types/components/snk-form/snk-form.d.ts +7 -7
  95. package/dist/types/components/snk-form/subcomponents/snk-config-options/snk-config-options.d.ts +4 -4
  96. package/dist/types/components/snk-form/subcomponents/snk-field-config/snk-field-config.d.ts +5 -5
  97. package/dist/types/components/snk-form/subcomponents/snk-form-config/snk-form-config.d.ts +4 -4
  98. package/dist/types/components/snk-form/subcomponents/snk-tab-config/snk-tab-config.d.ts +8 -10
  99. package/dist/types/components/snk-grid/snk-grid.d.ts +9 -9
  100. package/dist/types/components/snk-grid/subcomponents/snk-grid-config/snk-grid-config.d.ts +5 -2
  101. package/dist/types/components/snk-grid/subcomponents/snk-select-box/snk-select-box.d.ts +6 -0
  102. package/dist/types/components/snk-pesquisa/snk-pesquisa.d.ts +12 -2
  103. package/dist/types/components/snk-taskbar/snk-taskbar.d.ts +8 -8
  104. package/dist/types/components.d.ts +428 -135
  105. package/package.json +1 -1
@@ -45,8 +45,7 @@ export declare class SnkApplication {
45
45
  private get auth();
46
46
  private _element;
47
47
  /**
48
- * messagesBuilder é um utilitário responsável por flexibilizar e padronizar
49
- * o uso de mensagens nos blocos de construção.
48
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
50
49
  */
51
50
  messagesBuilder: SnkMessageBuilder;
52
51
  /**
@@ -54,45 +53,51 @@ export declare class SnkApplication {
54
53
  */
55
54
  configName: string;
56
55
  /**
57
- * Caso o usuário logado seja o SUP.
56
+ * Obtém `true` caso o usuário logado seja o SUP.
58
57
  */
59
58
  isUserSup(): Promise<boolean>;
60
59
  /**
61
- * Se o usuário logado tem permissão pra determinada ação.
60
+ * Obtém `true` caso o usuário logado tem permissão pra determinada ação.
62
61
  */
63
62
  hasAccess(access: AutorizationType): Promise<boolean>;
64
63
  /**
65
- * Retorna todos os acessos do usuário logado.
64
+ * Obtém todos os acessos do usuário logado.
66
65
  */
67
66
  getAllAccess(): Promise<any>;
68
67
  /**
69
- * Retorna o valor de um parâmetro do tipo string.
68
+ * Obtém o valor de um parâmetro do tipo string.
70
69
  */
71
70
  getStringParam(name: string): Promise<string>;
72
71
  /**
73
- * Retorna o valor de um parâmetro do tipo Inteiro.
72
+ * Obtém o valor de um parâmetro do tipo Inteiro.
74
73
  */
75
74
  getIntParam(name: string): Promise<number>;
76
75
  /**
77
- * Retorna o valor de um parâmetro do tipo Decimal.
76
+ * Obtém o valor de um parâmetro do tipo Decimal.
78
77
  */
79
78
  getFloatParam(name: string): Promise<number>;
80
79
  /**
81
- * Retorna o valor de um parâmetro do tipo booleano.
80
+ * Obtém o valor de um parâmetro do tipo booleano.
82
81
  */
83
82
  getBooleanParam(name: string): Promise<boolean>;
84
83
  /**
85
- * Retorna o valor de um parâmetro do tipo data.
84
+ * Obtém o valor de um parâmetro do tipo data.
86
85
  */
87
86
  getDateParam(name: string): Promise<Date>;
88
87
  /**
89
- * Mostra o conteúdo passado em um Popup
88
+ * Exibe o conteúdo passado em um Popup.
90
89
  */
91
90
  showPopUp(content: HTMLElement, size?: string, useHeader?: boolean): Promise<void>;
91
+ /**
92
+ * Exibe o conteúdo passado em um Modal.
93
+ */
92
94
  showModal(content: HTMLElement): Promise<void>;
95
+ /**
96
+ * Fecha o Modal e limpa o conteúdo.
97
+ */
93
98
  closeModal(): Promise<void>;
94
99
  /**
95
- * Fecha o popup, liberando o conteúdo.
100
+ * Fecha o Popup e limpa o conteúdo.
96
101
  */
97
102
  closePopUp(): Promise<void>;
98
103
  /**
@@ -100,7 +105,7 @@ export declare class SnkApplication {
100
105
  */
101
106
  temOpcional(opcional: string): Promise<boolean>;
102
107
  /**
103
- * Retorna a configuração de um recurso por service broker
108
+ * Obtém a configuração de um recurso por service broker
104
109
  */
105
110
  getConfig(key: string): Promise<any>;
106
111
  /**
@@ -108,17 +113,17 @@ export declare class SnkApplication {
108
113
  */
109
114
  saveConfig(key: string, data: Object): Promise<any>;
110
115
  /**
111
- * Acessa informações de contexto "empurrados" na abertura da tela
116
+ * Acessa informações de contexto "empurrados" na abertura da tela.
112
117
  */
113
118
  getAttributeFromHTMLWrapper(attribName: string): Promise<string>;
114
119
  /**
115
- * Abre determinada tela, repassando pkObject
120
+ * Abre determinada tela, repassando pkObject.
116
121
  */
117
122
  openApp(resourceId: string, pkObject: Object): Promise<void>;
118
123
  private getDuPromissesStack;
119
124
  /**
120
125
  * Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
121
- * passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado
126
+ * passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
122
127
  */
123
128
  createDataunit(entityName: string, dataUnitName?: string): Promise<DataUnit>;
124
129
  /**
@@ -126,23 +131,23 @@ export declare class SnkApplication {
126
131
  */
127
132
  getDataUnit(entityName: string, dataUnitName: string): Promise<DataUnit>;
128
133
  /**
129
- * Retorna o resourceID da tela em questão.
134
+ * Obtém o resourceID da tela em questão.
130
135
  */
131
136
  getResourceID(): Promise<string>;
132
137
  /**
133
- * Retorna o resourceID da tela em questão.
138
+ * Obtém o UserId da tela em questão.
134
139
  */
135
140
  getUserID(): Promise<string>;
136
141
  /**
137
- * Mostra o diálogo de alerta de acordo com os parâmetros passados.
142
+ * Exibe o diálogo de alerta de acordo com os parâmetros passados.
138
143
  */
139
144
  alert(title: string, message: string, icon?: string, options?: MessageOptions): Promise<boolean>;
140
145
  /**
141
- * Mostra o diálogo de erro de acordo com os parâmetros passados.
146
+ * Exibe o diálogo de erro de acordo com os parâmetros passados.
142
147
  */
143
148
  error(title: string, message: string, icon?: string, options?: MessageOptions): Promise<boolean>;
144
149
  /**
145
- * Mostra o diálogo de sucesso de acordo com os parâmetros passados.
150
+ * Exibe o diálogo de sucesso de acordo com os parâmetros passados.
146
151
  */
147
152
  success(title: string, message: string, icon?: string, options?: MessageOptions): Promise<boolean>;
148
153
  /**
@@ -154,31 +159,31 @@ export declare class SnkApplication {
154
159
  */
155
160
  confirm(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions): Promise<boolean>;
156
161
  /**
157
- * Mostra uma informação efêmera (de segundo plano).
162
+ * Exibe uma informação efêmera (de segundo plano).
158
163
  */
159
164
  info(message: string, options?: MessageOptions): Promise<void>;
160
165
  /**
161
- * Busca a configuração de formulário.
166
+ * Obtém a configuração de formulário.
162
167
  */
163
168
  loadFormConfig(name: string): Promise<IFormConfig>;
164
169
  /**
165
- * Busca a configuração de grade.
170
+ * Obtém a configuração de grade.
166
171
  */
167
172
  loadGridConfig(name: string): Promise<IGridConfig>;
168
173
  /**
169
- * Busca lista de configurações de formulário do usuário.
174
+ * Obtém a lista de configurações de formulário do usuário.
170
175
  */
171
176
  fetchUserAvailableConfigs(name: string): Promise<Array<IUserConfig>>;
172
177
  /**
173
- * Busca a configuração de formulário do usuário.
178
+ * Obtém a configuração de formulário do usuário.
174
179
  */
175
180
  fetchLegacyConfig(name: string): Promise<IFormConfig>;
176
181
  /**
177
- * Busca a configuração padrão de formulário.
182
+ * Obtém a configuração padrão de formulário.
178
183
  */
179
184
  fetchDefaultConfig(name: string): Promise<IFormConfig>;
180
185
  /**
181
- * Busca os totalizadores da grade.
186
+ * Obtém os totalizadores da grade.
182
187
  */
183
188
  loadTotals(name: string, resourceID: string, filters: Array<Filter>): Promise<Map<string, number>>;
184
189
  /**
@@ -198,19 +203,19 @@ export declare class SnkApplication {
198
203
  */
199
204
  saveFormConfig(config: IFormConfig, name: string): Promise<boolean>;
200
205
  /**
201
- * Busca um objeto com um conjunto de valores padrão.
206
+ * Obtém um objeto com um conjunto de valores padrão.
202
207
  */
203
208
  getDefaultValues(): Promise<string>;
204
209
  /**
205
- * Retorna um valor padrão específico de uma expressão.
210
+ * Obtém um valor padrão específico de uma expressão.
206
211
  */
207
212
  getDefaultValue(expression: string): Promise<any>;
208
213
  /**
209
- * Evento disparado quando a aplicação for carregada.
214
+ * Emitido quando a aplicação for carregada.
210
215
  */
211
216
  applicationLoaded: EventEmitter<boolean>;
212
217
  /**
213
- * Evento disparado ao iniciar a carga do componente
218
+ * Emitido ao iniciar a carga do componente.
214
219
  */
215
220
  applicationLoading: EventEmitter<boolean>;
216
221
  private getAuthList;
@@ -223,8 +228,19 @@ export declare class SnkApplication {
223
228
  private get authFetcher();
224
229
  private get filterBarConfigFetcher();
225
230
  private get defaultValuesFetcher();
231
+ /**
232
+ * Obtém as opções em componentes de pesquisa
233
+ * Ex.: snk-config-options
234
+ */
226
235
  executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit): Promise<Array<IOption> | IOption>;
236
+ /**
237
+ * Obtém as opções em componentes de pesquisa
238
+ * Ex.: snk-config-options
239
+ */
227
240
  executePreparedSearch(mode: string, argument: string, options: any): Promise<Array<IOption> | IOption>;
241
+ /**
242
+ * Obtém `true` caso a tela esteja em modo de debug.
243
+ */
228
244
  isDebugMode(): Promise<boolean>;
229
245
  private clearContent;
230
246
  private clearPopUpTitle;
@@ -8,7 +8,7 @@ export declare class SnkConfigurator {
8
8
  _opened: boolean;
9
9
  _permissions: any;
10
10
  /**
11
- * Nome usado para guardar/recuperar as configurações do formulário
11
+ * Usado para guardar ou recuperar as configurações do formulário.
12
12
  */
13
13
  configName: string;
14
14
  /**
@@ -16,14 +16,20 @@ export declare class SnkConfigurator {
16
16
  */
17
17
  viewMode: string;
18
18
  /**
19
- * Evento disparado quando seleciona modo de visualização
19
+ * Emitido quando seleciona o modo de visualização.
20
20
  */
21
21
  configSelected: EventEmitter<string>;
22
22
  /**
23
- * Evento disparado quando clicar para abrir uma configuração
23
+ * Emitido quando clica para abrir a configuração.
24
24
  */
25
25
  openConfig: EventEmitter<string>;
26
+ /**
27
+ * Exibe a janela de configuração.
28
+ */
26
29
  open(): Promise<void>;
30
+ /**
31
+ * Fecha a janela de configuração.
32
+ */
27
33
  close(): Promise<void>;
28
34
  private closeConfig;
29
35
  private onViewModeChanged;
@@ -20,7 +20,7 @@ export declare class SnkCrud {
20
20
  */
21
21
  configName: string;
22
22
  /**
23
- * Ações a serem colocadas no botão "Mais opções".
23
+ * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
24
24
  */
25
25
  actionsList: Array<Action>;
26
26
  /**
@@ -29,7 +29,7 @@ export declare class SnkCrud {
29
29
  */
30
30
  taskbarManager: TaskbarManager;
31
31
  /**
32
- * Validador responsável por checar a integridade das informações do registro
32
+ * Validador responsável por checar a integridade das informações do registro.
33
33
  */
34
34
  recordsValidator: IRecordValidator;
35
35
  /**
@@ -38,11 +38,11 @@ export declare class SnkCrud {
38
38
  */
39
39
  statusResolver: IStatusResolver;
40
40
  /**
41
- * Determina se pode haver mais de uma linha selecionada na grade
41
+ * Determina se pode haver mais de uma linha selecionada na grade.
42
42
  */
43
43
  multipleSelection: boolean;
44
44
  /**
45
- * Emitido pela taskbar sempre que houver click de botão ou ação
45
+ * Emitido pela taskbar sempre que houver click de botão ou ação.
46
46
  */
47
47
  actionClick: EventEmitter<string>;
48
48
  /**
@@ -7,24 +7,24 @@ export declare class SnkDataUnit implements DUActionInterceptor {
7
7
  _permissions: any;
8
8
  element: HTMLSnkDataUnitElement;
9
9
  /**
10
- * O estato atual dos dados, isto é se há alteração, insersão, as linhas selecionadas, etc.
10
+ * Controla o estado atual dos dados.
11
11
  */
12
12
  dataState: DataState;
13
13
  /**
14
- * Este atributo é usado para criar o dataUnit uma única vez. Se omitido será usado o próprio nome
15
- * da entidade.
14
+ * Usado para criar o dataUnit uma única vez.
15
+ * Se omitido, será usado o próprio nome da entidade.
16
16
  */
17
17
  dataUnitName: string;
18
18
  /**
19
- * Determina qual a entidade representa os dados em questão.
19
+ * Determina qual a entidade que representa os dados em questão.
20
20
  */
21
21
  entityName: string;
22
22
  /**
23
- * Determina quantas linhas são retornadas por página
23
+ * Determina quantas linhas são retornadas por página.
24
24
  */
25
25
  pageSize: number;
26
26
  /**
27
- * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade
27
+ * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
28
28
  */
29
29
  dataUnit: DataUnit;
30
30
  /**
@@ -33,7 +33,7 @@ export declare class SnkDataUnit implements DUActionInterceptor {
33
33
  */
34
34
  beforeSave: (dataUnit: DataUnit) => boolean | Promise<boolean>;
35
35
  /**
36
- * Executado após a ação de salvar
36
+ * Executado após a ação de salvar.
37
37
  */
38
38
  afterSave: (dataUnit: DataUnit) => void;
39
39
  observePageSize(): void;
@@ -42,25 +42,23 @@ export declare class SnkDataUnit implements DUActionInterceptor {
42
42
  observeDataState(newValue: DataState, oldValue: DataState): void;
43
43
  observeDataUnit(): void;
44
44
  /**
45
- * Disparado quando o há qualquer mudança de estado no DataUnit
45
+ * Emitido quando há qualquer mudança de estado no DataUnit.
46
46
  */
47
47
  dataStateChange: EventEmitter<DataState>;
48
48
  /**
49
- * Disparado quando o DataUnit está pronto
49
+ * Emitido quando o DataUnit está pronto.
50
50
  */
51
51
  dataUnitReady: EventEmitter<DataUnit>;
52
52
  /**
53
- * Disparado quando um registro é adicionado ou copiado
53
+ * Emitido quando um registro é adicionado ou copiado.
54
54
  */
55
55
  insertionMode: EventEmitter<void>;
56
56
  /**
57
- * Disparado quando se cancela uma insersão/cópia
57
+ * Emitido quando se cancela uma inserção ou cópia.
58
58
  */
59
59
  cancelEdition: EventEmitter<void>;
60
60
  /**
61
- * Pode-se obter o dataUnit através desse método. Outra forma, é ouvir o evento de
62
- *
63
- * @returns dataUnit
61
+ * Obtém o dataUnit.
64
62
  */
65
63
  getDataUnit(): Promise<DataUnit>;
66
64
  interceptAction(action: DataUnitAction): Promise<DataUnitAction>;
@@ -3,13 +3,25 @@ export declare class SnkFilterBinarySelect {
3
3
  _element: HTMLElement;
4
4
  _checkOne: HTMLEzCheckElement;
5
5
  _checkTwo: HTMLEzCheckElement;
6
+ /**
7
+ * Define o valor do componente snk-filter-binary-select
8
+ */
6
9
  value: any;
10
+ /**
11
+ * Define as configurações do componente snk-filter-binary-select
12
+ */
7
13
  config: SnkFilterItemConfig;
8
14
  isSelected(option: string): boolean;
15
+ /**
16
+ * Emitido quando acontece a alteração de valor do componente snk-filter-binary-select
17
+ */
9
18
  ezChangeListener(evt: CustomEvent): void;
10
19
  componentDidLoad(): void;
11
20
  assertCheckedOption(updatingCheck: HTMLElement): void;
12
21
  updateValue(): void;
22
+ /**
23
+ * Exibe o componente snk-filter-binary-select
24
+ */
13
25
  show(): Promise<void>;
14
26
  render(): any;
15
27
  }
@@ -2,9 +2,21 @@ import { SnkFilterItemConfig } from '../snk-filter-item';
2
2
  export declare class SnkFilterMultiSelect {
3
3
  _element: HTMLElement;
4
4
  _comboElement: HTMLEzComboBoxElement;
5
+ /**
6
+ * Define o valor do componente snk-filter-multi-select
7
+ */
5
8
  value: any;
9
+ /**
10
+ * Define as configurações do componente snk-filter-multi-select
11
+ */
6
12
  config: SnkFilterItemConfig;
13
+ /**
14
+ * Emitido quando acontece a alteração de valor do componente snk-filter-multi-select
15
+ */
7
16
  ezChangeListener(evt: CustomEvent): void;
17
+ /**
18
+ * Exibe o componente snk-filter-multi-select
19
+ */
8
20
  show(): Promise<void>;
9
21
  componentDidLoad(): void;
10
22
  render(): any;
@@ -2,9 +2,21 @@ import { SnkFilterItemConfig } from '../snk-filter-item';
2
2
  export declare class SnkFilterPeriod {
3
3
  _element: HTMLElement;
4
4
  _numberElement: HTMLEzNumberInputElement;
5
+ /**
6
+ * Define as configurações do componente snk-filter-number
7
+ */
5
8
  config: SnkFilterItemConfig;
9
+ /**
10
+ * Define o valor do componente snk-filter-number
11
+ */
6
12
  value: number;
13
+ /**
14
+ * Emitido quando acontece a alteração de valor do componente snk-filter-number
15
+ */
7
16
  ezChangeListener(evt: CustomEvent): void;
17
+ /**
18
+ * Exibe o componente snk-filter-number
19
+ */
8
20
  show(): Promise<void>;
9
21
  componentDidLoad(): void;
10
22
  render(): any;
@@ -3,11 +3,23 @@ export declare class SnkFilterPeriod {
3
3
  _element: HTMLElement;
4
4
  _startDate: HTMLEzDateInputElement;
5
5
  _endDate: HTMLEzDateInputElement;
6
+ /**
7
+ * Define as configurações do componente snk-filter-period
8
+ */
6
9
  config: SnkFilterItemConfig;
10
+ /**
11
+ * Define o valor do componente snk-filter-period
12
+ */
7
13
  value: any;
14
+ /**
15
+ * Emitido quando acontece a alteração de valor do componente snk-filter-period
16
+ */
8
17
  ezChangeListener(): void;
9
18
  componentDidLoad(): void;
10
19
  getDate(prop: string): Date;
20
+ /**
21
+ * Exibe o componente snk-filter-period
22
+ */
11
23
  show(): Promise<void>;
12
24
  render(): any;
13
25
  }
@@ -3,7 +3,13 @@ import { IOption } from '@sankhyalabs/ezui/dist/types/components/ez-combo-box/ez
3
3
  import { SnkFilterItemConfig } from '../snk-filter-item';
4
4
  export declare class SnkFilterPersonalized {
5
5
  _element: HTMLElement;
6
+ /**
7
+ * Define as configurações do componente snk-filter-personalized
8
+ */
6
9
  config: SnkFilterItemConfig;
10
+ /**
11
+ * Define o valor do componente snk-filter-personalized
12
+ */
7
13
  value: Array<IOption | boolean | string | number | Date>;
8
14
  fix: () => void;
9
15
  unfix: () => void;
@@ -12,6 +18,9 @@ export declare class SnkFilterPersonalized {
12
18
  setValue(index: number, value: IOption | boolean | string | number | Date): void;
13
19
  doSearch(mode: string, argument: string, param: FilterParameter): Promise<Array<IOption> | IOption>;
14
20
  getParamsInterface(): any[];
21
+ /**
22
+ * Exibe o componente snk-filter-personalized
23
+ */
15
24
  show(): Promise<void>;
16
25
  render(): any;
17
26
  }
@@ -2,12 +2,24 @@ import { IOption } from '@sankhyalabs/ezui/dist/types/components/ez-combo-box/ez
2
2
  import { SnkFilterItemConfig } from '../snk-filter-item';
3
3
  export declare class SnkFilterSearch {
4
4
  _element: HTMLElement;
5
+ /**
6
+ * Define as configurações do componente snk-filter-search
7
+ */
5
8
  config: SnkFilterItemConfig;
9
+ /**
10
+ * Define o valor do componente snk-filter-search
11
+ */
6
12
  value: IOption;
7
13
  _searchInput: HTMLEzSearchElement;
14
+ /**
15
+ * Emitido quando acontece a alteração de valor do componente snk-filter-search
16
+ */
8
17
  ezChangeListener(_evt: CustomEvent): void;
9
18
  componentDidLoad(): void;
10
19
  doSearch(mode: string, argument: string): Promise<Array<IOption> | IOption>;
20
+ /**
21
+ * Exibe o componente snk-filter-search
22
+ */
11
23
  show(): Promise<void>;
12
24
  render(): any;
13
25
  }
@@ -2,8 +2,17 @@ import { SnkFilterItemConfig } from '../snk-filter-item';
2
2
  export declare class SnkFilterText {
3
3
  _element: HTMLElement;
4
4
  _textInputElement: HTMLEzTextInputElement;
5
+ /**
6
+ * Define as configurações do componente snk-filter-text.
7
+ */
5
8
  config: SnkFilterItemConfig;
9
+ /**
10
+ * Define o valor do componente snk-filter-text.
11
+ */
6
12
  value: string;
13
+ /**
14
+ * Emitido quando acontece a alteração de valor do componente snk-filter-text.
15
+ */
7
16
  ezChangeListener(evt: CustomEvent): void;
8
17
  componentDidLoad(): void;
9
18
  render(): any;
@@ -6,9 +6,21 @@ export declare class SnkFilterDetail {
6
6
  _editor: HTMLElement;
7
7
  _applyButton: HTMLEzButtonElement;
8
8
  _idContentEditor: string;
9
+ /**
10
+ * Define as configurações do componente snk-filter-detail.
11
+ */
9
12
  config: SnkFilterItemConfig;
13
+ /**
14
+ * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
15
+ */
10
16
  getMessage: (key: string, props?: any) => string;
17
+ /**
18
+ * Emitido quando há uma alteração nos filtros.
19
+ */
11
20
  filterChange: EventEmitter<SnkFilterItemConfig>;
21
+ /**
22
+ * Exibe o componente snk-filter-detail.
23
+ */
12
24
  show(): Promise<void>;
13
25
  componentDidLoad(): void;
14
26
  changeConfig(newConfig: SnkFilterItemConfig): void;
@@ -12,16 +12,31 @@ export declare class SnkFilterItem {
12
12
  _idSnkFilterDetail: string;
13
13
  _idEzChip: string;
14
14
  detailIsVisible: boolean;
15
+ /**
16
+ * Define as configurações do componente snk-filter-item.
17
+ */
15
18
  config: SnkFilterItemConfig;
19
+ /**
20
+ * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
21
+ */
16
22
  getMessage: (key: string, props?: any) => string;
17
23
  /**
18
- * Disparado quando o detalhe de um item da lista é aberto ou fechado.
24
+ * Emitido quando o detalhe de um item da lista é aberto ou fechado.
19
25
  */
20
26
  visibleChanged: EventEmitter<boolean>;
27
+ /**
28
+ * Emitido quando há uma alteração nos filtros.
29
+ */
30
+ filterChange: EventEmitter<SnkFilterItemConfig>;
21
31
  observeDetailIsVisible(value: boolean): void;
32
+ /**
33
+ * Exibe os detalhes de um item da lista.
34
+ */
22
35
  showUp(open?: boolean): Promise<void>;
23
- filterChange: EventEmitter<SnkFilterItemConfig>;
24
36
  private getScrollOffset;
37
+ /**
38
+ * Oculta os detalhes de um item da lista.
39
+ */
25
40
  hideDetail(): Promise<void>;
26
41
  onDetailCloseCallback(): void;
27
42
  innerClickCheck: (_floatingContainer: HTMLElement, node: HTMLElement) => boolean;
@@ -30,6 +45,9 @@ export declare class SnkFilterItem {
30
45
  getLabel(): any;
31
46
  componentDidLoad(): void;
32
47
  componentDidRender(): void;
48
+ /**
49
+ * Emitido quando o estado do filtro é alterado.
50
+ */
33
51
  filterChangeListener(): void;
34
52
  getRightIconName(): "close" | "chevron-up" | "chevron-down";
35
53
  getLeftIconName(): "calendar" | "tune";
@@ -11,16 +11,43 @@ export declare class SnkFilterList {
11
11
  _preselection: number;
12
12
  _filterArgument: string;
13
13
  _showAll: boolean;
14
+ /**
15
+ * Define o label usado no ez-button do filtro.
16
+ */
14
17
  label: string;
18
+ /**
19
+ * Define o ícone usado no ez-button do filtro.
20
+ */
15
21
  iconName: string;
22
+ /**
23
+ * Guarda a lista de filtros.
24
+ */
16
25
  items: Array<ListItem>;
26
+ /**
27
+ * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
28
+ */
17
29
  getMessage: (key: string, props?: any) => string;
30
+ /**
31
+ * Define o texto exibido quando a lista está vazia.
32
+ */
18
33
  emptyText: string;
34
+ /**
35
+ * Define o texto exibido no componente de busca.
36
+ */
19
37
  findFilterText: string;
38
+ /**
39
+ * Define a classe CSS a ser adicionada no botão (usado principalmente para sinalizar o filtro aplicado).
40
+ */
20
41
  buttonClass: string;
42
+ /**
43
+ * Disparado quando um item da lista é clicado.
44
+ */
21
45
  snkItemSelected: EventEmitter<string>;
22
46
  private showDetail;
23
47
  innerClickCheck: (_floatingContainer: HTMLElement, node: HTMLElement) => boolean;
48
+ /**
49
+ * Oculta os detalhes do componente snk-filter-list.
50
+ */
24
51
  hideDetail(): Promise<void>;
25
52
  private onListCloseCallback;
26
53
  private buttonClick;
@@ -1,15 +1,42 @@
1
1
  import { ModalAction } from "@sankhyalabs/ezui/dist/collection/components/ez-modal-container";
2
2
  export declare class SnkFilterModal {
3
3
  _filterInput: HTMLEzFilterInputElement;
4
+ _filterArgument: string;
5
+ /**
6
+ * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
7
+ */
4
8
  getMessage: (key: string, props?: any) => string;
9
+ /**
10
+ * Guarda a lista de filtros.
11
+ */
5
12
  items: Array<ModalItem>;
6
- _filterArgument: string;
13
+ /**
14
+ * Define o título do filtro.
15
+ */
7
16
  modalTitle: string;
17
+ /**
18
+ * Define o subtítulo do filtro.
19
+ */
8
20
  modalSubTitle: string;
21
+ /**
22
+ * Define o label do botão de cancelar.
23
+ */
9
24
  cancelButtonLabel: string;
25
+ /**
26
+ * Define o label do botão de confirmar.
27
+ */
10
28
  okButtonLabel: string;
29
+ /**
30
+ * Define a descrição do filtro.
31
+ */
11
32
  infoText: string;
33
+ /**
34
+ * Se `true`, exibe a barra de pesquisa do filtro.
35
+ */
12
36
  useSearch: boolean;
37
+ /**
38
+ * É disparado em qualquer interação com o filtro.
39
+ */
13
40
  processModalAction: (action: ModalAction) => void;
14
41
  updateValue(id: string, value?: boolean): void;
15
42
  getActiveFiltersMsg(): string;