@sankhyalabs/sankhyablocks 9.2.0-dev.9 → 9.2.0-ms.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 (46) 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 +1 -6
  4. package/dist/cjs/snk-data-exporter.cjs.entry.js +1 -1
  5. package/dist/cjs/{snk-data-unit-72715da9.js → snk-data-unit-448fce74.js} +1 -11
  6. package/dist/cjs/snk-data-unit.cjs.entry.js +1 -1
  7. package/dist/cjs/snk-filter-bar_4.cjs.entry.js +15 -22
  8. package/dist/cjs/snk-form_2.cjs.entry.js +1 -27
  9. package/dist/cjs/snk-grid.cjs.entry.js +7 -52
  10. package/dist/collection/components/snk-application/snk-application.js +19 -39
  11. package/dist/collection/components/snk-data-unit/snk-data-unit.js +28 -173
  12. package/dist/collection/components/snk-filter-bar/snk-filter-bar.js +63 -187
  13. package/dist/collection/components/snk-form/snk-form.js +22 -133
  14. package/dist/collection/components/snk-grid/snk-grid.js +85 -319
  15. package/dist/collection/components/snk-taskbar/snk-taskbar.js +36 -102
  16. package/dist/components/snk-application2.js +1 -6
  17. package/dist/components/snk-data-unit2.js +1 -11
  18. package/dist/components/snk-filter-bar2.js +15 -22
  19. package/dist/components/snk-form.js +2 -29
  20. package/dist/components/snk-grid2.js +7 -53
  21. package/dist/esm/loader.js +1 -1
  22. package/dist/esm/sankhyablocks.js +1 -1
  23. package/dist/esm/snk-application.entry.js +1 -6
  24. package/dist/esm/snk-data-exporter.entry.js +1 -1
  25. package/dist/esm/{snk-data-unit-d31619fb.js → snk-data-unit-b7e6e7a6.js} +1 -11
  26. package/dist/esm/snk-data-unit.entry.js +1 -1
  27. package/dist/esm/snk-filter-bar_4.entry.js +15 -22
  28. package/dist/esm/snk-form_2.entry.js +1 -27
  29. package/dist/esm/snk-grid.entry.js +7 -52
  30. package/dist/sankhyablocks/{p-a2e8c7a7.entry.js → p-158adf33.entry.js} +1 -1
  31. package/dist/sankhyablocks/{p-69b815ab.entry.js → p-8d1508aa.entry.js} +1 -1
  32. package/dist/sankhyablocks/p-a86eee47.entry.js +1 -0
  33. package/dist/sankhyablocks/p-fa18530e.entry.js +1 -0
  34. package/dist/sankhyablocks/sankhyablocks.esm.js +1 -1
  35. package/dist/types/components/snk-application/search-strategy/exec-prepared-search-plus.d.ts +2 -2
  36. package/dist/types/components/snk-application/snk-application.d.ts +14 -9
  37. package/dist/types/components/snk-data-unit/snk-data-unit.d.ts +3 -46
  38. package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts +28 -44
  39. package/dist/types/components/snk-form/snk-form.d.ts +4 -29
  40. package/dist/types/components/snk-grid/snk-grid.d.ts +46 -104
  41. package/dist/types/components/snk-taskbar/snk-taskbar.d.ts +21 -23
  42. package/dist/types/components.d.ts +152 -331
  43. package/package.json +3 -4
  44. package/dist/sankhyablocks/p-49436976.entry.js +0 -1
  45. package/dist/sankhyablocks/p-6fa3d474.entry.js +0 -1
  46. /package/dist/sankhyablocks/{p-8b601472.js → p-0e495575.js} +0 -0
@@ -22,7 +22,7 @@ import { IClientEventResponse } from "./lib/http/data-fetcher/interfaces/IClient
22
22
  import { IDataFetcherRecaller } from "./lib/http/data-fetcher/recaller/IDataFetcherRecaller";
23
23
  import { DialogType, FormLayout, MessageOptions } from "@sankhyalabs/ezui/dist/collection/utils";
24
24
  import { IOption as IOption1, ISearchArgument } from "@sankhyalabs/ezui/dist/types/components/ez-search/ez-search";
25
- import { ISearchCtxOptions } from "./components/snk-application/snk-application";
25
+ import { IPreparedSearchOptions, ISearchCtxOptions } from "./components/snk-application/snk-application";
26
26
  import { IRemoveSearchListener, ISearchListener, SearchCriteria } from "./lib/http/data-fetcher/fetchers/pesquisa-fetcher";
27
27
  import { SIMPLE_CRUD_MODE, TEMPLATES_SKELETON, VIEW_MODE } from "./lib/utils/constants";
28
28
  import { TFetcherType } from "./components/snk-attach/interfaces/TFetcherType";
