@sankhyalabs/sankhyablocks 9.2.0-ms.13 → 9.2.0-ms.3

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 (54) hide show
  1. package/dist/cjs/loader.cjs.js +1 -1
  2. package/dist/cjs/sankhyablocks.cjs.js +1 -1
  3. package/dist/cjs/snk-application.cjs.entry.js +3 -0
  4. package/dist/cjs/snk-filter-bar_4.cjs.entry.js +15 -25
  5. package/dist/cjs/snk-form_2.cjs.entry.js +1 -27
  6. package/dist/cjs/snk-grid.cjs.entry.js +0 -4
  7. package/dist/cjs/snk-personalized-filter.cjs.entry.js +2 -10
  8. package/dist/cjs/snk-simple-bar.cjs.entry.js +5 -5
  9. package/dist/cjs/snk-simple-crud.cjs.entry.js +8 -45
  10. package/dist/collection/components/snk-application/snk-application.js +2 -0
  11. package/dist/collection/components/snk-filter-bar/snk-filter-bar.js +63 -210
  12. package/dist/collection/components/snk-form/snk-form.js +22 -133
  13. package/dist/collection/components/snk-grid/snk-grid.js +0 -38
  14. package/dist/collection/components/snk-personalized-filter/snk-personalized-filter.js +21 -83
  15. package/dist/collection/components/snk-pesquisa/snk-pesquisa.js +14 -80
  16. package/dist/collection/components/snk-simple-bar/snk-simple-bar.js +9 -9
  17. package/dist/collection/components/snk-simple-crud/snk-simple-crud.js +119 -414
  18. package/dist/collection/components/snk-taskbar/snk-taskbar.js +36 -102
  19. package/dist/collection/lib/licenses/sankhyalicense.module.js +1 -0
  20. package/dist/components/snk-application2.js +3 -0
  21. package/dist/components/snk-filter-bar2.js +15 -26
  22. package/dist/components/snk-form.js +2 -29
  23. package/dist/components/snk-grid2.js +0 -6
  24. package/dist/components/snk-personalized-filter2.js +2 -10
  25. package/dist/components/snk-simple-bar2.js +5 -5
  26. package/dist/components/snk-simple-crud2.js +8 -45
  27. package/dist/esm/loader.js +1 -1
  28. package/dist/esm/sankhyablocks.js +1 -1
  29. package/dist/esm/snk-application.entry.js +3 -0
  30. package/dist/esm/snk-filter-bar_4.entry.js +15 -25
  31. package/dist/esm/snk-form_2.entry.js +1 -27
  32. package/dist/esm/snk-grid.entry.js +0 -4
  33. package/dist/esm/snk-personalized-filter.entry.js +2 -10
  34. package/dist/esm/snk-simple-bar.entry.js +5 -5
  35. package/dist/esm/snk-simple-crud.entry.js +8 -45
  36. package/dist/sankhyablocks/p-012208e0.entry.js +1 -0
  37. package/dist/sankhyablocks/p-81769310.entry.js +11 -0
  38. package/dist/sankhyablocks/p-a86eee47.entry.js +1 -0
  39. package/dist/sankhyablocks/p-fa18530e.entry.js +1 -0
  40. package/dist/sankhyablocks/sankhyablocks.esm.js +1 -1
  41. package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts +28 -45
  42. package/dist/types/components/snk-form/snk-form.d.ts +4 -29
  43. package/dist/types/components/snk-grid/snk-grid.d.ts +0 -5
  44. package/dist/types/components/snk-personalized-filter/snk-personalized-filter.d.ts +5 -53
  45. package/dist/types/components/snk-pesquisa/snk-pesquisa.d.ts +6 -44
  46. package/dist/types/components/snk-simple-bar/snk-simple-bar.d.ts +15 -15
  47. package/dist/types/components/snk-simple-crud/snk-simple-crud.d.ts +43 -100
  48. package/dist/types/components/snk-taskbar/snk-taskbar.d.ts +21 -23
  49. package/dist/types/components.d.ts +165 -379
  50. package/package.json +1 -1
  51. package/dist/sankhyablocks/p-51464e95.entry.js +0 -1
  52. package/dist/sankhyablocks/p-665dd170.entry.js +0 -11
  53. package/dist/sankhyablocks/p-6fa3d474.entry.js +0 -1
  54. package/dist/sankhyablocks/p-cf7063a4.entry.js +0 -1
@@ -52,7 +52,6 @@ import { IExportConfig } from "./components/snk-data-exporter/data/export-config
52
52
  import { IExpressionGroup, IExpressionItem } from "./components/snk-personalized-filter/interfaces/IExpressionItem";
53
53
  import { IPersonalizedFilter } from "./components/snk-personalized-filter/interfaces/IPersonalizedFilter";
54
54
  import { SnkApplication } from "./components/snk-application/snk-application";
55
- import { Filter as Filter1 } from "@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata";
56
55
  import { SnkFilterModalFactoryParams } from "./components/snk-filter-bar/utils/SnkFilterModalFactory";
57
56
  import { EPresentationMode } from "./components/snk-filter-bar/filter-item/editors/enum/presentationMode";
58
57
  import { FilterFieldsDataSource, IFilterField, IFilterLink } from "./components/snk-filter-field-search/interfaces";
@@ -1200,99 +1199,83 @@ export namespace Components {
1200
1199
  }
