@sankhyalabs/sankhyablocks 9.2.0-dev.1 → 9.2.0-dev.10

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