@@ -291,16 +291,11 @@ export namespace Components {
291
291
  * @returns Uma lista de opções ou uma única opção.
292
292
  * @async
293
293
  */
294
- "executePreparedSearch": (mode: string, argument: string, options: any) => Promise<Array<IOption1> | IOption1>;
294
+ "executePreparedSearch": (mode: string, argument: string, options: IPreparedSearchOptions) => Promise<Array<IOption1> | IOption1>;
295
295
  /**
296
296
  * Realiza a pesquisa de registros Ex.: snk-config-options
297
- * @param mode - O modo da pesquisa ("ADVANCED" ou outro).
298
- * @param argument - O argumento da pesquisa.
299
- * @param options - Opções preparadas para a pesquisa.
300
- * @returns Uma lista de opções ou uma única opção.
301
- * @async
302
297
  */
303
- "executePreparedSearchPlus": (mode: string, argument: string, options: any) => Promise<Array<IOption1> | IOption1>;
298
+ "executePreparedSearchPlus": (mode: string, argument: string, options: IPreparedSearchOptions) => Promise<Array<IOption1> | IOption1>;
304
299
  /**
305
300
  * Obtém as opções em componentes de pesquisa. Ex.: snk-config-options
306
301
  * @param searchArgument - Argumentos da pesquisa.
@@ -901,102 +896,75 @@ export namespace Components {
901
896
  interface SnkDataUnit {
902
897
  /**
903
898
  * Executado após a ação de salvar.
904
- * @param dataUnit - A instância do DataUnit.
905
- * @returns
906
899
  */
907
900
  "afterSave": (dataUnit: DataUnit) => void;
908
901
  /**
909
902
  * 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.
910
- * @param dataUnit - A instância do DataUnit.
911
- * @returns `false` para cancelar a ação, `true` para continuar.
912
903
  */
913
904
  "beforeSave": (dataUnit: DataUnit) => boolean | Promise<boolean>;
914
905
  /**
915
906
  * Usado para obter configuração de metadados.
916
- * @type {string}
917
907
  */
918
908
  "configName": string;
919
909
  /**
920
910
  * Controla o estado atual dos dados.
921
- * @type {DataState}
922
911
  */
923
912
  "dataState": DataState;
924
913
  /**
925
914
  * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
926
- * @type {DataUnit}
927
915
  */
928
916
  "dataUnit": DataUnit;
929
917
  /**
930
918
  * Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade.
931
- * @type {string}
932
919
  */
933
920
  "dataUnitName": string;
934
921
  /**
935
922
  * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
936
- * @type {string}
937
923
  */
938
924
  "domainMessagesBuilder": string;
939
925
  /**
940
926
  * Determina qual a entidade que representa os dados em questão.
941
- * @type {string}
942
927
  */
943
928
  "entityName": string;
944
929
  /**
945
930
  * Obtém o dataUnit.
946
- * @returns Uma promessa que resolve com a instância do DataUnit.
947
- * @async
948
931
  */
949
932
  "getDataUnit": () => Promise<DataUnit>;
950
933
  /**
951
934
  * Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
952
- * @returns Uma promessa que resolve com um array de nomes de campos.
953
- * @async
954
935
  */
955
936
  "getFieldsWithRmPrecision": () => Promise<string[]>;
956
937
  /**
957
938
  * Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
958
- * @returns Uma promessa que resolve com um array de nomes de campos.
959
- * @async
960
939
  */
961
940
  "getFieldsWithRmp": () => Promise<string[]>;
962
941
  /**
963
942
  * Busca os metadados da linha selecionada.
964
- * @param record - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado.
965
- * @returns Uma promessa que resolve com os metadados da linha.
966
- * @async
967
943
  */
968
944
  "getRowMetadata": (record?: Record | string) => Promise<RowMetadata>;
969
945
  /**
970
946
  * Método que retorna a lista de IDs dos registros selecionados.
971
- * @returns Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
972
- * @async
947
+ * @returns Retorna a lista de IDs dos registros selecionados.
973
948
  */
974
949
  "getSelectedRecordsIDsInfo": () => Promise<Array<IRecordID>>;
975
950
  /**
976
951
  * Responsável por evitar a mensagem de sucesso ao salvar.
977
- * @type {boolean}
978
952
  */
979
953
  "ignoreSaveMessage": boolean;
980
954
  /**
981
955
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
982
- * @type {SnkMessageBuilder}
983
956
  */
984
957
  "messagesBuilder": SnkMessageBuilder;
985
958
  /**
986
959
  * Determina quantas linhas são retornadas por página.
987
- * @type {number}
988
- * @default 150
989
960
  */
990
961
  "pageSize": number;
991
962
  /**
992
963
  * Identificador de recursos como configurações e acesso.
993
- * @type {string}
994
964
  */
995
965
  "resourceID": string;
996
966
  /**
997
967
  * Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição.
998
- * @type {boolean}
999
- * @default true
1000
968
  */
1001
969
  "useCancelConfirm": boolean;
1002
970
  }
@@ -1199,98 +1167,83 @@ export namespace Components {
1199
1167
  }
1200
1168
  interface SnkFilterBar {
1201
1169
  /**
1202
- * @description Adiciona um item de filtro.
1203
- * @async
1204
- * @param filterItem - Item a ser adicionado, caso o item já exista com o ID, ele não será adicionado novamente.
1205
- * @return Retorna uma Promise que resolve quando o item for adicionado.
1170
+ * Adiciona um item de filtro.
1171
+ * @param filterItem - Item a ser adicionado, caso o item já exista com o ID ele não será adicionado novamente
1206
1172
  */
1207
1173
  "addFilterItem": (filterItem: SnkFilterItemConfig) => Promise<void>;
1208
1174
  /**
1209
- * @description Função chamada depois de aplicar os filtros.
1175
+ * Função chamada depois de aplicar os filtros.
1210
1176
  */
1211
1177
  "afterApplyConfig"?: () => void;
1212
1178
  /**
1213
- * @description Define se a carga dos dados será feita assim que o componente for carregado.
1179
+ * Define se a carga dos dados será feita assim que o componente for carregado.
1214
1180
  */
1215
1181
  "autoLoad"?: boolean;
1216
1182
  /**
1217
- * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
1183
+ * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
1218
1184
  */
1219
1185
  "configName": string;
1220
1186
  /**
1221
- * @description Loader customizado para carregar as configurações.
1222
- * @param configName - Nome da configuração.
1223
- * @param resourceId - ID do recurso.
1224
- * @param options - Opções adicionais.
1225
- * @returns Retorna a configuração dos filtros.
1187
+ * Loader customizado para carregar as configurações
1226
1188
  */
1227
1189
  "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
1228
1190
  /**
1229
- * @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.
1191
+ * 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.
1230
1192
  */
1231
1193
  "dataUnit": DataUnit;
1232
1194
  /**
1233
- * @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).
1195
+ * 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).
1234
1196
  */
1235
1197
  "disablePersonalizedFilter": boolean;
1236
1198
  /**
1237
- * @description Define se o componente deve usar o LockManager para controle de carregamento.
1199
+ * Define se o componente deve usar o LockManager para controle de carregamento
1238
1200
  */
1239
1201
  "enableLockManagerLoadingComp"?: boolean;
1240
1202
  /**
1241
- * @description Chave da configuração legada da barra de filtros.
1203
+ * Chave da configuração legado da barra de filtros.
1242
1204
  */
1243
1205
  "filterBarLegacyConfigName": string;
1244
1206
  /**
1245
- * @description Lista todos os filtros disponíveis ao usuário.
1207
+ * Lista todos os filtros disponíveis ao usuário.
1246
1208
  */
1247
1209
  "filterConfig": Array<SnkFilterItemConfig>;
1248
1210
  /**
1249
- * @description Retorna um item de filtro pelo ID.
1250
- * @async
1251
- * @param id - ID do item de filtro.
1252
- * @returns O item de filtro correspondente ou undefined se não for encontrado.
1211
+ * Retorna um item de filtro pelo ID.
1253
1212
  */
1254
1213
  "getFilterItem": (id: string) => Promise<SnkFilterItemConfig | undefined>;
1255
1214
  /**
1256
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
1215
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
1257
1216
  */
1258
1217
  "messagesBuilder": SnkMessageBuilder;
1259
1218
  /**
1260
- * @description Modo de apresentação da barra de filtros.
1219
+ * Modo de apresentação da filterbar.
1261
1220
  */
1262
1221
  "mode": "regular" | "button" | "hidden";
1263
1222
  /**
1264
- * @description Faz o recarregamento da barra de filtros buscando o state no servidor.
1265
- * @async
1266
- * @return Retorna uma Promise que resolve quando o recarregamento for concluído.
1223
+ * Faz o recarregamento da filterbar buscando o state no servidor.
1267
1224
  */
1268
1225
  "reload": () => Promise<void>;
1269
1226
  /**
1270
- * @description Remove um item de filtro.
1271
- * @async
1272
- * @param filterID - ID do item a ser removido.
1273
- * @returns Retorna o item de filtro removido, ou undefined caso não seja encontrado.
1227
+ * Remove um item de filtro.
1228
+ * @param filterID - ID do a ser adicionado
1229
+ * @returns - Retorna o item de filtro removido, ou undefined caso não encontrado.
1274
1230
  */
1275
1231
  "removeFilterItem": (filterID: string) => Promise<SnkFilterItemConfig | undefined>;
1276
1232
  /**
1277
- * @description Identificador de recursos como configurações e acesso.
1233
+ * Identificador de recursos como configurações e acesso.
1278
1234
  */
1279
1235
  "resourceID": string;
1280
1236
  /**
1281
- * @description Abre o modal de filtros.
1282
- * @async
1237
+ * Abre o modal de filtros
1283
1238
  */
1284
1239
  "showFilterModal": () => Promise<void>;
1285
1240
  /**
1286
- * @description Título que será apresentado na barra de filtros.
1241
+ * Título que será apresentado na barra de filtros
1287
1242
  */
1288
1243
  "title": string;
1289
1244
  /**
1290
- * @description Atualiza um item do filtro.
1291
- * @async
1292
- * @param newFilterItem - Item com as informações atualizadas, caso o item não seja encontrado no array, ele não será modificado.
1293
- * @return Retorna uma Promise que resolve quando a atualização for concluída.
1245
+ * Atualiza um item do filtro.
1246
+ * @param filterItem - Item com as informações atualizadas, caso o item não seja encontrado no array ele mão será modificado
1294
1247
  */
1295
1248
  "updateFilterItem": (newFilterItem: SnkFilterItemConfig) => Promise<void>;
1296
1249
  }