1201
1200
  interface SnkFilterBar {
1202
1201
  /**
1203
- * @description Adiciona um item de filtro.
1204
- * @async
1205
- * @param filterItem - Item a ser adicionado, caso o item já exista com o ID, ele não será adicionado novamente.
1206
- * @return Retorna uma Promise que resolve quando o item for adicionado.
1202
+ * Adiciona um item de filtro.
1203
+ * @param filterItem - Item a ser adicionado, caso o item já exista com o ID ele não será adicionado novamente
1207
1204
  */
1208
1205
  "addFilterItem": (filterItem: SnkFilterItemConfig) => Promise<void>;
1209
1206
  /**
1210
- * @description Função chamada depois de aplicar os filtros.
1207
+ * Função chamada depois de aplicar os filtros.
1211
1208
  */
1212
1209
  "afterApplyConfig"?: () => void;
1213
1210
  /**
1214
- * @description Define se a carga dos dados será feita assim que o componente for carregado.
1211
+ * Define se a carga dos dados será feita assim que o componente for carregado.
1215
1212
  */
1216
1213
  "autoLoad"?: boolean;
1217
1214
  /**
1218
- * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
1215
+ * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
1219
1216
  */
1220
1217
  "configName": string;
1221
1218
  /**
1222
- * @description Loader customizado para carregar as configurações.
1223
- * @param configName - Nome da configuração.
1224
- * @param resourceId - ID do recurso.
1225
- * @param options - Opções adicionais.
1226
- * @returns Retorna a configuração dos filtros.
1219
+ * Loader customizado para carregar as configurações
1227
1220
  */
1228
1221
  "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
1229
1222
  /**
1230
- * @description 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.
1223
+ * 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.
1231
1224
  */
1232
1225
  "dataUnit": DataUnit;
1233
1226
  /**
1234
- * @description 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).
1227
+ * 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).
1235
1228
  */
1236
1229
  "disablePersonalizedFilter": boolean;
1237
1230
  /**
1238
- * @description Define se o componente deve usar o LockManager para controle de carregamento.
1231
+ * Define se o componente deve usar o LockManager para controle de carregamento
1239
1232
  */
1240
1233
  "enableLockManagerLoadingComp"?: boolean;
1241
1234
  /**
1242
- * @description Chave da configuração legada da barra de filtros.
1235
+ * Chave da configuração legado da barra de filtros.
1243
1236
  */
1244
1237
  "filterBarLegacyConfigName": string;
1245
1238
  /**
1246
- * @description Lista todos os filtros disponíveis ao usuário.
1239
+ * Lista todos os filtros disponíveis ao usuário.
1247
1240
  */
1248
1241
  "filterConfig": Array<SnkFilterItemConfig>;
1249
1242
  /**
1250
- * @description Retorna um item de filtro pelo ID.
1251
- * @async
1252
- * @param id - ID do item de filtro.
1253
- * @returns O item de filtro correspondente ou undefined se não for encontrado.
1243
+ * Retorna um item de filtro pelo ID.
1254
1244
  */
1255
1245
  "getFilterItem": (id: string) => Promise<SnkFilterItemConfig | undefined>;
1256
- "getFilters": () => Promise<Filter1[]>;
1257
1246
  /**
1258
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
1247
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
1259
1248
  */
1260
1249
  "messagesBuilder": SnkMessageBuilder;
1261
1250
  /**
1262
- * @description Modo de apresentação da barra de filtros.
1251
+ * Modo de apresentação da filterbar.
1263
1252
  */
1264
1253
  "mode": "regular" | "button" | "hidden";
1265
1254
  /**
1266
- * @description Faz o recarregamento da barra de filtros buscando o state no servidor.
1267
- * @async
1268
- * @return Retorna uma Promise que resolve quando o recarregamento for concluído.
1255
+ * Faz o recarregamento da filterbar buscando o state no servidor.
1269
1256
  */
1270
1257
  "reload": () => Promise<void>;
1271
1258
  /**
1272
- * @description Remove um item de filtro.
1273
- * @async
1274
- * @param filterID - ID do item a ser removido.
1275
- * @returns Retorna o item de filtro removido, ou undefined caso não seja encontrado.
1259
+ * Remove um item de filtro.
1260
+ * @param filterID - ID do a ser adicionado
1261
+ * @returns - Retorna o item de filtro removido, ou undefined caso não encontrado.
1276
1262
  */
1277
1263
  "removeFilterItem": (filterID: string) => Promise<SnkFilterItemConfig | undefined>;
1278
1264
  /**
1279
- * @description Identificador de recursos como configurações e acesso.
1265
+ * Identificador de recursos como configurações e acesso.
1280
1266
  */
1281
1267
  "resourceID": string;
1282
1268
  /**
1283
- * @description Abre o modal de filtros.
1284
- * @async
1269
+ * Abre o modal de filtros
1285
1270
  */
1286
1271
  "showFilterModal": () => Promise<void>;
1287
1272
  /**
1288
- * @description Título que será apresentado na barra de filtros.
1273
+ * Título que será apresentado na barra de filtros
1289
1274
  */
1290
1275
  "title": string;
1291
1276
  /**
1292
- * @description Atualiza um item do filtro.
1293
- * @async
1294
- * @param newFilterItem - Item com as informações atualizadas, caso o item não seja encontrado no array, ele não será modificado.
1295
- * @return Retorna uma Promise que resolve quando a atualização for concluída.
1277
+ * Atualiza um item do filtro.
1278
+ * @param filterItem - Item com as informações atualizadas, caso o item não seja encontrado no array ele mão será modificado
1296
1279
  */
1297
1280
  "updateFilterItem": (newFilterItem: SnkFilterItemConfig) => Promise<void>;
1298
1281
  }
@@ -1571,11 +1554,7 @@ export namespace Components {
1571
1554
  }
1572
1555
  interface SnkForm {
1573
1556
  /**
1574
- * Registra um editor customizado para campos do formulário.
1575
- * @async
1576
- * @param fieldName - Nome do campo.
1577
- * @param customEditor - Editor customizado.
1578
- * @returns
1557
+ * Registra um editor customizado para campos da grade e formulário.
1579
1558
  */
1580
1559
  "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise<void>;
1581
1560
  /**
@@ -1583,13 +1562,11 @@ export namespace Components {
1583
1562
  */
1584
1563
  "configName": string;
1585
1564
  /**
1586
- * Chave da configuração legada do formulário.
1565
+ * Chave da configuração legado do formulário.
1587
1566
  */
1588
1567
  "formLegacyConfigName": string;
1589
1568
  /**
1590
1569
  * Fecha a janela de configurações do formulário.
1591
- * @async
1592
- * @returns
1593
1570
  */
1594
1571
  "hideConfig": () => Promise<void>;
1595
1572
  /**
@@ -1606,26 +1583,12 @@ export namespace Components {
1606
1583
  "resourceID": string;
1607
1584
  /**
1608
1585
  * Altera/adiciona uma propriedade nos metadados do campo.
1609
- * @async
1610
- * @param fieldName - Nome do campo.
1611
- * @param propName - Nome da propriedade.
1612
- * @param value - Valor da propriedade.
1613
- * @returns
1614
1586
  */
1615
1587
  "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
1616
1588
  /**
1617
1589
  * Exibe a janela de configurações do formulário.
1618
- * @async
1619
- * @returns
1620
1590
  */
1621
1591
  "showConfig": () => Promise<void>;
1622
- /**
1623
- * Valida o formulário.
1624
- * @async
1625
- * @returns
1626
- * @description Este método executa a validação do formulário, verificando se todos os campos estão preenchidos corretamente de acordo com as regras definidas. Se a validação falhar, uma exceção será lançada com os detalhes dos erros encontrados. Caso contrário, o método será resolvido sem erros.
1627
- */
1628
- "validate": () => Promise<void>;
1629
1592
  }