@@ -1569,11 +1522,7 @@ export namespace Components {
1569
1522
  }
1570
1523
  interface SnkForm {
1571
1524
  /**
1572
- * Registra um editor customizado para campos do formulário.
1573
- * @async
1574
- * @param fieldName - Nome do campo.
1575
- * @param customEditor - Editor customizado.
1576
- * @returns
1525
+ * Registra um editor customizado para campos da grade e formulário.
1577
1526
  */
1578
1527
  "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise<void>;
1579
1528
  /**
@@ -1581,13 +1530,11 @@ export namespace Components {
1581
1530
  */
1582
1531
  "configName": string;
1583
1532
  /**
1584
- * Chave da configuração legada do formulário.
1533
+ * Chave da configuração legado do formulário.
1585
1534
  */
1586
1535
  "formLegacyConfigName": string;
1587
1536
  /**
1588
1537
  * Fecha a janela de configurações do formulário.
1589
- * @async
1590
- * @returns
1591
1538
  */
1592
1539
  "hideConfig": () => Promise<void>;
1593
1540
  /**
@@ -1604,26 +1551,12 @@ export namespace Components {
1604
1551
  "resourceID": string;
1605
1552
  /**
1606
1553
  * Altera/adiciona uma propriedade nos metadados do campo.
1607
- * @async
1608
- * @param fieldName - Nome do campo.
1609
- * @param propName - Nome da propriedade.
1610
- * @param value - Valor da propriedade.
1611
- * @returns
1612
1554
  */
1613
1555
  "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
1614
1556
  /**
1615
1557
  * Exibe a janela de configurações do formulário.
1616
- * @async
1617
- * @returns
1618
1558
  */
1619
1559
  "showConfig": () => Promise<void>;
1620
- /**
1621
- * Valida o formulário.
1622
- * @async
1623
- * @returns
1624
- * @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.
1625
- */
1626
- "validate": () => Promise<void>;
1627
1560
  }
1628
1561
  interface SnkFormConfig {
1629
1562
  /**
@@ -1735,72 +1668,52 @@ export namespace Components {
1735
1668
  }
1736
1669
  interface SnkGrid {
1737
1670
  /**
1738
- * Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`.
1671
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
1739
1672
  */
1740
1673
  "actionsList": Array<Action>;
1741
1674
  /**
1742
- * Registra um editor customizado para um campo da grade ou formulário.
1743
- * @async
1744
- * @description Adiciona um componente de edição personalizado para um campo específico. Este editor será usado tanto na edição em linha na grade quanto em formulários de detalhe.
1745
- * @param fieldName O nome do campo que receberá o editor customizado.
1746
- * @param customEditor A instância do editor customizado.
1747
- * @param detailContext O contexto de detalhe onde o editor será aplicado (opcional).
1748
- * @returns Uma promessa que é resolvida quando o editor é registrado.
1675
+ * Registra um editor customizado para campos da grade e formulário
1749
1676
  */
1750
1677
  "addCustomEditor": (fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>;
1751
1678
  /**
1752
- * Registra um formatador de valor customizado para uma coluna da grade.
1753
- * @async
1754
- * @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
1755
- * @param columnName O nome da coluna que receberá o formatador.
1756
- * @param customFormatter A instância do formatador de valor.
1757
- * @returns Uma promessa que é resolvida quando o formatador é registrado.
1679
+ * Registra um formatador de valores para uma coluna da grid.
1758
1680
  */
1759
1681
  "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise<void>;
1760
1682
  /**
1761
- * Registra um renderizador customizado para uma coluna da grade.
1762
- * @async
1763
- * @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
1764
- * @param fieldName O nome do campo (coluna) que receberá o renderizador customizado.
1765
- * @param customRender A instância do renderizador customizado.
1766
- * @param detailContext O contexto de detalhe onde o renderizador será aplicado (opcional).
1767
- * @returns Uma promessa que é resolvida quando o renderizador é registrado.
1683
+ * Registra um render customizado para colunas da grid.
1768
1684
  */
1769
1685
  "addGridCustomRender": (fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>;
1770
1686
  /**
1771
- * Define se a grade receberá o foco automaticamente ao ser carregada.
1687
+ * Define se a grid será focada ao ser carregada.
1772
1688
  */
1773
1689
  "autoFocus"?: boolean;
1774
1690
  /**
1775
- * Define se os dados serão carregados automaticamente na inicialização do componente.
1691
+ * Define se a carga dos dados será feita assim que o componente for carregado.
1776
1692
  */
1777
1693
  "autoLoad"?: boolean;
1778
1694
  /**
1779
- * Define se a edição de dados na grade está habilitada.
1695
+ * Define se a edição está habilitada na grid.
1780
1696
  */
1781
1697
  "canEdit": boolean;
1782
- /**
1783
- * Define o data source para o filtro de colunas.
1784
- */
1785
1698
  "columnFilterDataSource": IMultiSelectionListDataSource;
1786
1699
  /**
1787
- * Define se a grade deve ser exibida em modo compacto.
1700
+ * Define se a grade deve ser exibida em modo compacto
1788
1701
  */
1789
1702
  "compact": boolean;
1790
1703
  /**
1791
- * Nome usado para salvar e recuperar a configuração da grade.
1704
+ * Nome usado para salvar/recuperar a configuração.
1792
1705
  */
1793
1706
  "configName": string;
1794
1707
  /**
1795
- * Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros) e no modal lateral de filtros (contêiner de filtros personalizados).
1708
+ * 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).
1796
1709
  */
1797
1710
  "disablePersonalizedFilter": boolean;
1798
1711
  /**
1799
- * Habilita a inserção de registros diretamente na grade.
1712
+ * Ativa inserção de registros no modo grade.
1800
1713
  */
1801
1714
  "enableGridInsert"?: boolean;
1802
1715
  /**
1803
- * Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
1716
+ * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
1804
1717
  */
1805
1718
  "enableLockManagerLoadingComp"?: boolean;
1806
1719
  /**
@@ -1808,37 +1721,31 @@ export namespace Components {
1808
1721
  */
1809
1722
  "enableLockManagerTaskbarClick"?: boolean;
1810
1723
  /**
1811
- * Chave da configuração legada da barra de filtros.
1724
+ * Chave da configuração legado da barra de filtros.
1812
1725
  */
1813
1726
  "filterBarLegacyConfigName": string;
1814
1727
  /**
1815
- * Título que será apresentado na barra de filtros.
1728
+ * Título que será apresentado na barra de filtros
1816
1729
  */
1817
1730
  "filterBarTitle": string;
1818
1731
  /**
1819
- * Retorna o elemento da barra de filtros da grade.
1820
- * @async
1821
- * @description Este método permite acessar o elemento da barra de filtros, que pode ser útil para manipulações adicionais ou para obter o estado atual dos filtros aplicados.
1822
- * @returns O elemento da barra de filtros.
1732
+ * Retorna o elemento da filter-bar da grade.
1823
1733
  */
1824
1734
  "getFilterBar": () => Promise<HTMLSnkFilterBarElement>;
1825
1735
  /**
1826
- * Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade.
1736
+ * Nome do slot de elementos customizados da Taskbar do cabeçalho da grade.
1827
1737
  */
1828
1738
  "gridHeaderCustomSlotId": string;
1829
1739
  /**
1830
- * Chave da configuração legada da grade.
1740
+ * Chave da configuração legado da grade.
1831
1741
  */
1832
1742
  "gridLegacyConfigName": string;
1833
1743
  /**
1834
1744
  * Fecha a janela de configurações da grade.
1835
- * @async
1836
- * @description Este método fecha o pop-up de configuração de colunas da grade.
1837
- * @returns Uma promessa que é resolvida quando a janela de configuração é fechada.
1838
1745
  */
1839
1746
  "hideConfig": () => Promise<void>;
1840
1747
  /**
1841
- * Determina se a grade está vinculada a um detalhe de outra tela.
1748
+ * Determina se a grade está vinculada a um detalhe.
1842
1749
  */
1843
1750
  "isDetail": boolean;
1844
1751
  /**
@@ -1846,118 +1753,92 @@ export namespace Components {
1846
1753
  */
1847
1754
  "messagesBuilder": SnkMessageBuilder;
1848
1755
  /**
1849
- * Habilita a edição de múltiplos registros simultaneamente.
1756
+ * Habilita a edição de múltiplos registros simultâneos.
1850
1757
  */
1851
1758
  "multipleEditionEnabled": boolean;
1852
1759
  /**
1853
- * Determina se a seleção de múltiplas linhas é permitida.
1760
+ * Determina se pode haver mais de uma linha selecionada.
1854
1761
  */
1855
1762
  "multipleSelection": boolean;
1856
1763
  /**
1857
- * Altera a aparência das bordas e sombras do componente. Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout). Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up).
1764
+ * 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)
1858
1765
  */
1859
1766
  "outlineMode"?: boolean;
1860
1767
  /**
1861
- * Define o modo de exibição do contador de paginação.
1768
+ * Define se a grid será focada ao ser carregada.
1862
1769
  */
1863
1770
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
1864
1771
  /**
1865
- * Altera o modo de apresentação dos botões do `snk-taskbar`.
1772
+ * Altera o modo de apresentação dos botões do snk-taskbar.
1866
1773
  */
1867
1774
  "presentationMode": PresentationMode1;
1868
1775
  /**
1869
- * Validador responsável por verificar a integridade dos dados de um registro.
1776
+ * Validador responsável por checar a integridade das informações do registro.
1870
1777
  */
1871
1778
  "recordsValidator": IRecordValidator;
1872
- /**
1873
- * Recarrega a configuração da grade.
1874
- * @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.
1875
- */
1876
1779
  "reloadConfig": () => Promise<void>;
1877
1780
  /**
1878
- * Recarrega a barra de filtros da grade, buscando o estado do servidor.
1879
- * @async
1880
- * @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
1881
- * @returns Uma promessa que é resolvida quando a barra de filtros é recarregada.
1781
+ * Faz o recarregamento da filter-bar da grade buscando o state no servidor.
1882
1782
  */
1883
1783
  "reloadFilterBar": () => Promise<void>;
1884
1784
  /**
1885
- * Remove um formatador de valor customizado de uma coluna da grade.
1886
- * @async
1887
- * @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
1888
- * @param columnName O nome da coluna da qual o formatador será removido.
1889
- * @returns Uma promessa que é resolvida quando o formatador é removido.
1785
+ * Remove o formatador de valores de uma coluna da grid.
1890
1786
  */
1891
1787
  "removeCustomValueFormatter": (columnName: string) => Promise<void>;
1892
1788
  /**
1893
- * Identificador de recursos, como configurações e permissões de acesso.
1789
+ * Identificador de recursos como configurações e acesso.
1894
1790
  */
1895
1791
  "resourceID": string;
1896
1792
  /**
1897
- * Configuração do toast de seleção da grade.
1793
+ * Configuração da seleção de grade no toast.
1898
1794
  */
1899
1795
  "selectionToastConfig": ISelectionToastConfig;
1900
1796
  /**
1901
- * Define a configuração da grade.
1902
- * @async
1903
- * @description Aplica uma nova configuração de colunas e ordenação à grade.
1904
- * @param config O objeto de configuração a ser aplicado na grade.
1905
- * @returns Uma promessa que é resolvida quando a configuração é aplicada.
1797
+ * Atribui o valor da configuração da grade.
1906
1798
  */
1907
1799
  "setConfig": (config: IGridConfig) => Promise<void>;
1908
1800
  /**
1909
1801
  * Atribui o foco para a grade.
1910
- * @async
1911
- * @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
1912
- * @returns Uma promessa que é resolvida quando o foco é atribuído.
1913
1802
  */
1914
1803
  "setFocus": () => Promise<void>;
1915
1804
  /**
1916
1805
  * Exibe a janela de configurações da grade.
1917
- * @async
1918
- * @description Este método abre o pop-up de configuração de colunas da grade, permitindo ao usuário ajustar a visibilidade, ordem e largura das colunas.
1919
- * @returns Uma promessa que é resolvida quando a janela de configuração é exibida.
1920
1806
  */
1921
1807
  "showConfig": () => Promise<void>;
1922
1808
  /**
1923
- * Define a configuração de cores para a coluna de status.
1924
- * @example ```json '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' ```
1809
+ * Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
1925
1810
  */
1926
1811
  "statusResolver": IStatusResolver | StatusResolverFunction;
1927
1812
  /**
1928
- * Define o modo de exportação dos dados.
1813
+ * Modo de exportação dos dados.
1929
1814
  */
1930
1815
  "strategyExporter": IExporterStrategyMode;
1931
1816
  /**
1932
- * Informa se a coluna de checkbox deve ser suprimida.
1817
+ * Informa se a coluna de chechbox deve ser suprimida
1933
1818
  */
1934
1819
  "suppressCheckboxColumn": boolean;
1935
1820
  /**
1936
- * Informa se a grade deve suprimir o filtro de coluna.
1937
- */
1938
- "suppressFilterColumn"?: boolean;
1939
- /**
1940
- * Define se a grade deve suprimir a barra de rolagem horizontal.
1821
+ * Define se a grade deve suprimir o scroll horizontal.
1941
1822
  */
1942
1823
  "suppressHorizontalScroll": boolean;
1943
1824
  /**
1944
- * Define o identificador do contêiner de elementos customizados da `Taskbar`.
1825
+ * Define o identificador do container de elementos customizados da Taskbar.
1945
1826
  */
1946
1827
  "taskbarCustomContainerId": string;
1947
1828
  /**
1948
- * Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões.
1829
+ * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
1949
1830
  */
1950
1831
  "taskbarManager": TaskbarManager;
1951
1832
  /**
1952
- * Define o nome do slot para elementos customizados na `Taskbar` principal do componente.
1833
+ * Nome do slot de elementos customizados da Taskbar principal do componente.
1953
1834
  */
1954
1835
  "topTaskbarCustomSlotId": string;
1955
1836
  /**
1956
- * Quando `true`, a tecla ENTER navega entre as células como a tecla TAB.
1837
+ * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
1957
1838
  */
1958
1839
  "useEnterLikeTab": boolean;
1959
1840
  /**
1960
- * Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`.
1841
+ * Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F
1961
1842
  */
1962
1843
  "useSearchColumn": boolean;
1963
1844
  }
@@ -2348,64 +2229,63 @@ export namespace Components {
2348
2229
  }
2349
2230
  interface SnkTaskbar {
2350
2231
  /**
2351
- * @description Lista de ações a serem exibidas no botão "Mais opções".
2232
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
2352
2233
  */
2353
2234
  "actionsList": Array<Action>;
2354
2235
  /**
2355
- * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
2236
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
2356
2237
  */
2357
2238
  "actionsSettingsList": Array<Action>;
2358
2239
  /**
2359
- * @description Define o alinhamento dos itens da barra de tarefas à direita.
2240
+ * Usado para determinar O alinhamento dos items na taskbar.
2360
2241
  */
2361
2242
  "alignRigth": boolean;
2362
2243
  /**
2363
- * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas.
2244
+ * Lista separada por virgula, contendo todos os elementos a serem criados.
2364
2245
  */
2365
2246
  "buttons": string;
2366
2247
  /**
2367
- * @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.
2248
+ * Usado para guardar ou recuperar as configurações do formulário.
2368
2249
  */
2369
2250
  "configName": string;
2370
2251
  /**
2371
- * @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.
2252
+ * 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.
2372
2253
  */
2373
2254
  "customButtons": Map<string, CustomButton>;
2374
2255
  /**
2375
- * @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.
2376
- * @example Elementos customizados na Taskbar da aba de detalhes.
2256
+ * 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.
2377
2257
  */
2378
2258
  "customContainerId": string;
2379
2259
  /**
2380
- * @description Define o identificador do slot que recebe elementos personalizados.
2260
+ * Usado para determinar o identificador do slot que recebe elementos personalizados.
2381
2261
  */
2382
2262
  "customSlotId": string;
2383
2263
  /**
2384
- * @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).
2264
+ * Instância do DataUnit.
2385
2265
  */
2386
2266
  "dataUnit": DataUnit;
2387
2267
  /**
2388
- * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
2268
+ * Array contendo todos os botões a serem desabilitados.
2389
2269
  */
2390
2270
  "disabledButtons": Array<string>;
2391
2271
  /**
2392
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2272
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2393
2273
  */
2394
2274
  "messagesBuilder": SnkMessageBuilder;
2395
2275
  /**
2396
- * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens.
2276
+ * Define como será o comportamento da taskbar quando ocorrer overflow
2397
2277
  */
2398
2278
  "overflowStrategy": 'hiddenItems' | 'none';
2399
2279
  /**
2400
- * @description Altera o modo de apresentação dos botões da barra de tarefas.
2280
+ * Altera o modo de apresentação dos botões do snk-taskbar.
2401
2281
  */
2402
2282
  "presentationMode": PresentationMode1;
2403
2283
  /**
2404
- * @description Define qual botão deve ter a aparência de destaque (primário).
2284
+ * Determina qual botão deve ter aparência primária.
2405
2285
  */
2406
2286
  "primaryButton": string;
2407
2287
  /**
2408
- * @description Identificador de recursos, como configurações e permissões de acesso.
2288
+ * Identificador de recursos como configurações e acesso.
2409
2289
  */
2410
2290
  "resourceID": string;
2411
2291
  }
@@ -3531,112 +3411,78 @@ declare namespace LocalJSX {
3531
3411
  interface SnkDataUnit {
3532
3412
  /**
3533
3413
  * Executado após a ação de salvar.
3534
- * @param dataUnit - A instância do DataUnit.
3535
- * @returns
3536
3414
  */
3537
3415
  "afterSave"?: (dataUnit: DataUnit) => void;
3538
3416
  /**
3539
3417
  * 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.
3540
- * @param dataUnit - A instância do DataUnit.
3541
- * @returns `false` para cancelar a ação, `true` para continuar.
3542
3418
  */
3543
3419
  "beforeSave"?: (dataUnit: DataUnit) => boolean | Promise<boolean>;
3544
3420
  /**
3545
3421
  * Usado para obter configuração de metadados.
3546
- * @type {string}
3547
3422
  */
3548
3423
  "configName"?: string;
3549
3424
  /**
3550
3425
  * Controla o estado atual dos dados.
3551
- * @type {DataState}
3552
3426
  */
3553
3427
  "dataState"?: DataState;
3554
3428
  /**
3555
3429
  * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
3556
- * @type {DataUnit}
3557
3430
  */
3558
3431
  "dataUnit"?: DataUnit;
3559
3432
  /**
3560
3433
  * Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade.
3561
- * @type {string}
3562
3434
  */
3563
3435
  "dataUnitName"?: string;
3564
3436
  /**
3565
3437
  * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
3566
- * @type {string}
3567
3438
  */
3568
3439
  "domainMessagesBuilder"?: string;
3569
3440
  /**
3570
3441
  * Determina qual a entidade que representa os dados em questão.
3571
- * @type {string}
3572
3442
  */
3573
3443
  "entityName"?: string;
3574
3444
  /**
3575
3445
  * Responsável por evitar a mensagem de sucesso ao salvar.
3576
- * @type {boolean}
3577
3446
  */
3578
3447
  "ignoreSaveMessage"?: boolean;
3579
3448
  /**
3580
3449
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
3581
- * @type {SnkMessageBuilder}
3582
3450
  */
3583
3451
  "messagesBuilder"?: SnkMessageBuilder;
3584
3452
  /**
3585
3453
  * Emitido quando se cancela uma inserção ou cópia.
3586
- * @event cancelEdition
3587
- * @type {CustomEvent<void>}
3588
- * @bubbles false
3589
3454
  */
3590
3455
  "onCancelEdition"?: (event: SnkDataUnitCustomEvent<void>) => void;
3591
3456
  /**
3592
3457
  * Emitido quando há qualquer mudança de estado no DataUnit.
3593
- * @event dataStateChange
3594
- * @type {CustomEvent<DataState>}
3595
- * @bubbles false
3596
3458
  */
3597
3459
  "onDataStateChange"?: (event: SnkDataUnitCustomEvent<DataState>) => void;
3598
3460
  /**
3599
3461
  * Emitido quando há campos no DataUnit que devem ser ocultados.
3600
- * @event dataUnitFieldsHidded
3601
- * @type {CustomEvent<void>}
3602
3462
  */
3603
3463
  "onDataUnitFieldsHidded"?: (event: SnkDataUnitCustomEvent<void>) => void;
3604
3464
  /**
3605
3465
  * Emitido quando o DataUnit está pronto.
3606
- * @event dataUnitReady
3607
- * @type {CustomEvent<DataUnit>}
3608
- * @bubbles false
3609
3466
  */
3610
3467
  "onDataUnitReady"?: (event: SnkDataUnitCustomEvent<DataUnit>) => void;
3611
3468
  /**
3612
3469
  * Emitido quando um registro é adicionado ou copiado.
3613
- * @event insertionMode
3614
- * @type {CustomEvent<void>}
3615
- * @bubbles false
3616
3470
  */
3617
3471
  "onInsertionMode"?: (event: SnkDataUnitCustomEvent<void>) => void;
3618
3472
  /**
3619
- * Emitido quando o messagesBuilder é atualizado.
3620
- * @event messagesBuilderUpdated
3621
- * @type {CustomEvent<SnkMessageBuilder>}
3622
- * @bubbles false
3473
+ * Emitido quando o DataUnit está pronto.
3623
3474
  */
3624
3475
  "onMessagesBuilderUpdated"?: (event: SnkDataUnitCustomEvent<SnkMessageBuilder>) => void;
3625
3476
  /**
3626
3477
  * Determina quantas linhas são retornadas por página.
3627
- * @type {number}
3628
- * @default 150
3629
3478
  */
3630
3479
  "pageSize"?: number;
3631
3480
  /**
3632
3481
  * Identificador de recursos como configurações e acesso.
3633
- * @type {string}
3634
3482
  */
3635
3483
  "resourceID"?: string;
3636
3484
  /**
3637
3485
  * Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição.
3638
- * @type {boolean}
3639
- * @default true
3640
3486
  */
3641
3487
  "useCancelConfirm"?: boolean;
3642
3488
  }
@@ -3859,65 +3705,56 @@ declare namespace LocalJSX {
3859
3705
  }
3860
3706
  interface SnkFilterBar {
3861
3707
  /**
3862
- * @description Função chamada depois de aplicar os filtros.
3708
+ * Função chamada depois de aplicar os filtros.
3863
3709
  */
3864
3710
  "afterApplyConfig"?: () => void;
3865
3711
  /**
3866
- * @description Define se a carga dos dados será feita assim que o componente for carregado.
3712
+ * Define se a carga dos dados será feita assim que o componente for carregado.
3867
3713
  */
3868
3714
  "autoLoad"?: boolean;
3869
3715
  /**
3870
- * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
3716
+ * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
3871
3717
  */
3872
3718
  "configName"?: string;
3873
3719
  /**
3874
- * @description Loader customizado para carregar as configurações.
3875
- * @param configName - Nome da configuração.
3876
- * @param resourceId - ID do recurso.
3877
- * @param options - Opções adicionais.
3878
- * @returns Retorna a configuração dos filtros.
3720
+ * Loader customizado para carregar as configurações
3879
3721
  */
3880
3722
  "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
3881
3723
  /**
3882
- * @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.
3724
+ * 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.
3883
3725
  */
3884
3726
  "dataUnit"?: DataUnit;
3885
3727
  /**
3886
- * @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).
3728
+ * 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).
3887
3729
  */
3888
3730
  "disablePersonalizedFilter"?: boolean;
3889
3731
  /**
3890
- * @description Define se o componente deve usar o LockManager para controle de carregamento.
3732
+ * Define se o componente deve usar o LockManager para controle de carregamento
3891
3733
  */
3892
3734
  "enableLockManagerLoadingComp"?: boolean;
3893
3735
  /**
3894
- * @description Chave da configuração legada da barra de filtros.
3736
+ * Chave da configuração legado da barra de filtros.
3895
3737
  */
3896
3738
  "filterBarLegacyConfigName"?: string;
3897
3739
  /**
3898
- * @description Lista todos os filtros disponíveis ao usuário.
3740
+ * Lista todos os filtros disponíveis ao usuário.
3899
3741
  */
3900
3742
  "filterConfig"?: Array<SnkFilterItemConfig>;
3901
3743
  /**
3902
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
3744
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
3903
3745
  */
3904
3746
  "messagesBuilder"?: SnkMessageBuilder;
3905
3747
  /**
3906
- * @description Modo de apresentação da barra de filtros.
3748
+ * Modo de apresentação da filterbar.
3907
3749
  */
3908
3750
  "mode"?: "regular" | "button" | "hidden";
3909
- /**
3910
- * @description Evento emitido quando a configuração dos filtros é atualizada.
3911
- * @param configs - Lista de configurações de filtros atualizadas.
3912
- * @event
3913
- */
3914
3751
  "onConfigUpdated"?: (event: SnkFilterBarCustomEvent<SnkFilterItemConfig[]>) => void;
3915
3752
  /**
3916
- * @description Identificador de recursos como configurações e acesso.
3753
+ * Identificador de recursos como configurações e acesso.
3917
3754
  */
3918
3755
  "resourceID"?: string;
3919
3756
  /**
3920
- * @description Título que será apresentado na barra de filtros.
3757
+ * Título que será apresentado na barra de filtros
3921
3758
  */
3922
3759
  "title"?: string;
3923
3760
  }
@@ -4196,7 +4033,7 @@ declare namespace LocalJSX {
4196
4033
  */
4197
4034
  "configName"?: string;
4198
4035
  /**
4199
- * Chave da configuração legada do formulário.
4036
+ * Chave da configuração legado do formulário.
4200
4037
  */
4201
4038
  "formLegacyConfigName"?: string;
4202
4039
  /**
@@ -4204,15 +4041,15 @@ declare namespace LocalJSX {
4204
4041
  */
4205
4042
  "messagesBuilder"?: SnkMessageBuilder;
4206
4043
  /**
4207
- * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
4044
+ * Emitido sempre que houver click de botão ou ação.
4208
4045
  */
4209
4046
  "onActionClick"?: (event: SnkFormCustomEvent<string>) => void;
4210
4047
  /**
4211
- * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
4048
+ * Emitido quando o botão de voltar é acionado.
4212
4049
  */
4213
4050
  "onExit"?: (event: SnkFormCustomEvent<void>) => void;
4214
4051
  /**
4215
- * Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view
4052
+ * Responsável por notificar quando ocorrer a renderização de itens do formulário.
4216
4053
  */
4217
4054
  "onFormItemsReady"?: (event: SnkFormCustomEvent<Array<HTMLElement>>) => void;
4218
4055
  /**
@@ -4341,43 +4178,40 @@ declare namespace LocalJSX {
4341
4178
  }
4342
4179
  interface SnkGrid {
4343
4180
  /**
4344
- * Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`.
4181
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
4345
4182
  */
4346
4183
  "actionsList"?: Array<Action>;
4347
4184
  /**
4348
- * Define se a grade receberá o foco automaticamente ao ser carregada.
4185
+ * Define se a grid será focada ao ser carregada.
4349
4186
  */
4350
4187
  "autoFocus"?: boolean;
4351
4188
  /**
4352
- * Define se os dados serão carregados automaticamente na inicialização do componente.
4189
+ * Define se a carga dos dados será feita assim que o componente for carregado.
4353
4190
  */
4354
4191
  "autoLoad"?: boolean;
4355
4192
  /**
4356
- * Define se a edição de dados na grade está habilitada.
4193
+ * Define se a edição está habilitada na grid.
4357
4194
  */
4358
4195
  "canEdit"?: boolean;
4359
- /**
4360
- * Define o data source para o filtro de colunas.
4361
- */
4362
4196
  "columnFilterDataSource"?: IMultiSelectionListDataSource;
4363
4197
  /**
4364
- * Define se a grade deve ser exibida em modo compacto.
4198
+ * Define se a grade deve ser exibida em modo compacto
4365
4199
  */
4366
4200
  "compact"?: boolean;
4367
4201
  /**
4368
- * Nome usado para salvar e recuperar a configuração da grade.
4202
+ * Nome usado para salvar/recuperar a configuração.
4369
4203
  */
4370
4204
  "configName"?: string;
4371
4205
  /**
4372
- * Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros) e no modal lateral de filtros (contêiner de filtros personalizados).
4206
+ * 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).
4373
4207
  */
4374
4208
  "disablePersonalizedFilter"?: boolean;
4375
4209
  /**
4376
- * Habilita a inserção de registros diretamente na grade.
4210
+ * Ativa inserção de registros no modo grade.
4377
4211
  */
4378
4212
  "enableGridInsert"?: boolean;
4379
4213
  /**
4380
- * Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
4214
+ * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
4381
4215
  */
4382
4216
  "enableLockManagerLoadingComp"?: boolean;
4383
4217
  /**
@@ -4385,23 +4219,23 @@ declare namespace LocalJSX {
4385
4219
  */
4386
4220
  "enableLockManagerTaskbarClick"?: boolean;
4387
4221
  /**
4388
- * Chave da configuração legada da barra de filtros.
4222
+ * Chave da configuração legado da barra de filtros.
4389
4223
  */
4390
4224
  "filterBarLegacyConfigName"?: string;
4391
4225
  /**
4392
- * Título que será apresentado na barra de filtros.
4226
+ * Título que será apresentado na barra de filtros
4393
4227
  */
4394
4228
  "filterBarTitle"?: string;
4395
4229
  /**
4396
- * Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade.
4230
+ * Nome do slot de elementos customizados da Taskbar do cabeçalho da grade.
4397
4231
  */
4398
4232
  "gridHeaderCustomSlotId"?: string;
4399
4233
  /**
4400
- * Chave da configuração legada da grade.
4234
+ * Chave da configuração legado da grade.
4401
4235
  */
4402
4236
  "gridLegacyConfigName"?: string;
4403
4237
  /**
4404
- * Determina se a grade está vinculada a um detalhe de outra tela.
4238
+ * Determina se a grade está vinculada a um detalhe.
4405
4239
  */
4406
4240
  "isDetail"?: boolean;
4407
4241
  /**
@@ -4409,92 +4243,83 @@ declare namespace LocalJSX {
4409
4243
  */
4410
4244
  "messagesBuilder"?: SnkMessageBuilder;
4411
4245
  /**
4412
- * Habilita a edição de múltiplos registros simultaneamente.
4246
+ * Habilita a edição de múltiplos registros simultâneos.
4413
4247
  */
4414
4248
  "multipleEditionEnabled"?: boolean;
4415
4249
  /**
4416
- * Determina se a seleção de múltiplas linhas é permitida.
4250
+ * Determina se pode haver mais de uma linha selecionada.
4417
4251
  */
4418
4252
  "multipleSelection"?: boolean;
4419
4253
  /**
4420
- * Emitido ao clicar em um botão de ação ou item de menu.
4421
- * @description Este evento é acionado quando o usuário clica em um botão de ação ou item de menu na grade, permitindo a execução de ações específicas.
4422
- * @param detail - O identificador da ação clicada, que pode ser usado para determinar qual ação executar.
4254
+ * Emitido sempre que houver click de botão ou ação.
4423
4255
  */
4424
4256
  "onActionClick"?: (event: SnkGridCustomEvent<string>) => void;
4425
4257
  /**
4426
- * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
4258
+ * Emitido quando o componente estiver completamente carregado.
4427
4259
  */
4428
4260
  "onComponentReady"?: (event: SnkGridCustomEvent<void>) => void;
4429
4261
  /**
4430
- * Emitido ao realizar um duplo clique em uma linha da grade.
4431
- * @description Este evento é acionado quando o usuário clica duas vezes em uma linha da grade, permitindo ações como edição rápida ou visualização de detalhes.
4432
- * @param detail - Detalhes do evento, contendo a linha clicada.
4262
+ * Emitido sempre que houver duplo click na grade.
4433
4263
  */
4434
4264
  "onGridDoubleClick"?: (event: SnkGridCustomEvent<any>) => void;
4435
4265
  /**
4436
- * Altera a aparência das bordas e sombras do componente. Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout). Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up).
4266
+ * 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)
4437
4267
  */
4438
4268
  "outlineMode"?: boolean;
4439
4269
  /**
4440
- * Define o modo de exibição do contador de paginação.
4270
+ * Define se a grid será focada ao ser carregada.
4441
4271
  */
4442
4272
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
4443
4273
  /**
4444
- * Altera o modo de apresentação dos botões do `snk-taskbar`.
4274
+ * Altera o modo de apresentação dos botões do snk-taskbar.
4445
4275
  */
4446
4276
  "presentationMode"?: PresentationMode1;
4447
4277
  /**
4448
- * Validador responsável por verificar a integridade dos dados de um registro.
4278
+ * Validador responsável por checar a integridade das informações do registro.
4449
4279
  */
4450
4280
  "recordsValidator"?: IRecordValidator;
4451
4281
  /**
4452
- * Identificador de recursos, como configurações e permissões de acesso.
4282
+ * Identificador de recursos como configurações e acesso.
4453
4283
  */
4454
4284
  "resourceID"?: string;
4455
4285
  /**
4456
- * Configuração do toast de seleção da grade.
4286
+ * Configuração da seleção de grade no toast.
4457
4287
  */
4458
4288
  "selectionToastConfig"?: ISelectionToastConfig;
4459
4289
  /**
4460
- * Define a configuração de cores para a coluna de status.
4461
- * @example ```json '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' ```
4290
+ * Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
4462
4291
  */
4463
4292
  "statusResolver"?: IStatusResolver | StatusResolverFunction;
4464
4293
  /**
4465
- * Define o modo de exportação dos dados.
4294
+ * Modo de exportação dos dados.
4466
4295
  */
4467
4296
  "strategyExporter"?: IExporterStrategyMode;
4468
4297
  /**
4469
- * Informa se a coluna de checkbox deve ser suprimida.
4298
+ * Informa se a coluna de chechbox deve ser suprimida
4470
4299
  */
4471
4300
  "suppressCheckboxColumn"?: boolean;
4472
4301
  /**
4473
- * Informa se a grade deve suprimir o filtro de coluna.
4474
- */
4475
- "suppressFilterColumn"?: boolean;
4476
- /**
4477
- * Define se a grade deve suprimir a barra de rolagem horizontal.
4302
+ * Define se a grade deve suprimir o scroll horizontal.
4478
4303
  */
4479
4304
  "suppressHorizontalScroll"?: boolean;
4480
4305
  /**
4481
- * Define o identificador do contêiner de elementos customizados da `Taskbar`.
4306
+ * Define o identificador do container de elementos customizados da Taskbar.
4482
4307
  */
4483
4308
  "taskbarCustomContainerId"?: string;
4484
4309
  /**
4485
- * Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões.
4310
+ * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
4486
4311
  */
4487
4312
  "taskbarManager"?: TaskbarManager;
4488
4313
  /**
4489
- * Define o nome do slot para elementos customizados na `Taskbar` principal do componente.
4314
+ * Nome do slot de elementos customizados da Taskbar principal do componente.
4490
4315
  */
4491
4316
  "topTaskbarCustomSlotId"?: string;
4492
4317
  /**
4493
- * Quando `true`, a tecla ENTER navega entre as células como a tecla TAB.
4318
+ * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
4494
4319
  */
4495
4320
  "useEnterLikeTab"?: boolean;
4496
4321
  /**
4497
- * Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`.
4322
+ * Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F
4498
4323
  */
4499
4324
  "useSearchColumn"?: boolean;
4500
4325
  }
@@ -4885,79 +4710,75 @@ declare namespace LocalJSX {
4885
4710
  }
4886
4711
  interface SnkTaskbar {
4887
4712
  /**
4888
- * @description Lista de ações a serem exibidas no botão "Mais opções".
4713
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
4889
4714
  */
4890
4715
  "actionsList"?: Array<Action>;
4891
4716
  /**
4892
- * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
4717
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
4893
4718
  */
4894
4719
  "actionsSettingsList"?: Array<Action>;
4895
4720
  /**
4896
- * @description Define o alinhamento dos itens da barra de tarefas à direita.
4721
+ * Usado para determinar O alinhamento dos items na taskbar.
4897
4722
  */
4898
4723
  "alignRigth"?: boolean;
4899
4724
  /**
4900
- * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas.
4725
+ * Lista separada por virgula, contendo todos os elementos a serem criados.
4901
4726
  */
4902
4727
  "buttons"?: string;
4903
4728
  /**
4904
- * @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.
4729
+ * Usado para guardar ou recuperar as configurações do formulário.
4905
4730
  */
4906
4731
  "configName"?: string;
4907
4732
  /**
4908
- * @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.
4733
+ * 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.
4909
4734
  */
4910
4735
  "customButtons"?: Map<string, CustomButton>;
4911
4736
  /**
4912
- * @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.
4913
- * @example Elementos customizados na Taskbar da aba de detalhes.
4737
+ * 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.
4914
4738
  */
4915
4739
  "customContainerId"?: string;
4916
4740
  /**
4917
- * @description Define o identificador do slot que recebe elementos personalizados.
4741
+ * Usado para determinar o identificador do slot que recebe elementos personalizados.
4918
4742
  */
4919
4743
  "customSlotId"?: string;
4920
4744
  /**
4921
- * @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).
4745
+ * Instância do DataUnit.
4922
4746
  */
4923
4747
  "dataUnit"?: DataUnit;
4924
4748
  /**
4925
- * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
4749
+ * Array contendo todos os botões a serem desabilitados.
4926
4750
  */
4927
4751
  "disabledButtons"?: Array<string>;
4928
4752
  /**
4929
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4753
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4930
4754
  */
4931
4755
  "messagesBuilder"?: SnkMessageBuilder;
4932
4756
  /**
4933
- * @description Emitido sempre que um botão ou uma ação da barra de tarefas é clicado.
4934
- * @eventProperty
4757
+ * Emitido sempre que houver click de botão ou ação.
4935
4758
  */
4936
4759
  "onActionClick"?: (event: SnkTaskbarCustomEvent<string>) => void;
4937
4760
  /**
4938
- * @description Emitido quando uma ação de salvar é iniciada pela barra de tarefas, indicando um estado de bloqueio para evitar ações concorrentes.
4939
- * @eventProperty
4761
+ * Emitido sempre que um save é iniciado pela taskbar.
4940
4762
  */
4941
4763
  "onTaskbarSaveLocker"?: (event: SnkTaskbarCustomEvent<void>) => void;
4942
4764
  /**
4943
- * @description Emitido quando a ação de salvar é concluída ou cancelada, liberando o estado de bloqueio.
4944
- * @eventProperty
4765
+ * Emitido sempre que o ocorre alguma action que libera o save.
4945
4766
  */
4946
4767
  "onTaskbarSaveUnlocker"?: (event: SnkTaskbarCustomEvent<void>) => void;
4947
4768
  /**
4948
- * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens.
4769
+ * Define como será o comportamento da taskbar quando ocorrer overflow
4949
4770
  */
4950
4771
  "overflowStrategy"?: 'hiddenItems' | 'none';
4951
4772
  /**
4952
- * @description Altera o modo de apresentação dos botões da barra de tarefas.
4773
+ * Altera o modo de apresentação dos botões do snk-taskbar.
4953
4774
  */
4954
4775
  "presentationMode"?: PresentationMode1;
4955
4776
  /**
4956
- * @description Define qual botão deve ter a aparência de destaque (primário).
4777
+ * Determina qual botão deve ter aparência primária.
4957
4778
  */
4958
4779
  "primaryButton"?: string;
4959
4780
  /**
4960
- * @description Identificador de recursos, como configurações e permissões de acesso.
4781
+ * Identificador de recursos como configurações e acesso.
4961
4782
  */
4962
4783
  "resourceID"?: string;
4963
4784
  }