1630
1593
  interface SnkFormConfig {
1631
1594
  /**
@@ -1871,7 +1834,6 @@ export namespace Components {
1871
1834
  * Validador responsável por verificar a integridade dos dados de um registro.
1872
1835
  */
1873
1836
  "recordsValidator": IRecordValidator;
1874
- "refreshColumnFilterDataSource": () => Promise<void>;
1875
1837
  /**
1876
1838
  * Recarrega a configuração da grade.
1877
1839
  * @description Este método força o recarregamento da configuração da grade a partir do `ConfigStorage`. A operação é assíncrona, mas o método não aguarda sua conclusão.
@@ -1935,10 +1897,6 @@ export namespace Components {
1935
1897
  * Informa se a coluna de checkbox deve ser suprimida.
1936
1898
  */
1937
1899
  "suppressCheckboxColumn": boolean;
1938
- /**
1939
- * Informa se a grade deve suprimir o filtro de coluna.
1940
- */
1941
- "suppressFilterColumn"?: boolean;
1942
1900
  /**
1943
1901
  * Define se a grade deve suprimir a barra de rolagem horizontal.
1944
1902
  */
@@ -2090,40 +2048,28 @@ export namespace Components {
2090
2048
  }
2091
2049
  interface SnkPersonalizedFilter {
2092
2050
  /**
2093
- * Nome da configuração, utilizado para distinguir múltiplas instâncias do componente.
2094
- * @property
2051
+ * Nome da configuração. Serve para distinguir várias instâncias do componente.
2095
2052
  */
2096
2053
  "configName": string;
2097
- /**
2098
- * Cria um novo filtro personalizado caso não exista nenhum.
2099
- * @method
2100
- * @returns
2101
- */
2102
2054
  "createPersonalizedFilter": () => Promise<void>;
2103
2055
  /**
2104
- * URI da entidade utilizada para buscar os campos disponíveis para filtro.
2105
- * @property
2056
+ * Responsável por receber a URI da entidade.
2106
2057
  */
2107
2058
  "entityUri": string;
2108
2059
  /**
2109
- * Identificador do filtro a ser carregado.
2110
- * @property
2060
+ * Id do filtro que será carregado.
2111
2061
  */
2112
2062
  "filterId": string;
2113
2063
  /**
2114
- * Indica se o filtro é o filtro padrão do sistema.
2115
- * @property
2116
- * @default false
2064
+ * Define se o filtro em questão é um filtro padrão.
2117
2065
  */
2118
2066
  "isDefaultFilter": boolean;
2119
2067
  /**
2120
2068
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2121
- * @property
2122
2069
  */
2123
2070
  "messagesBuilder": SnkMessageBuilder;
2124
2071
  /**
2125
- * Identificador do recurso utilizado para salvar e recuperar filtros.
2126
- * @property
2072
+ * Nome da configuração. Serve para distinguir várias instâncias do componente.
2127
2073
  */
2128
2074
  "resourceID": string;
2129
2075
  }
@@ -2151,53 +2097,31 @@ export namespace Components {
2151
2097
  }
2152
2098
  interface SnkPesquisa {
2153
2099
  /**
2154
- * Define se permite a seleção de itens não analíticos.
2155
- * @type {boolean}
2156
- * @default false
2157
- * @example allowsNonAnalytic={true}
2100
+ * Define se permite seleção de items não analíticos
2158
2101
  */
2159
2102
  "allowsNonAnalytic": boolean;
2160
2103
  /**
2161
- * Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente.
2162
- * @type {string}
2163
- * @mutable
2164
- * @example argument="Texto para pesquisa"
2104
+ * Argumentos que serão usados ao chamar a função searchLoader.
2165
2105
  */
2166
2106
  "argument": string;
2167
2107
  /**
2168
- * Nome da entidade sobre a qual a pesquisa será realizada.
2169
- * @type {string}
2170
- * @example entityName="Produto"
2108
+ * Nome da entidade onde a pesquisa é aplicada.
2171
2109
  */
2172
2110
  "entityName": string;
2173
2111
  /**
2174
- * Define se a popup de pesquisa terá ou não modo hierárquico.
2175
- * @type {boolean}
2176
- * @default false
2177
- * @example isHierarchyEntity={true}
2112
+ * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
2178
2113
  */
2179
2114
  "isHierarchyEntity": boolean;
2180
2115
  /**
2181
- * Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados.
2182
- * @type {(text: string) => Promise<any>}
2183
- * @param text Texto utilizado como argumento de pesquisa.
2184
- * @returns Promise com os dados da pesquisa.
2185
- * @example searchLoader={(text) => fetchItems(text)}
2116
+ * Função responsável em carregar os itens do componente snk-pesquisa.
2186
2117
  */
2187
2118
  "searchLoader": (text: string) => Promise<any>;
2188
2119
  /**
2189
- * Função disparada ao selecionar um item da pesquisa.
2190
- * @type {(option: IOption) => void}
2191
- * @param option Item selecionado.
2192
- * @returns void
2193
- * @example selectItem={(option) => handleSelect(option)}
2120
+ * Função disparada ao selecionar um item.
2194
2121
  */
2195
2122
  "selectItem": (option: IOption2) => void;
2196
2123
  /**
2197
- * Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível.
2198
- * @type {(text: string) => Promise<any>}
2199
- * @param text Texto utilizado como argumento de pesquisa para a árvore.
2200
- * @returns Promise com os dados da árvore.
2124
+ * Função responsável por carregar a árvore hierárquica do componente
2201
2125
  */
2202
2126
  "treeLoader"?: (text: string) => Promise<any>;
2203
2127
  }
@@ -2216,11 +2140,11 @@ export namespace Components {
2216
2140
  }
2217
2141
  interface SnkSimpleBar {
2218
2142
  /**
2219
- * Define os itens que serão apresentados no breadcrumb.
2143
+ * Define os itens que serão apresentados pelo breadcrumb
2220
2144
  */
2221
2145
  "breadcrumbItens": Array<IBreadcrumbItem>;
2222
2146
  /**
2223
- * Define o título do header.
2147
+ * Define o título do header
2224
2148
  */
2225
2149
  "label": string;
2226
2150
  /**
@@ -2230,196 +2154,138 @@ export namespace Components {
2230
2154
  }
2231
2155
  interface SnkSimpleCrud {
2232
2156
  /**
2233
- * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
2157
+ * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
2234
2158
  */
2235
2159
  "actionsList": Array<Action>;
2236
2160
  /**
2237
- * @description Registra um editor customizado para campos da grade e do formulário.
2238
- * @param fieldName - O nome do campo.
2239
- * @param customEditor - A instância do editor customizado.
2240
- * @returns
2161
+ * Registra um editor customizado para campos da grade e formulário.
2241
2162
  */
2242
2163
  "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise<void>;
2243
2164
  /**
2244
- * @description Registra um formatador de valores para uma coluna da grade.
2245
- * @param columnName - O nome da coluna.
2246
- * @param customFormatter - A instância do formatador customizado.
2247
- * @returns
2165
+ * Registra um formatador de valores para uma coluna da grid.
2248
2166
  */
2249
2167
  "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise<void>;
2250
2168
  /**
2251
- * @description Registra um renderizador customizado para colunas da grade.
2252
- * @param fieldName - O nome do campo.
2253
- * @param customRender - A instância do renderizador customizado.
2254
- * @returns
2169
+ * Registra um render customizado para colunas da grid.
2255
2170
  */
2256
2171
  "addGridCustomRender": (fieldName: string, customRender: ICustomRender) => Promise<void>;
2257
2172
  /**
2258
- * @description Define se a grade será focada ao ser carregada.
2173
+ * Define se a grid será focada ao ser carregada.
2259
2174
  */
2260
2175
  "autoFocus"?: boolean;
2261
2176
  /**
2262
- * @description Define se a carga dos dados será feita assim que o componente for carregado.
2177
+ * Define se a carga dos dados será feita assim que o componente for carregado.
2263
2178
  */
2264
2179
  "autoLoad"?: boolean;
2265
2180
  /**
2266
- * @description Usado para fechar o configurador do CRUD.
2267
- * @returns
2181
+ * Usado para fechar o configurator do CRUD
2268
2182
  */
2269
2183
  "closeConfigurator": () => Promise<void>;
2270
2184
  /**
2271
- * @description Usado para salvar as configurações dos blocos de construção.
2185
+ * Usado para salvar as configurações dos blocos de construção.
2272
2186
  */
2273
2187
  "configName": string;
2274
- /**
2275
- * @description Estado atual dos dados.
2276
- */
2277
2188
  "dataState": DataState1;
2278
- /**
2279
- * @description Instância do DataUnit a ser utilizada pelo componente.
2280
- */
2281
2189
  "dataUnit": DataUnit;
2282
2190
  /**
2283
- * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade).
2191
+ * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
2284
2192
  */
2285
2193
  "domainMessagesBuilder": string;
2286
- /**
2287
- * @description Habilita a inserção contínua de registros.
2288
- */
2289
2194
  "enableContinuousInsert": boolean;
2290
2195
  /**
2291
- * @description Ativa a inserção de registros no modo grade.
2196
+ * Ativa inserção de registros no modo grade.
2292
2197
  */
2293
2198
  "enableGridInsert"?: boolean;
2294
2199
  /**
2295
- * @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
2200
+ * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
2296
2201
  */
2297
2202
  "enableLockManagerLoadingComp"?: boolean;
2298
2203
  /**
2299
- * @description Ativa o gerenciamento de locks na grade pela Taskbar.
2204
+ * Ativa o gerenciamento de locks na grade pela Taskbar.
2300
2205
  */
2301
2206
  "enableLockManagerTaskbarClick"?: boolean;
2302
2207
  /**
2303
- * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD.
2208
+ * Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD
2304
2209
  */
2305
2210
  "entityName": string;
2306
- /**
2307
- * @description Configuração do formulário.
2308
- */
2309
2211
  "formConfig": IFormConfig;
2310
2212
  /**
2311
- * @description Chave da configuração legada do formulário.
2213
+ * Chave da configuração legado do formulário.
2312
2214
  */
2313
2215
  "formLegacyConfigName": string;
2314
- /**
2315
- * @description Obtém os registros do DataUnit.
2316
- * @returns Uma promessa que resolve com a lista de registros.
2317
- */
2318
2216
  "getRecords": () => Promise<Array<Record>>;
2319
2217
  /**
2320
- * @description Usado para alternar a visão entre GRID e FORM externamente.
2321
- * @param view - A visão para a qual navegar.
2322
- * @returns
2218
+ * Usado para alternar a visão entre GRID e FORM externamente.
2323
2219
  */
2324
2220
  "goToView": (view: VIEW_MODE) => Promise<void>;
2325
- /**
2326
- * @description Configuração da grade.
2327
- */
2328
2221
  "gridConfig": IGridConfig;
2329
2222
  /**
2330
- * @description Chave da configuração legada da grade.
2223
+ * Chave da configuração legado da grade.
2331
2224
  */
2332
2225
  "gridLegacyConfigName": string;
2333
2226
  /**
2334
- * @description Ignora os campos "somente leitura" no modo de inserção.
2227
+ * Ignora os campos "somente leitura" no modo de inserção.
2335
2228
  */
2336
2229
  "ignoreReadOnlyFormFields": boolean;
2337
2230
  /**
2338
- * @description Define se o LayoutFormConfig será exibido no configurador.
2231
+ * Define se o LayoutFormConfig será exibido no configurador.
2339
2232
  */
2340
2233
  "layoutFormConfig": boolean;
2341
2234
  /**
2342
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2235
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2343
2236
  */
2344
2237
  "messagesBuilder": SnkMessageBuilder;
2345
- /**
2346
- * @description Define o modo de operação do CRUD (servidor ou em memória).
2347
- */
2348
2238
  "mode": SIMPLE_CRUD_MODE;
2349
2239
  /**
2350
- * @description Habilita a edição de múltiplos registros simultâneos.
2240
+ * Habilita a edição de múltiplos registros simultâneos.
2351
2241
  */
2352
2242
  "multipleEditionEnabled": boolean;
2353
2243
  /**
2354
- * @description Determina se pode haver mais de uma linha selecionada na grade.
2244
+ * Determina se pode haver mais de uma linha selecionada na grade.
2355
2245
  */
2356
2246
  "multipleSelection": boolean;
2357
2247
  /**
2358
- * @description Usado para abrir o configurador do CRUD.
2359
- * @returns
2248
+ * Usado para abrir o configurator do CRUD
2360
2249
  */
2361
2250
  "openConfigurator": () => Promise<void>;
2362
2251
  /**
2363
- * @description Altera visualmente as sombras e bordas do componente. Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout). Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up).
2252
+ * Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
2364
2253
  */
2365
2254
  "outlineMode"?: boolean;
2366
2255
  /**
2367
- * @description Determina quantas linhas são retornadas por página.
2256
+ * Determina quantas linhas são retornadas por página.
2368
2257
  */
2369
2258
  "pageSize": number;
2370
2259
  /**
2371
- * @description Define o modo de exibição do contador de paginação.
2260
+ * Define se a grid será focada ao ser carregada.
2372
2261
  */
2373
2262
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
2374
2263
  /**
2375
- * @description Remove o formatador de valores de uma coluna da grade.
2376
- * @param columnName - O nome da coluna.
2377
- * @returns
2264
+ * Remove o formatador de valores de uma coluna da grid.
2378
2265
  */
2379
2266
  "removeCustomValueFormatter": (columnName: string) => Promise<void>;
2380
2267
  /**
2381
- * @description Identificador de recursos como configurações e acesso.
2268
+ * Identificador de recursos como configurações e acesso.
2382
2269
  */
2383
2270
  "resourceID": string;
2384
2271
  /**
2385
- * @description Altera/adiciona uma propriedade nos metadados do campo.
2386
- * @param fieldName - O nome do campo.
2387
- * @param propName - O nome da propriedade.
2388
- * @param value - O valor da propriedade.
2389
- * @returns
2272
+ * Altera/adiciona uma propriedade nos metadados do campo.
2390
2273
  */
2391
2274
  "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
2392
- /**
2393
- * @description Define os metadados do DataUnit.
2394
- * @param metadata - Os metadados a serem definidos.
2395
- * @returns
2396
- */
2397
2275
  "setMetadata": (metadata: UnitMetadata) => Promise<void>;
2398
- /**
2399
- * @description Define os registros do DataUnit.
2400
- * @param records - Os registros a serem definidos.
2401
- * @returns
2402
- */
2403
2276
  "setRecords": (records: Array<Record>) => Promise<void>;
2404
2277
  /**
2405
- * @description Usado para exibir os botões de ação do snk-configurator.
2278
+ * Usado para exibir os botões de ação do snk-configurator.
2406
2279
  */
2407
2280
  "showConfiguratorButtons": boolean;
2408
2281
  /**
2409
- * @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
2282
+ * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
2410
2283
  */
2411
2284
  "taskbarManager": TaskbarManager;
2412
- /**
2413
- * @description Atualiza a configuração do formulário.
2414
- * @returns
2415
- */
2416
2285
  "updateConfig": () => Promise<void>;
2417
- /**
2418
- * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
2419
- */
2420
2286
  "useCancelConfirm": boolean;
2421
2287
  /**
2422
- * @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
2288
+ * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
2423
2289
  */
2424
2290
  "useEnterLikeTab": boolean;
2425
2291
  }
@@ -2443,64 +2309,63 @@ export namespace Components {
2443
2309
  }
2444
2310
  interface SnkTaskbar {
2445
2311
  /**
2446
- * @description Lista de ações a serem exibidas no botão "Mais opções".
2312
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
2447
2313
  */
2448
2314
  "actionsList": Array<Action>;
2449
2315
  /**
2450
- * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
2316
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
2451
2317
  */
2452
2318
  "actionsSettingsList": Array<Action>;
2453
2319
  /**
2454
- * @description Define o alinhamento dos itens da barra de tarefas à direita.
2320
+ * Usado para determinar O alinhamento dos items na taskbar.
2455
2321
  */
2456
2322
  "alignRigth": boolean;
2457
2323
  /**
2458
- * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas.
2324
+ * Lista separada por virgula, contendo todos os elementos a serem criados.
2459
2325
  */
2460
2326
  "buttons": string;
2461
2327
  /**
2462
- * @description Nome da configuração usada para salvar ou recuperar as configurações do formulário. Também é utilizado como fallback para a chave de armazenamento do exportador de dados.
2328
+ * Usado para guardar ou recuperar as configurações do formulário.
2463
2329
  */
2464
2330
  "configName": string;
2465
2331
  /**
2466
- * @description Mapa com definições de botões personalizados. A chave do mapa deve ser informada na propriedade `buttons` no local onde o botão deve ser renderizado.
2332
+ * 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.
2467
2333
  */
2468
2334
  "customButtons": Map<string, CustomButton>;
2469
2335
  /**
2470
- * @description Define o identificador do contêiner na DOM que é responsável por guardar os elementos personalizados que não podem ser passados por slot.
2471
- * @example Elementos customizados na Taskbar da aba de detalhes.
2336
+ * Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados que não podem ser passados por slot. Exemplo: Elementos customizados na Taskbar da aba de detalhes.
2472
2337
  */
2473
2338
  "customContainerId": string;
2474
2339
  /**
2475
- * @description Define o identificador do slot que recebe elementos personalizados.
2340
+ * Usado para determinar o identificador do slot que recebe elementos personalizados.
2476
2341
  */
2477
2342
  "customSlotId": string;
2478
2343
  /**
2479
- * @description Instância do `DataUnit` com a qual a barra de tarefas irá interagir para realizar operações de dados (ex: salvar, próximo, anterior).
2344
+ * Instância do DataUnit.
2480
2345
  */
2481
2346
  "dataUnit": DataUnit;
2482
2347
  /**
2483
- * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
2348
+ * Array contendo todos os botões a serem desabilitados.
2484
2349
  */
2485
2350
  "disabledButtons": Array<string>;
2486
2351
  /**
2487
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2352
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2488
2353
  */
2489
2354
  "messagesBuilder": SnkMessageBuilder;
2490
2355
  /**
2491
- * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens.
2356
+ * Define como será o comportamento da taskbar quando ocorrer overflow
2492
2357
  */
2493
2358
  "overflowStrategy": 'hiddenItems' | 'none';
2494
2359
  /**
2495
- * @description Altera o modo de apresentação dos botões da barra de tarefas.
2360
+ * Altera o modo de apresentação dos botões do snk-taskbar.
2496
2361
  */
2497
2362
  "presentationMode": PresentationMode1;
2498
2363
  /**
2499
- * @description Define qual botão deve ter a aparência de destaque (primário).
2364
+ * Determina qual botão deve ter aparência primária.
2500
2365
  */
2501
2366
  "primaryButton": string;
2502
2367
  /**
2503
- * @description Identificador de recursos, como configurações e permissões de acesso.
2368
+ * Identificador de recursos como configurações e acesso.
2504
2369
  */
2505
2370
  "resourceID": string;
2506
2371
  }
@@ -3954,65 +3819,56 @@ declare namespace LocalJSX {
3954
3819
  }
3955
3820
  interface SnkFilterBar {
3956
3821
  /**
3957
- * @description Função chamada depois de aplicar os filtros.
3822
+ * Função chamada depois de aplicar os filtros.
3958
3823
  */
3959
3824
  "afterApplyConfig"?: () => void;
3960
3825
  /**
3961
- * @description Define se a carga dos dados será feita assim que o componente for carregado.
3826
+ * Define se a carga dos dados será feita assim que o componente for carregado.
3962
3827
  */
3963
3828
  "autoLoad"?: boolean;
3964
3829
  /**
3965
- * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
3830
+ * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
3966
3831
  */
3967
3832
  "configName"?: string;
3968
3833
  /**
3969
- * @description Loader customizado para carregar as configurações.
3970
- * @param configName - Nome da configuração.
3971
- * @param resourceId - ID do recurso.
3972
- * @param options - Opções adicionais.
3973
- * @returns Retorna a configuração dos filtros.
3834
+ * Loader customizado para carregar as configurações
3974
3835
  */
3975
3836
  "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
3976
3837
  /**
3977
- * @description 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.
3838
+ * 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.
3978
3839
  */
3979
3840
  "dataUnit"?: DataUnit;
3980
3841
  /**
3981
- * @description 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).
3842
+ * 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).
3982
3843
  */
3983
3844
  "disablePersonalizedFilter"?: boolean;
3984
3845
  /**
3985
- * @description Define se o componente deve usar o LockManager para controle de carregamento.
3846
+ * Define se o componente deve usar o LockManager para controle de carregamento
3986
3847
  */
3987
3848
  "enableLockManagerLoadingComp"?: boolean;
3988
3849
  /**
3989
- * @description Chave da configuração legada da barra de filtros.
3850
+ * Chave da configuração legado da barra de filtros.
3990
3851
  */
3991
3852
  "filterBarLegacyConfigName"?: string;
3992
3853
  /**
3993
- * @description Lista todos os filtros disponíveis ao usuário.
3854
+ * Lista todos os filtros disponíveis ao usuário.
3994
3855
  */
3995
3856
  "filterConfig"?: Array<SnkFilterItemConfig>;
3996
3857
  /**
3997
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
3858
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
3998
3859
  */
3999
3860
  "messagesBuilder"?: SnkMessageBuilder;
4000
3861
  /**
4001
- * @description Modo de apresentação da barra de filtros.
3862
+ * Modo de apresentação da filterbar.
4002
3863
  */
4003
3864
  "mode"?: "regular" | "button" | "hidden";
4004
- /**
4005
- * @description Evento emitido quando a configuração dos filtros é atualizada.
4006
- * @param configs - Lista de configurações de filtros atualizadas.
4007
- * @event
4008
- */
4009
3865
  "onConfigUpdated"?: (event: SnkFilterBarCustomEvent<SnkFilterItemConfig[]>) => void;
4010
3866
  /**
4011
- * @description Identificador de recursos como configurações e acesso.
3867
+ * Identificador de recursos como configurações e acesso.
4012
3868
  */
4013
3869
  "resourceID"?: string;
4014
3870
  /**
4015
- * @description Título que será apresentado na barra de filtros.
3871
+ * Título que será apresentado na barra de filtros
4016
3872
  */
4017
3873
  "title"?: string;
4018
3874
  }
@@ -4291,7 +4147,7 @@ declare namespace LocalJSX {
4291
4147
  */
4292
4148
  "configName"?: string;
4293
4149
  /**
4294
- * Chave da configuração legada do formulário.
4150
+ * Chave da configuração legado do formulário.
4295
4151
  */
4296
4152
  "formLegacyConfigName"?: string;
4297
4153
  /**
@@ -4299,15 +4155,15 @@ declare namespace LocalJSX {
4299
4155
  */
4300
4156
  "messagesBuilder"?: SnkMessageBuilder;
4301
4157
  /**
4302
- * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
4158
+ * Emitido sempre que houver click de botão ou ação.
4303
4159
  */
4304
4160
  "onActionClick"?: (event: SnkFormCustomEvent<string>) => void;
4305
4161
  /**
4306
- * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
4162
+ * Emitido quando o botão de voltar é acionado.
4307
4163
  */
4308
4164
  "onExit"?: (event: SnkFormCustomEvent<void>) => void;
4309
4165
  /**
4310
- * Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view
4166
+ * Responsável por notificar quando ocorrer a renderização de itens do formulário.
4311
4167
  */
4312
4168
  "onFormItemsReady"?: (event: SnkFormCustomEvent<Array<HTMLElement>>) => void;
4313
4169
  /**
@@ -4564,10 +4420,6 @@ declare namespace LocalJSX {
4564
4420
  * Informa se a coluna de checkbox deve ser suprimida.
4565
4421
  */
4566
4422
  "suppressCheckboxColumn"?: boolean;
4567
- /**
4568
- * Informa se a grade deve suprimir o filtro de coluna.
4569
- */
4570
- "suppressFilterColumn"?: boolean;
4571
4423
  /**
4572
4424
  * Define se a grade deve suprimir a barra de rolagem horizontal.
4573
4425
  */
@@ -4718,49 +4570,30 @@ declare namespace LocalJSX {
4718
4570
  }
4719
4571
  interface SnkPersonalizedFilter {
4720
4572
  /**
4721
- * Nome da configuração, utilizado para distinguir múltiplas instâncias do componente.
4722
- * @property
4573
+ * Nome da configuração. Serve para distinguir várias instâncias do componente.
4723
4574
  */
4724
4575
  "configName"?: string;
4725
4576
  /**
4726
- * URI da entidade utilizada para buscar os campos disponíveis para filtro.
4727
- * @property
4577
+ * Responsável por receber a URI da entidade.
4728
4578
  */
4729
4579
  "entityUri"?: string;
4730
4580
  /**
4731
- * Identificador do filtro a ser carregado.
4732
- * @property
4581
+ * Id do filtro que será carregado.
4733
4582
  */
4734
4583
  "filterId"?: string;
4735
4584
  /**
4736
- * Indica se o filtro é o filtro padrão do sistema.
4737
- * @property
4738
- * @default false
4585
+ * Define se o filtro em questão é um filtro padrão.
4739
4586
  */
4740
4587
  "isDefaultFilter"?: boolean;
4741
4588
  /**
4742
4589
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4743
- * @property
4744
4590
  */
4745
4591
  "messagesBuilder"?: SnkMessageBuilder;
4746
- /**
4747
- * Evento emitido após salvar as alterações do filtro personalizado.
4748
- * @event
4749
- */
4750
4592
  "onEzAfterSave"?: (event: SnkPersonalizedFilterCustomEvent<void>) => void;
4751
- /**
4752
- * Evento emitido ao cancelar a personalização do filtro.
4753
- * @event
4754
- */
4755
4593
  "onEzCancel"?: (event: SnkPersonalizedFilterCustomEvent<void>) => void;
4756
- /**
4757
- * Evento emitido ao salvar as alterações do filtro personalizado.
4758
- * @event
4759
- */
4760
4594
  "onEzSave"?: (event: SnkPersonalizedFilterCustomEvent<string>) => void;
4761
4595
  /**
4762
- * Identificador do recurso utilizado para salvar e recuperar filtros.
4763
- * @property
4596
+ * Nome da configuração. Serve para distinguir várias instâncias do componente.
4764
4597
  */
4765
4598
  "resourceID"?: string;
4766
4599
  }
@@ -4791,53 +4624,31 @@ declare namespace LocalJSX {
4791
4624
  }
4792
4625
  interface SnkPesquisa {
4793
4626
  /**
4794
- * Define se permite a seleção de itens não analíticos.
4795
- * @type {boolean}
4796
- * @default false
4797
- * @example allowsNonAnalytic={true}
4627
+ * Define se permite seleção de items não analíticos
4798
4628
  */
4799
4629
  "allowsNonAnalytic"?: boolean;
4800
4630
  /**
4801
- * Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente.
4802
- * @type {string}
4803
- * @mutable
4804
- * @example argument="Texto para pesquisa"
4631
+ * Argumentos que serão usados ao chamar a função searchLoader.
4805
4632
  */
4806
4633
  "argument"?: string;
4807
4634
  /**
4808
- * Nome da entidade sobre a qual a pesquisa será realizada.
4809
- * @type {string}
4810
- * @example entityName="Produto"
4635
+ * Nome da entidade onde a pesquisa é aplicada.
4811
4636
  */
4812
4637
  "entityName"?: string;
4813
4638
  /**
4814
- * Define se a popup de pesquisa terá ou não modo hierárquico.
4815
- * @type {boolean}
4816
- * @default false
4817
- * @example isHierarchyEntity={true}
4639
+ * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
4818
4640
  */
4819
4641
  "isHierarchyEntity"?: boolean;
4820
4642
  /**
4821
- * Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados.
4822
- * @type {(text: string) => Promise<any>}
4823
- * @param text Texto utilizado como argumento de pesquisa.
4824
- * @returns Promise com os dados da pesquisa.
4825
- * @example searchLoader={(text) => fetchItems(text)}
4643
+ * Função responsável em carregar os itens do componente snk-pesquisa.
4826
4644
  */
4827
4645
  "searchLoader"?: (text: string) => Promise<any>;
4828
4646
  /**
4829
- * Função disparada ao selecionar um item da pesquisa.
4830
- * @type {(option: IOption) => void}
4831
- * @param option Item selecionado.
4832
- * @returns void
4833
- * @example selectItem={(option) => handleSelect(option)}
4647
+ * Função disparada ao selecionar um item.
4834
4648
  */
4835
4649
  "selectItem"?: (option: IOption2) => void;
4836
4650
  /**
4837
- * Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível.
4838
- * @type {(text: string) => Promise<any>}
4839
- * @param text Texto utilizado como argumento de pesquisa para a árvore.
4840
- * @returns Promise com os dados da árvore.
4651
+ * Função responsável por carregar a árvore hierárquica do componente
4841
4652
  */
4842
4653
  "treeLoader"?: (text: string) => Promise<any>;
4843
4654
  }
@@ -4859,11 +4670,11 @@ declare namespace LocalJSX {
4859
4670
  }
4860
4671
  interface SnkSimpleBar {
4861
4672
  /**
4862
- * Define os itens que serão apresentados no breadcrumb.
4673
+ * Define os itens que serão apresentados pelo breadcrumb
4863
4674
  */
4864
4675
  "breadcrumbItens"?: Array<IBreadcrumbItem>;
4865
4676
  /**
4866
- * Define o título do header.
4677
+ * Define o título do header
4867
4678
  */
4868
4679
  "label"?: string;
4869
4680
  /**
@@ -4871,157 +4682,136 @@ declare namespace LocalJSX {
4871
4682
  */
4872
4683
  "messagesBuilder"?: SnkMessageBuilder;
4873
4684
  /**
4874
- * Emitido quando algum item do breadcrumb é clicado.
4685
+ * Emitido quando algum item do breadcrumb é clicado
4875
4686
  */
4876
4687
  "onClickBreadcrumbItem"?: (event: SnkSimpleBarCustomEvent<IBreadcrumbItem>) => void;
4877
4688
  /**
4878
- * Emitido quando o botão "voltar" é acionado.
4689
+ * Emitido quando o botão voltar é acionado
4879
4690
  */
4880
4691
  "onExit"?: (event: SnkSimpleBarCustomEvent<void>) => void;
4881
4692
  }
4882
4693
  interface SnkSimpleCrud {
4883
4694
  /**
4884
- * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
4695
+ * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
4885
4696
  */
4886
4697
  "actionsList"?: Array<Action>;
4887
4698
  /**
4888
- * @description Define se a grade será focada ao ser carregada.
4699
+ * Define se a grid será focada ao ser carregada.
4889
4700
  */
4890
4701
  "autoFocus"?: boolean;
4891
4702
  /**
4892
- * @description Define se a carga dos dados será feita assim que o componente for carregado.
4703
+ * Define se a carga dos dados será feita assim que o componente for carregado.
4893
4704
  */
4894
4705
  "autoLoad"?: boolean;
4895
4706
  /**
4896
- * @description Usado para salvar as configurações dos blocos de construção.
4707
+ * Usado para salvar as configurações dos blocos de construção.
4897
4708
  */
4898
4709
  "configName"?: string;
4899
- /**
4900
- * @description Estado atual dos dados.
4901
- */
4902
4710
  "dataState"?: DataState1;
4903
- /**
4904
- * @description Instância do DataUnit a ser utilizada pelo componente.
4905
- */
4906
4711
  "dataUnit"?: DataUnit;
4907
4712
  /**
4908
- * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade).
4713
+ * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
4909
4714
  */
4910
4715
  "domainMessagesBuilder"?: string;
4911
- /**
4912
- * @description Habilita a inserção contínua de registros.
4913
- */
4914
4716
  "enableContinuousInsert"?: boolean;
4915
4717
  /**
4916
- * @description Ativa a inserção de registros no modo grade.
4718
+ * Ativa inserção de registros no modo grade.
4917
4719
  */
4918
4720
  "enableGridInsert"?: boolean;
4919
4721
  /**
4920
- * @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
4722
+ * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
4921
4723
  */
4922
4724
  "enableLockManagerLoadingComp"?: boolean;
4923
4725
  /**
4924
- * @description Ativa o gerenciamento de locks na grade pela Taskbar.
4726
+ * Ativa o gerenciamento de locks na grade pela Taskbar.
4925
4727
  */
4926
4728
  "enableLockManagerTaskbarClick"?: boolean;
4927
4729
  /**
4928
- * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD.
4730
+ * Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD
4929
4731
  */
4930
4732
  "entityName"?: string;
4931
- /**
4932
- * @description Configuração do formulário.
4933
- */
4934
4733
  "formConfig"?: IFormConfig;
4935
4734
  /**
4936
- * @description Chave da configuração legada do formulário.
4735
+ * Chave da configuração legado do formulário.
4937
4736
  */
4938
4737
  "formLegacyConfigName"?: string;
4939
- /**
4940
- * @description Configuração da grade.
4941
- */
4942
4738
  "gridConfig"?: IGridConfig;
4943
4739
  /**
4944
- * @description Chave da configuração legada da grade.
4740
+ * Chave da configuração legado da grade.
4945
4741
  */
4946
4742
  "gridLegacyConfigName"?: string;
4947
4743
  /**
4948
- * @description Ignora os campos "somente leitura" no modo de inserção.
4744
+ * Ignora os campos "somente leitura" no modo de inserção.
4949
4745
  */
4950
4746
  "ignoreReadOnlyFormFields"?: boolean;
4951
4747
  /**
4952
- * @description Define se o LayoutFormConfig será exibido no configurador.
4748
+ * Define se o LayoutFormConfig será exibido no configurador.
4953
4749
  */
4954
4750
  "layoutFormConfig"?: boolean;
4955
4751
  /**
4956
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4752
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4957
4753
  */
4958
4754
  "messagesBuilder"?: SnkMessageBuilder;
4959
- /**
4960
- * @description Define o modo de operação do CRUD (servidor ou em memória).
4961
- */
4962
4755
  "mode"?: SIMPLE_CRUD_MODE;
4963
4756
  /**
4964
- * @description Habilita a edição de múltiplos registros simultâneos.
4757
+ * Habilita a edição de múltiplos registros simultâneos.
4965
4758
  */
4966
4759
  "multipleEditionEnabled"?: boolean;
4967
4760
  /**
4968
- * @description Determina se pode haver mais de uma linha selecionada na grade.
4761
+ * Determina se pode haver mais de uma linha selecionada na grade.
4969
4762
  */
4970
4763
  "multipleSelection"?: boolean;
4971
4764
  /**
4972
- * @description Emitido sempre que houver clique de botão ou ação na barra de tarefas.
4765
+ * Emitido sempre que houver click de botão ou ação.
4973
4766
  */
4974
4767
  "onActionClick"?: (event: SnkSimpleCrudCustomEvent<string>) => void;
4975
4768
  /**
4976
- * @description Emitido quando o salvamento da configuração no configurador do CRUD é cancelado.
4769
+ * Emitido quando cancela o salvamento da configuração no configurator do CRUD.
4977
4770
  */
4978
4771
  "onConfiguratorCancel"?: (event: SnkSimpleCrudCustomEvent<any>) => void;
4979
4772
  /**
4980
- * @description Emitido quando a configuração no configurador do CRUD é salva.
4773
+ * Emitido quando salva a configuração no configurator do CRUD.
4981
4774
  */
4982
4775
  "onConfiguratorSave"?: (event: SnkSimpleCrudCustomEvent<any>) => void;
4983
4776
  /**
4984
- * @description Emitido quando há qualquer mudança de estado no DataUnit.
4777
+ * Emitido quando há qualquer mudança de estado no DataUnit.
4985
4778
  */
4986
4779
  "onDataStateChange"?: (event: SnkSimpleCrudCustomEvent<DataState1>) => void;
4987
4780
  /**
4988
- * @description Emitido quando o DataUnit está pronto.
4781
+ * Emitido quando o DataUnit está pronto.
4989
4782
  */
4990
4783
  "onDataUnitReady"?: (event: SnkSimpleCrudCustomEvent<DataUnit>) => void;
4991
4784
  /**
4992
- * @description Responsável por notificar quando ocorrer a renderização de itens do formulário.
4785
+ * Responsável por notificar quando ocorrer a renderização de itens do formulário.
4993
4786
  */
4994
4787
  "onFormItemsReady"?: (event: SnkSimpleCrudCustomEvent<Array<HTMLElement>>) => void;
4995
4788
  /**
4996
- * @description Altera visualmente as sombras e bordas do componente. Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout). Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up).
4789
+ * Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
4997
4790
  */
4998
4791
  "outlineMode"?: boolean;
4999
4792
  /**
5000
- * @description Determina quantas linhas são retornadas por página.
4793
+ * Determina quantas linhas são retornadas por página.
5001
4794
  */
5002
4795
  "pageSize"?: number;
5003
4796
  /**
5004
- * @description Define o modo de exibição do contador de paginação.
4797
+ * Define se a grid será focada ao ser carregada.
5005
4798
  */
5006
4799
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
5007
4800
  /**
5008
- * @description Identificador de recursos como configurações e acesso.
4801
+ * Identificador de recursos como configurações e acesso.
5009
4802
  */
5010
4803
  "resourceID"?: string;
5011
4804
  /**
5012
- * @description Usado para exibir os botões de ação do snk-configurator.
4805
+ * Usado para exibir os botões de ação do snk-configurator.
5013
4806
  */
5014
4807
  "showConfiguratorButtons"?: boolean;
5015
4808
  /**
5016
- * @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
4809
+ * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
5017
4810
  */
5018
4811
  "taskbarManager"?: TaskbarManager;
5019
- /**
5020
- * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
5021
- */
5022
4812
  "useCancelConfirm"?: boolean;
5023
4813
  /**
5024
- * @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
4814
+ * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
5025
4815
  */
5026
4816
  "useEnterLikeTab"?: boolean;
5027
4817
  }
@@ -5042,79 +4832,75 @@ declare namespace LocalJSX {
5042
4832
  }
5043
4833
  interface SnkTaskbar {
5044
4834
  /**
5045
- * @description Lista de ações a serem exibidas no botão "Mais opções".
4835
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
5046
4836
  */
5047
4837
  "actionsList"?: Array<Action>;
5048
4838
  /**
5049
- * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
4839
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
5050
4840
  */
5051
4841
  "actionsSettingsList"?: Array<Action>;
5052
4842
  /**
5053
- * @description Define o alinhamento dos itens da barra de tarefas à direita.
4843
+ * Usado para determinar O alinhamento dos items na taskbar.
5054
4844
  */
5055
4845
  "alignRigth"?: boolean;
5056
4846
  /**
5057
- * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas.
4847
+ * Lista separada por virgula, contendo todos os elementos a serem criados.
5058
4848
  */
5059
4849
  "buttons"?: string;
5060
4850
  /**
5061
- * @description Nome da configuração usada para salvar ou recuperar as configurações do formulário. Também é utilizado como fallback para a chave de armazenamento do exportador de dados.
4851
+ * Usado para guardar ou recuperar as configurações do formulário.
5062
4852
  */
5063
4853
  "configName"?: string;
5064
4854
  /**
5065
- * @description Mapa com definições de botões personalizados. A chave do mapa deve ser informada na propriedade `buttons` no local onde o botão deve ser renderizado.
4855
+ * 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.
5066
4856
  */
5067
4857
  "customButtons"?: Map<string, CustomButton>;
5068
4858
  /**
5069
- * @description Define o identificador do contêiner na DOM que é responsável por guardar os elementos personalizados que não podem ser passados por slot.
5070
- * @example Elementos customizados na Taskbar da aba de detalhes.
4859
+ * Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados que não podem ser passados por slot. Exemplo: Elementos customizados na Taskbar da aba de detalhes.
5071
4860
  */
5072
4861
  "customContainerId"?: string;
5073
4862
  /**
5074
- * @description Define o identificador do slot que recebe elementos personalizados.
4863
+ * Usado para determinar o identificador do slot que recebe elementos personalizados.
5075
4864
  */
5076
4865
  "customSlotId"?: string;
5077
4866
  /**
5078
- * @description Instância do `DataUnit` com a qual a barra de tarefas irá interagir para realizar operações de dados (ex: salvar, próximo, anterior).
4867
+ * Instância do DataUnit.
5079
4868
  */
5080
4869
  "dataUnit"?: DataUnit;
5081
4870
  /**
5082
- * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
4871
+ * Array contendo todos os botões a serem desabilitados.
5083
4872
  */
5084
4873
  "disabledButtons"?: Array<string>;
5085
4874
  /**
5086
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4875
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
5087
4876
  */
5088
4877
  "messagesBuilder"?: SnkMessageBuilder;
5089
4878
  /**
5090
- * @description Emitido sempre que um botão ou uma ação da barra de tarefas é clicado.
5091
- * @eventProperty
4879
+ * Emitido sempre que houver click de botão ou ação.
5092
4880
  */
5093
4881
  "onActionClick"?: (event: SnkTaskbarCustomEvent<string>) => void;
5094
4882
  /**
5095
- * @description Emitido quando uma ação de salvar é iniciada pela barra de tarefas, indicando um estado de bloqueio para evitar ações concorrentes.
5096
- * @eventProperty
4883
+ * Emitido sempre que um save é iniciado pela taskbar.
5097
4884
  */
5098
4885
  "onTaskbarSaveLocker"?: (event: SnkTaskbarCustomEvent<void>) => void;
5099
4886
  /**
5100
- * @description Emitido quando a ação de salvar é concluída ou cancelada, liberando o estado de bloqueio.
5101
- * @eventProperty
4887
+ * Emitido sempre que o ocorre alguma action que libera o save.
5102
4888
  */
5103
4889
  "onTaskbarSaveUnlocker"?: (event: SnkTaskbarCustomEvent<void>) => void;
5104
4890
  /**
5105
- * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens.
4891
+ * Define como será o comportamento da taskbar quando ocorrer overflow
5106
4892
  */
5107
4893
  "overflowStrategy"?: 'hiddenItems' | 'none';
5108
4894
  /**
5109
- * @description Altera o modo de apresentação dos botões da barra de tarefas.
4895
+ * Altera o modo de apresentação dos botões do snk-taskbar.
5110
4896
  */
5111
4897
  "presentationMode"?: PresentationMode1;
5112
4898
  /**
5113
- * @description Define qual botão deve ter a aparência de destaque (primário).
4899
+ * Determina qual botão deve ter aparência primária.
5114
4900
  */
5115
4901
  "primaryButton"?: string;
5116
4902
  /**
5117
- * @description Identificador de recursos, como configurações e permissões de acesso.
4903
+ * Identificador de recursos como configurações e acesso.
5118
4904
  */
5119
4905
  "resourceID"?: string;
5120
4906
  }