@sankhyalabs/sankhyablocks 9.2.0-dev.14 → 9.2.0-dev.2

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 (64) hide show
  1. package/dist/cjs/loader.cjs.js +1 -1
  2. package/dist/cjs/sankhyablocks.cjs.js +1 -1
  3. package/dist/cjs/snk-application.cjs.entry.js +3 -0
  4. package/dist/cjs/snk-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 -25
  8. package/dist/cjs/snk-form_2.cjs.entry.js +1 -27
  9. package/dist/cjs/snk-grid.cjs.entry.js +7 -55
  10. package/dist/cjs/snk-personalized-filter.cjs.entry.js +2 -10
  11. package/dist/cjs/snk-simple-bar.cjs.entry.js +5 -5
  12. package/dist/cjs/snk-simple-crud.cjs.entry.js +8 -45
  13. package/dist/collection/components/snk-application/snk-application.js +2 -0
  14. package/dist/collection/components/snk-data-unit/snk-data-unit.js +28 -173
  15. package/dist/collection/components/snk-filter-bar/snk-filter-bar.js +63 -210
  16. package/dist/collection/components/snk-form/snk-form.js +22 -133
  17. package/dist/collection/components/snk-grid/snk-grid.js +83 -333
  18. package/dist/collection/components/snk-personalized-filter/snk-personalized-filter.js +21 -83
  19. package/dist/collection/components/snk-simple-bar/snk-simple-bar.js +9 -9
  20. package/dist/collection/components/snk-simple-crud/snk-simple-crud.js +119 -414
  21. package/dist/collection/components/snk-taskbar/snk-taskbar.js +36 -102
  22. package/dist/collection/lib/licenses/sankhyalicense.module.js +1 -0
  23. package/dist/components/snk-application2.js +3 -0
  24. package/dist/components/snk-data-unit2.js +1 -11
  25. package/dist/components/snk-filter-bar2.js +15 -26
  26. package/dist/components/snk-form.js +2 -29
  27. package/dist/components/snk-grid2.js +7 -57
  28. package/dist/components/snk-personalized-filter2.js +2 -10
  29. package/dist/components/snk-simple-bar2.js +5 -5
  30. package/dist/components/snk-simple-crud2.js +8 -45
  31. package/dist/esm/loader.js +1 -1
  32. package/dist/esm/sankhyablocks.js +1 -1
  33. package/dist/esm/snk-application.entry.js +3 -0
  34. package/dist/esm/snk-data-exporter.entry.js +1 -1
  35. package/dist/esm/{snk-data-unit-d31619fb.js → snk-data-unit-b7e6e7a6.js} +1 -11
  36. package/dist/esm/snk-data-unit.entry.js +1 -1
  37. package/dist/esm/snk-filter-bar_4.entry.js +15 -25
  38. package/dist/esm/snk-form_2.entry.js +1 -27
  39. package/dist/esm/snk-grid.entry.js +7 -55
  40. package/dist/esm/snk-personalized-filter.entry.js +2 -10
  41. package/dist/esm/snk-simple-bar.entry.js +5 -5
  42. package/dist/esm/snk-simple-crud.entry.js +8 -45
  43. package/dist/sankhyablocks/p-012208e0.entry.js +1 -0
  44. package/dist/sankhyablocks/{p-a2e8c7a7.entry.js → p-158adf33.entry.js} +1 -1
  45. package/dist/sankhyablocks/p-81769310.entry.js +11 -0
  46. package/dist/sankhyablocks/{p-69b815ab.entry.js → p-8d1508aa.entry.js} +1 -1
  47. package/dist/sankhyablocks/p-a86eee47.entry.js +1 -0
  48. package/dist/sankhyablocks/p-fa18530e.entry.js +1 -0
  49. package/dist/sankhyablocks/sankhyablocks.esm.js +1 -1
  50. package/dist/types/components/snk-data-unit/snk-data-unit.d.ts +3 -46
  51. package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts +28 -45
  52. package/dist/types/components/snk-form/snk-form.d.ts +4 -29
  53. package/dist/types/components/snk-grid/snk-grid.d.ts +45 -104
  54. package/dist/types/components/snk-personalized-filter/snk-personalized-filter.d.ts +5 -53
  55. package/dist/types/components/snk-simple-bar/snk-simple-bar.d.ts +15 -15
  56. package/dist/types/components/snk-simple-crud/snk-simple-crud.d.ts +43 -100
  57. package/dist/types/components/snk-taskbar/snk-taskbar.d.ts +21 -23
  58. package/dist/types/components.d.ts +224 -511
  59. package/package.json +3 -4
  60. package/dist/sankhyablocks/p-51464e95.entry.js +0 -1
  61. package/dist/sankhyablocks/p-665dd170.entry.js +0 -11
  62. package/dist/sankhyablocks/p-6fa3d474.entry.js +0 -1
  63. package/dist/sankhyablocks/p-cf7063a4.entry.js +0 -1
  64. /package/dist/sankhyablocks/{p-8b601472.js → p-0e495575.js} +0 -0
@@ -52,7 +52,6 @@ import { IExportConfig } from "./components/snk-data-exporter/data/export-config
52
52
  import { IExpressionGroup, IExpressionItem } from "./components/snk-personalized-filter/interfaces/IExpressionItem";
53
53
  import { IPersonalizedFilter } from "./components/snk-personalized-filter/interfaces/IPersonalizedFilter";
54
54
  import { SnkApplication } from "./components/snk-application/snk-application";
55
- import { Filter as Filter1 } from "@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata";
56
55
  import { SnkFilterModalFactoryParams } from "./components/snk-filter-bar/utils/SnkFilterModalFactory";
57
56
  import { EPresentationMode } from "./components/snk-filter-bar/filter-item/editors/enum/presentationMode";
58
57
  import { FilterFieldsDataSource, IFilterField, IFilterLink } from "./components/snk-filter-field-search/interfaces";
@@ -902,102 +901,75 @@ export namespace Components {
902
901
  interface SnkDataUnit {
903
902
  /**
904
903
  * Executado após a ação de salvar.
905
- * @param dataUnit - A instância do DataUnit.
906
- * @returns
907
904
  */
908
905
  "afterSave": (dataUnit: DataUnit) => void;
909
906
  /**
910
907
  * 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.
911
- * @param dataUnit - A instância do DataUnit.
912
- * @returns `false` para cancelar a ação, `true` para continuar.
913
908
  */
914
909
  "beforeSave": (dataUnit: DataUnit) => boolean | Promise<boolean>;
915
910
  /**
916
911
  * Usado para obter configuração de metadados.
917
- * @type {string}
918
912
  */
919
913
  "configName": string;
920
914
  /**
921
915
  * Controla o estado atual dos dados.
922
- * @type {DataState}
923
916
  */
924
917
  "dataState": DataState;
925
918
  /**
926
919
  * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
927
- * @type {DataUnit}
928
920
  */
929
921
  "dataUnit": DataUnit;
930
922
  /**
931
923
  * Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade.
932
- * @type {string}
933
924
  */
934
925
  "dataUnitName": string;
935
926
  /**
936
927
  * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
937
- * @type {string}
938
928
  */
939
929
  "domainMessagesBuilder": string;
940
930
  /**
941
931
  * Determina qual a entidade que representa os dados em questão.
942
- * @type {string}
943
932
  */
944
933
  "entityName": string;
945
934
  /**
946
935
  * Obtém o dataUnit.
947
- * @returns Uma promessa que resolve com a instância do DataUnit.
948
- * @async
949
936
  */
950
937
  "getDataUnit": () => Promise<DataUnit>;
951
938
  /**
952
939
  * Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
953
- * @returns Uma promessa que resolve com um array de nomes de campos.
954
- * @async
955
940
  */
956
941
  "getFieldsWithRmPrecision": () => Promise<string[]>;
957
942
  /**
958
943
  * Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
959
- * @returns Uma promessa que resolve com um array de nomes de campos.
960
- * @async
961
944
  */
962
945
  "getFieldsWithRmp": () => Promise<string[]>;
963
946
  /**
964
947
  * Busca os metadados da linha selecionada.
965
- * @param record - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado.
966
- * @returns Uma promessa que resolve com os metadados da linha.
967
- * @async
968
948
  */
969
949
  "getRowMetadata": (record?: Record | string) => Promise<RowMetadata>;
970
950
  /**
971
951
  * Método que retorna a lista de IDs dos registros selecionados.
972
- * @returns Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
973
- * @async
952
+ * @returns Retorna a lista de IDs dos registros selecionados.
974
953
  */
975
954
  "getSelectedRecordsIDsInfo": () => Promise<Array<IRecordID>>;
976
955
  /**
977
956
  * Responsável por evitar a mensagem de sucesso ao salvar.
978
- * @type {boolean}
979
957
  */
980
958
  "ignoreSaveMessage": boolean;
981
959
  /**
982
960
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
983
- * @type {SnkMessageBuilder}
984
961
  */
985
962
  "messagesBuilder": SnkMessageBuilder;
986
963
  /**
987
964
  * Determina quantas linhas são retornadas por página.
988
- * @type {number}
989
- * @default 150
990
965
  */
991
966
  "pageSize": number;
992
967
  /**
993
968
  * Identificador de recursos como configurações e acesso.
994
- * @type {string}
995
969
  */
996
970
  "resourceID": string;
997
971
  /**
998
972
  * Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição.
999
- * @type {boolean}
1000
- * @default true
1001
973
  */
1002
974
  "useCancelConfirm": boolean;
1003
975
  }
@@ -1200,99 +1172,83 @@ export namespace Components {
1200
1172
  }
1201
1173
  interface SnkFilterBar {
1202
1174
  /**
1203
- * @description Adiciona um item de filtro.
1204
- * @async
1205
- * @param filterItem - Item a ser adicionado, caso o item já exista com o ID, ele não será adicionado novamente.
1206
- * @return Retorna uma Promise que resolve quando o item for adicionado.
1175
+ * Adiciona um item de filtro.
1176
+ * @param filterItem - Item a ser adicionado, caso o item já exista com o ID ele não será adicionado novamente
1207
1177
  */
1208
1178
  "addFilterItem": (filterItem: SnkFilterItemConfig) => Promise<void>;
1209
1179
  /**
1210
- * @description Função chamada depois de aplicar os filtros.
1180
+ * Função chamada depois de aplicar os filtros.
1211
1181
  */
1212
1182
  "afterApplyConfig"?: () => void;
1213
1183
  /**
1214
- * @description Define se a carga dos dados será feita assim que o componente for carregado.
1184
+ * Define se a carga dos dados será feita assim que o componente for carregado.
1215
1185
  */
1216
1186
  "autoLoad"?: boolean;
1217
1187
  /**
1218
- * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
1188
+ * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
1219
1189
  */
1220
1190
  "configName": string;
1221
1191
  /**
1222
- * @description Loader customizado para carregar as configurações.
1223
- * @param configName - Nome da configuração.
1224
- * @param resourceId - ID do recurso.
1225
- * @param options - Opções adicionais.
1226
- * @returns Retorna a configuração dos filtros.
1192
+ * Loader customizado para carregar as configurações
1227
1193
  */
1228
1194
  "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
1229
1195
  /**
1230
- * @description Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros.
1196
+ * Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros.
1231
1197
  */
1232
1198
  "dataUnit": DataUnit;
1233
1199
  /**
1234
- * @description Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados).
1200
+ * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados).
1235
1201
  */
1236
1202
  "disablePersonalizedFilter": boolean;
1237
1203
  /**
1238
- * @description Define se o componente deve usar o LockManager para controle de carregamento.
1204
+ * Define se o componente deve usar o LockManager para controle de carregamento
1239
1205
  */
1240
1206
  "enableLockManagerLoadingComp"?: boolean;
1241
1207
  /**
1242
- * @description Chave da configuração legada da barra de filtros.
1208
+ * Chave da configuração legado da barra de filtros.
1243
1209
  */
1244
1210
  "filterBarLegacyConfigName": string;
1245
1211
  /**
1246
- * @description Lista todos os filtros disponíveis ao usuário.
1212
+ * Lista todos os filtros disponíveis ao usuário.
1247
1213
  */
1248
1214
  "filterConfig": Array<SnkFilterItemConfig>;
1249
1215
  /**
1250
- * @description Retorna um item de filtro pelo ID.
1251
- * @async
1252
- * @param id - ID do item de filtro.
1253
- * @returns O item de filtro correspondente ou undefined se não for encontrado.
1216
+ * Retorna um item de filtro pelo ID.
1254
1217
  */
1255
1218
  "getFilterItem": (id: string) => Promise<SnkFilterItemConfig | undefined>;
1256
- "getFilters": () => Promise<Filter1[]>;
1257
1219
  /**
1258
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
1220
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
1259
1221
  */
1260
1222
  "messagesBuilder": SnkMessageBuilder;
1261
1223
  /**
1262
- * @description Modo de apresentação da barra de filtros.
1224
+ * Modo de apresentação da filterbar.
1263
1225
  */
1264
1226
  "mode": "regular" | "button" | "hidden";
1265
1227
  /**
1266
- * @description Faz o recarregamento da barra de filtros buscando o state no servidor.
1267
- * @async
1268
- * @return Retorna uma Promise que resolve quando o recarregamento for concluído.
1228
+ * Faz o recarregamento da filterbar buscando o state no servidor.
1269
1229
  */
1270
1230
  "reload": () => Promise<void>;
1271
1231
  /**
1272
- * @description Remove um item de filtro.
1273
- * @async
1274
- * @param filterID - ID do item a ser removido.
1275
- * @returns Retorna o item de filtro removido, ou undefined caso não seja encontrado.
1232
+ * Remove um item de filtro.
1233
+ * @param filterID - ID do a ser adicionado
1234
+ * @returns - Retorna o item de filtro removido, ou undefined caso não encontrado.
1276
1235
  */
1277
1236
  "removeFilterItem": (filterID: string) => Promise<SnkFilterItemConfig | undefined>;
1278
1237
  /**
1279
- * @description Identificador de recursos como configurações e acesso.
1238
+ * Identificador de recursos como configurações e acesso.
1280
1239
  */
1281
1240
  "resourceID": string;
1282
1241
  /**
1283
- * @description Abre o modal de filtros.
1284
- * @async
1242
+ * Abre o modal de filtros
1285
1243
  */
1286
1244
  "showFilterModal": () => Promise<void>;
1287
1245
  /**
1288
- * @description Título que será apresentado na barra de filtros.
1246
+ * Título que será apresentado na barra de filtros
1289
1247
  */
1290
1248
  "title": string;
1291
1249
  /**
1292
- * @description Atualiza um item do filtro.
1293
- * @async
1294
- * @param newFilterItem - Item com as informações atualizadas, caso o item não seja encontrado no array, ele não será modificado.
1295
- * @return Retorna uma Promise que resolve quando a atualização for concluída.
1250
+ * Atualiza um item do filtro.
1251
+ * @param filterItem - Item com as informações atualizadas, caso o item não seja encontrado no array ele mão será modificado
1296
1252
  */
1297
1253
  "updateFilterItem": (newFilterItem: SnkFilterItemConfig) => Promise<void>;
1298
1254
  }
@@ -1571,11 +1527,7 @@ export namespace Components {
1571
1527
  }
1572
1528
  interface SnkForm {
1573
1529
  /**
1574
- * Registra um editor customizado para campos do formulário.
1575
- * @async
1576
- * @param fieldName - Nome do campo.
1577
- * @param customEditor - Editor customizado.
1578
- * @returns
1530
+ * Registra um editor customizado para campos da grade e formulário.
1579
1531
  */
1580
1532
  "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise<void>;
1581
1533
  /**
@@ -1583,13 +1535,11 @@ export namespace Components {
1583
1535
  */
1584
1536
  "configName": string;
1585
1537
  /**
1586
- * Chave da configuração legada do formulário.
1538
+ * Chave da configuração legado do formulário.
1587
1539
  */
1588
1540
  "formLegacyConfigName": string;
1589
1541
  /**
1590
1542
  * Fecha a janela de configurações do formulário.
1591
- * @async
1592
- * @returns
1593
1543
  */
1594
1544
  "hideConfig": () => Promise<void>;
1595
1545
  /**
@@ -1606,26 +1556,12 @@ export namespace Components {
1606
1556
  "resourceID": string;
1607
1557
  /**
1608
1558
  * Altera/adiciona uma propriedade nos metadados do campo.
1609
- * @async
1610
- * @param fieldName - Nome do campo.
1611
- * @param propName - Nome da propriedade.
1612
- * @param value - Valor da propriedade.
1613
- * @returns
1614
1559
  */
1615
1560
  "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
1616
1561
  /**
1617
1562
  * Exibe a janela de configurações do formulário.
1618
- * @async
1619
- * @returns
1620
1563
  */
1621
1564
  "showConfig": () => Promise<void>;
1622
- /**
1623
- * Valida o formulário.
1624
- * @async
1625
- * @returns
1626
- * @description Este método executa a validação do formulário, verificando se todos os campos estão preenchidos corretamente de acordo com as regras definidas. Se a validação falhar, uma exceção será lançada com os detalhes dos erros encontrados. Caso contrário, o método será resolvido sem erros.
1627
- */
1628
- "validate": () => Promise<void>;
1629
1565
  }
1630
1566
  interface SnkFormConfig {
1631
1567
  /**
@@ -1737,72 +1673,52 @@ export namespace Components {
1737
1673
  }
1738
1674
  interface SnkGrid {
1739
1675
  /**
1740
- * Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`.
1676
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
1741
1677
  */
1742
1678
  "actionsList": Array<Action>;
1743
1679
  /**
1744
- * Registra um editor customizado para um campo da grade ou formulário.
1745
- * @async
1746
- * @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.
1747
- * @param fieldName O nome do campo que receberá o editor customizado.
1748
- * @param customEditor A instância do editor customizado.
1749
- * @param detailContext O contexto de detalhe onde o editor será aplicado (opcional).
1750
- * @returns Uma promessa que é resolvida quando o editor é registrado.
1680
+ * Registra um editor customizado para campos da grade e formulário
1751
1681
  */
1752
1682
  "addCustomEditor": (fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>;
1753
1683
  /**
1754
- * Registra um formatador de valor customizado para uma coluna da grade.
1755
- * @async
1756
- * @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
1757
- * @param columnName O nome da coluna que receberá o formatador.
1758
- * @param customFormatter A instância do formatador de valor.
1759
- * @returns Uma promessa que é resolvida quando o formatador é registrado.
1684
+ * Registra um formatador de valores para uma coluna da grid.
1760
1685
  */
1761
1686
  "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise<void>;
1762
1687
  /**
1763
- * Registra um renderizador customizado para uma coluna da grade.
1764
- * @async
1765
- * @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
1766
- * @param fieldName O nome do campo (coluna) que receberá o renderizador customizado.
1767
- * @param customRender A instância do renderizador customizado.
1768
- * @param detailContext O contexto de detalhe onde o renderizador será aplicado (opcional).
1769
- * @returns Uma promessa que é resolvida quando o renderizador é registrado.
1688
+ * Registra um render customizado para colunas da grid.
1770
1689
  */
1771
1690
  "addGridCustomRender": (fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>;
1772
1691
  /**
1773
- * Define se a grade receberá o foco automaticamente ao ser carregada.
1692
+ * Define se a grid será focada ao ser carregada.
1774
1693
  */
1775
1694
  "autoFocus"?: boolean;
1776
1695
  /**
1777
- * Define se os dados serão carregados automaticamente na inicialização do componente.
1696
+ * Define se a carga dos dados será feita assim que o componente for carregado.
1778
1697
  */
1779
1698
  "autoLoad"?: boolean;
1780
1699
  /**
1781
- * Define se a edição de dados na grade está habilitada.
1700
+ * Define se a edição está habilitada na grid.
1782
1701
  */
1783
1702
  "canEdit": boolean;
1784
- /**
1785
- * Define o data source para o filtro de colunas.
1786
- */
1787
1703
  "columnFilterDataSource": IMultiSelectionListDataSource;
1788
1704
  /**
1789
- * Define se a grade deve ser exibida em modo compacto.
1705
+ * Define se a grade deve ser exibida em modo compacto
1790
1706
  */
1791
1707
  "compact": boolean;
1792
1708
  /**
1793
- * Nome usado para salvar e recuperar a configuração da grade.
1709
+ * Nome usado para salvar/recuperar a configuração.
1794
1710
  */
1795
1711
  "configName": string;
1796
1712
  /**
1797
- * 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).
1713
+ * 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).
1798
1714
  */
1799
1715
  "disablePersonalizedFilter": boolean;
1800
1716
  /**
1801
- * Habilita a inserção de registros diretamente na grade.
1717
+ * Ativa inserção de registros no modo grade.
1802
1718
  */
1803
1719
  "enableGridInsert"?: boolean;
1804
1720
  /**
1805
- * Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
1721
+ * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
1806
1722
  */
1807
1723
  "enableLockManagerLoadingComp"?: boolean;
1808
1724
  /**
@@ -1810,37 +1726,31 @@ export namespace Components {
1810
1726
  */
1811
1727
  "enableLockManagerTaskbarClick"?: boolean;
1812
1728
  /**
1813
- * Chave da configuração legada da barra de filtros.
1729
+ * Chave da configuração legado da barra de filtros.
1814
1730
  */
1815
1731
  "filterBarLegacyConfigName": string;
1816
1732
  /**
1817
- * Título que será apresentado na barra de filtros.
1733
+ * Título que será apresentado na barra de filtros
1818
1734
  */
1819
1735
  "filterBarTitle": string;
1820
1736
  /**
1821
- * Retorna o elemento da barra de filtros da grade.
1822
- * @async
1823
- * @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.
1824
- * @returns O elemento da barra de filtros.
1737
+ * Retorna o elemento da filter-bar da grade.
1825
1738
  */
1826
1739
  "getFilterBar": () => Promise<HTMLSnkFilterBarElement>;
1827
1740
  /**
1828
- * Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade.
1741
+ * Nome do slot de elementos customizados da Taskbar do cabeçalho da grade.
1829
1742
  */
1830
1743
  "gridHeaderCustomSlotId": string;
1831
1744
  /**
1832
- * Chave da configuração legada da grade.
1745
+ * Chave da configuração legado da grade.
1833
1746
  */
1834
1747
  "gridLegacyConfigName": string;
1835
1748
  /**
1836
1749
  * Fecha a janela de configurações da grade.
1837
- * @async
1838
- * @description Este método fecha o pop-up de configuração de colunas da grade.
1839
- * @returns Uma promessa que é resolvida quando a janela de configuração é fechada.
1840
1750
  */
1841
1751
  "hideConfig": () => Promise<void>;
1842
1752
  /**
1843
- * Determina se a grade está vinculada a um detalhe de outra tela.
1753
+ * Determina se a grade está vinculada a um detalhe.
1844
1754
  */
1845
1755
  "isDetail": boolean;
1846
1756
  /**
@@ -1848,119 +1758,92 @@ export namespace Components {
1848
1758
  */
1849
1759
  "messagesBuilder": SnkMessageBuilder;
1850
1760
  /**
1851
- * Habilita a edição de múltiplos registros simultaneamente.
1761
+ * Habilita a edição de múltiplos registros simultâneos.
1852
1762
  */
1853
1763
  "multipleEditionEnabled": boolean;
1854
1764
  /**
1855
- * Determina se a seleção de múltiplas linhas é permitida.
1765
+ * Determina se pode haver mais de uma linha selecionada.
1856
1766
  */
1857
1767
  "multipleSelection": boolean;
1858
1768
  /**
1859
- * 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).
1769
+ * 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)
1860
1770
  */
1861
1771
  "outlineMode"?: boolean;
1862
1772
  /**
1863
- * Define o modo de exibição do contador de paginação.
1773
+ * Define se a grid será focada ao ser carregada.
1864
1774
  */
1865
1775
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
1866
1776
  /**
1867
- * Altera o modo de apresentação dos botões do `snk-taskbar`.
1777
+ * Altera o modo de apresentação dos botões do snk-taskbar.
1868
1778
  */
1869
1779
  "presentationMode": PresentationMode1;
1870
1780
  /**
1871
- * Validador responsável por verificar a integridade dos dados de um registro.
1781
+ * Validador responsável por checar a integridade das informações do registro.
1872
1782
  */
1873
1783
  "recordsValidator": IRecordValidator;
1874
- "refreshColumnFilterDataSource": () => Promise<void>;
1875
- /**
1876
- * Recarrega a configuração da grade.
1877
- * @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.
1878
- */
1879
1784
  "reloadConfig": () => Promise<void>;
1880
1785
  /**
1881
- * Recarrega a barra de filtros da grade, buscando o estado do servidor.
1882
- * @async
1883
- * @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
1884
- * @returns Uma promessa que é resolvida quando a barra de filtros é recarregada.
1786
+ * Faz o recarregamento da filter-bar da grade buscando o state no servidor.
1885
1787
  */
1886
1788
  "reloadFilterBar": () => Promise<void>;
1887
1789
  /**
1888
- * Remove um formatador de valor customizado de uma coluna da grade.
1889
- * @async
1890
- * @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
1891
- * @param columnName O nome da coluna da qual o formatador será removido.
1892
- * @returns Uma promessa que é resolvida quando o formatador é removido.
1790
+ * Remove o formatador de valores de uma coluna da grid.
1893
1791
  */
1894
1792
  "removeCustomValueFormatter": (columnName: string) => Promise<void>;
1895
1793
  /**
1896
- * Identificador de recursos, como configurações e permissões de acesso.
1794
+ * Identificador de recursos como configurações e acesso.
1897
1795
  */
1898
1796
  "resourceID": string;
1899
1797
  /**
1900
- * Configuração do toast de seleção da grade.
1798
+ * Configuração da seleção de grade no toast.
1901
1799
  */
1902
1800
  "selectionToastConfig": ISelectionToastConfig;
1903
1801
  /**
1904
- * Define a configuração da grade.
1905
- * @async
1906
- * @description Aplica uma nova configuração de colunas e ordenação à grade.
1907
- * @param config O objeto de configuração a ser aplicado na grade.
1908
- * @returns Uma promessa que é resolvida quando a configuração é aplicada.
1802
+ * Atribui o valor da configuração da grade.
1909
1803
  */
1910
1804
  "setConfig": (config: IGridConfig) => Promise<void>;
1911
1805
  /**
1912
1806
  * Atribui o foco para a grade.
1913
- * @async
1914
- * @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
1915
- * @returns Uma promessa que é resolvida quando o foco é atribuído.
1916
1807
  */
1917
1808
  "setFocus": () => Promise<void>;
1918
1809
  /**
1919
1810
  * Exibe a janela de configurações da grade.
1920
- * @async
1921
- * @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.
1922
- * @returns Uma promessa que é resolvida quando a janela de configuração é exibida.
1923
1811
  */
1924
1812
  "showConfig": () => Promise<void>;
1925
1813
  /**
1926
- * Define a configuração de cores para a coluna de status.
1927
- * @example ```json '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' ```
1814
+ * Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
1928
1815
  */
1929
1816
  "statusResolver": IStatusResolver | StatusResolverFunction;
1930
1817
  /**
1931
- * Define o modo de exportação dos dados.
1818
+ * Modo de exportação dos dados.
1932
1819
  */
1933
1820
  "strategyExporter": IExporterStrategyMode;
1934
1821
  /**
1935
- * Informa se a coluna de checkbox deve ser suprimida.
1822
+ * Informa se a coluna de chechbox deve ser suprimida
1936
1823
  */
1937
1824
  "suppressCheckboxColumn": boolean;
1938
1825
  /**
1939
- * Informa se a grade deve suprimir o filtro de coluna.
1940
- */
1941
- "suppressFilterColumn"?: boolean;
1942
- /**
1943
- * Define se a grade deve suprimir a barra de rolagem horizontal.
1826
+ * Define se a grade deve suprimir o scroll horizontal.
1944
1827
  */
1945
1828
  "suppressHorizontalScroll": boolean;
1946
1829
  /**
1947
- * Define o identificador do contêiner de elementos customizados da `Taskbar`.
1830
+ * Define o identificador do container de elementos customizados da Taskbar.
1948
1831
  */
1949
1832
  "taskbarCustomContainerId": string;
1950
1833
  /**
1951
- * Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões.
1834
+ * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
1952
1835
  */
1953
1836
  "taskbarManager": TaskbarManager;
1954
1837
  /**
1955
- * Define o nome do slot para elementos customizados na `Taskbar` principal do componente.
1838
+ * Nome do slot de elementos customizados da Taskbar principal do componente.
1956
1839
  */
1957
1840
  "topTaskbarCustomSlotId": string;
1958
1841
  /**
1959
- * Quando `true`, a tecla ENTER navega entre as células como a tecla TAB.
1842
+ * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
1960
1843
  */
1961
1844
  "useEnterLikeTab": boolean;
1962
1845
  /**
1963
- * Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`.
1846
+ * Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F
1964
1847
  */
1965
1848
  "useSearchColumn": boolean;
1966
1849
  }
@@ -2090,40 +1973,28 @@ export namespace Components {
2090
1973
  }
2091
1974
  interface SnkPersonalizedFilter {
2092
1975
  /**
2093
- * Nome da configuração, utilizado para distinguir múltiplas instâncias do componente.
2094
- * @property
1976
+ * Nome da configuração. Serve para distinguir várias instâncias do componente.
2095
1977
  */
2096
1978
  "configName": string;
2097
- /**
2098
- * Cria um novo filtro personalizado caso não exista nenhum.
2099
- * @method
2100
- * @returns
2101
- */
2102
1979
  "createPersonalizedFilter": () => Promise<void>;
2103
1980
  /**
2104
- * URI da entidade utilizada para buscar os campos disponíveis para filtro.
2105
- * @property
1981
+ * Responsável por receber a URI da entidade.
2106
1982
  */
2107
1983
  "entityUri": string;
2108
1984
  /**
2109
- * Identificador do filtro a ser carregado.
2110
- * @property
1985
+ * Id do filtro que será carregado.
2111
1986
  */
2112
1987
  "filterId": string;
2113
1988
  /**
2114
- * Indica se o filtro é o filtro padrão do sistema.
2115
- * @property
2116
- * @default false
1989
+ * Define se o filtro em questão é um filtro padrão.
2117
1990
  */
2118
1991
  "isDefaultFilter": boolean;
2119
1992
  /**
2120
1993
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2121
- * @property
2122
1994
  */
2123
1995
  "messagesBuilder": SnkMessageBuilder;
2124
1996
  /**
2125
- * Identificador do recurso utilizado para salvar e recuperar filtros.
2126
- * @property
1997
+ * Nome da configuração. Serve para distinguir várias instâncias do componente.
2127
1998
  */
2128
1999
  "resourceID": string;
2129
2000
  }
@@ -2194,11 +2065,11 @@ export namespace Components {
2194
2065
  }
2195
2066
  interface SnkSimpleBar {
2196
2067
  /**
2197
- * Define os itens que serão apresentados no breadcrumb.
2068
+ * Define os itens que serão apresentados pelo breadcrumb
2198
2069
  */
2199
2070
  "breadcrumbItens": Array<IBreadcrumbItem>;
2200
2071
  /**
2201
- * Define o título do header.
2072
+ * Define o título do header
2202
2073
  */
2203
2074
  "label": string;
2204
2075
  /**
@@ -2208,196 +2079,138 @@ export namespace Components {
2208
2079
  }
2209
2080
  interface SnkSimpleCrud {
2210
2081
  /**
2211
- * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
2082
+ * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
2212
2083
  */
2213
2084
  "actionsList": Array<Action>;
2214
2085
  /**
2215
- * @description Registra um editor customizado para campos da grade e do formulário.
2216
- * @param fieldName - O nome do campo.
2217
- * @param customEditor - A instância do editor customizado.
2218
- * @returns
2086
+ * Registra um editor customizado para campos da grade e formulário.
2219
2087
  */
2220
2088
  "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise<void>;
2221
2089
  /**
2222
- * @description Registra um formatador de valores para uma coluna da grade.
2223
- * @param columnName - O nome da coluna.
2224
- * @param customFormatter - A instância do formatador customizado.
2225
- * @returns
2090
+ * Registra um formatador de valores para uma coluna da grid.
2226
2091
  */
2227
2092
  "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise<void>;
2228
2093
  /**
2229
- * @description Registra um renderizador customizado para colunas da grade.
2230
- * @param fieldName - O nome do campo.
2231
- * @param customRender - A instância do renderizador customizado.
2232
- * @returns
2094
+ * Registra um render customizado para colunas da grid.
2233
2095
  */
2234
2096
  "addGridCustomRender": (fieldName: string, customRender: ICustomRender) => Promise<void>;
2235
2097
  /**
2236
- * @description Define se a grade será focada ao ser carregada.
2098
+ * Define se a grid será focada ao ser carregada.
2237
2099
  */
2238
2100
  "autoFocus"?: boolean;
2239
2101
  /**
2240
- * @description Define se a carga dos dados será feita assim que o componente for carregado.
2102
+ * Define se a carga dos dados será feita assim que o componente for carregado.
2241
2103
  */
2242
2104
  "autoLoad"?: boolean;
2243
2105
  /**
2244
- * @description Usado para fechar o configurador do CRUD.
2245
- * @returns
2106
+ * Usado para fechar o configurator do CRUD
2246
2107
  */
2247
2108
  "closeConfigurator": () => Promise<void>;
2248
2109
  /**
2249
- * @description Usado para salvar as configurações dos blocos de construção.
2110
+ * Usado para salvar as configurações dos blocos de construção.
2250
2111
  */
2251
2112
  "configName": string;
2252
- /**
2253
- * @description Estado atual dos dados.
2254
- */
2255
2113
  "dataState": DataState1;
2256
- /**
2257
- * @description Instância do DataUnit a ser utilizada pelo componente.
2258
- */
2259
2114
  "dataUnit": DataUnit;
2260
2115
  /**
2261
- * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade).
2116
+ * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
2262
2117
  */
2263
2118
  "domainMessagesBuilder": string;
2264
- /**
2265
- * @description Habilita a inserção contínua de registros.
2266
- */
2267
2119
  "enableContinuousInsert": boolean;
2268
2120
  /**
2269
- * @description Ativa a inserção de registros no modo grade.
2121
+ * Ativa inserção de registros no modo grade.
2270
2122
  */
2271
2123
  "enableGridInsert"?: boolean;
2272
2124
  /**
2273
- * @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
2125
+ * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
2274
2126
  */
2275
2127
  "enableLockManagerLoadingComp"?: boolean;
2276
2128
  /**
2277
- * @description Ativa o gerenciamento de locks na grade pela Taskbar.
2129
+ * Ativa o gerenciamento de locks na grade pela Taskbar.
2278
2130
  */
2279
2131
  "enableLockManagerTaskbarClick"?: boolean;
2280
2132
  /**
2281
- * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD.
2133
+ * Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD
2282
2134
  */
2283
2135
  "entityName": string;
2284
- /**
2285
- * @description Configuração do formulário.
2286
- */
2287
2136
  "formConfig": IFormConfig;
2288
2137
  /**
2289
- * @description Chave da configuração legada do formulário.
2138
+ * Chave da configuração legado do formulário.
2290
2139
  */
2291
2140
  "formLegacyConfigName": string;
2292
- /**
2293
- * @description Obtém os registros do DataUnit.
2294
- * @returns Uma promessa que resolve com a lista de registros.
2295
- */
2296
2141
  "getRecords": () => Promise<Array<Record>>;
2297
2142
  /**
2298
- * @description Usado para alternar a visão entre GRID e FORM externamente.
2299
- * @param view - A visão para a qual navegar.
2300
- * @returns
2143
+ * Usado para alternar a visão entre GRID e FORM externamente.
2301
2144
  */
2302
2145
  "goToView": (view: VIEW_MODE) => Promise<void>;
2303
- /**
2304
- * @description Configuração da grade.
2305
- */
2306
2146
  "gridConfig": IGridConfig;
2307
2147
  /**
2308
- * @description Chave da configuração legada da grade.
2148
+ * Chave da configuração legado da grade.
2309
2149
  */
2310
2150
  "gridLegacyConfigName": string;
2311
2151
  /**
2312
- * @description Ignora os campos "somente leitura" no modo de inserção.
2152
+ * Ignora os campos "somente leitura" no modo de inserção.
2313
2153
  */
2314
2154
  "ignoreReadOnlyFormFields": boolean;
2315
2155
  /**
2316
- * @description Define se o LayoutFormConfig será exibido no configurador.
2156
+ * Define se o LayoutFormConfig será exibido no configurador.
2317
2157
  */
2318
2158
  "layoutFormConfig": boolean;
2319
2159
  /**
2320
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2160
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2321
2161
  */
2322
2162
  "messagesBuilder": SnkMessageBuilder;
2323
- /**
2324
- * @description Define o modo de operação do CRUD (servidor ou em memória).
2325
- */
2326
2163
  "mode": SIMPLE_CRUD_MODE;
2327
2164
  /**
2328
- * @description Habilita a edição de múltiplos registros simultâneos.
2165
+ * Habilita a edição de múltiplos registros simultâneos.
2329
2166
  */
2330
2167
  "multipleEditionEnabled": boolean;
2331
2168
  /**
2332
- * @description Determina se pode haver mais de uma linha selecionada na grade.
2169
+ * Determina se pode haver mais de uma linha selecionada na grade.
2333
2170
  */
2334
2171
  "multipleSelection": boolean;
2335
2172
  /**
2336
- * @description Usado para abrir o configurador do CRUD.
2337
- * @returns
2173
+ * Usado para abrir o configurator do CRUD
2338
2174
  */
2339
2175
  "openConfigurator": () => Promise<void>;
2340
2176
  /**
2341
- * @description Altera visualmente as sombras e bordas do componente. Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout). Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up).
2177
+ * 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)
2342
2178
  */
2343
2179
  "outlineMode"?: boolean;
2344
2180
  /**
2345
- * @description Determina quantas linhas são retornadas por página.
2181
+ * Determina quantas linhas são retornadas por página.
2346
2182
  */
2347
2183
  "pageSize": number;
2348
2184
  /**
2349
- * @description Define o modo de exibição do contador de paginação.
2185
+ * Define se a grid será focada ao ser carregada.
2350
2186
  */
2351
2187
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
2352
2188
  /**
2353
- * @description Remove o formatador de valores de uma coluna da grade.
2354
- * @param columnName - O nome da coluna.
2355
- * @returns
2189
+ * Remove o formatador de valores de uma coluna da grid.
2356
2190
  */
2357
2191
  "removeCustomValueFormatter": (columnName: string) => Promise<void>;
2358
2192
  /**
2359
- * @description Identificador de recursos como configurações e acesso.
2193
+ * Identificador de recursos como configurações e acesso.
2360
2194
  */
2361
2195
  "resourceID": string;
2362
2196
  /**
2363
- * @description Altera/adiciona uma propriedade nos metadados do campo.
2364
- * @param fieldName - O nome do campo.
2365
- * @param propName - O nome da propriedade.
2366
- * @param value - O valor da propriedade.
2367
- * @returns
2197
+ * Altera/adiciona uma propriedade nos metadados do campo.
2368
2198
  */
2369
2199
  "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
2370
- /**
2371
- * @description Define os metadados do DataUnit.
2372
- * @param metadata - Os metadados a serem definidos.
2373
- * @returns
2374
- */
2375
2200
  "setMetadata": (metadata: UnitMetadata) => Promise<void>;
2376
- /**
2377
- * @description Define os registros do DataUnit.
2378
- * @param records - Os registros a serem definidos.
2379
- * @returns
2380
- */
2381
2201
  "setRecords": (records: Array<Record>) => Promise<void>;
2382
2202
  /**
2383
- * @description Usado para exibir os botões de ação do snk-configurator.
2203
+ * Usado para exibir os botões de ação do snk-configurator.
2384
2204
  */
2385
2205
  "showConfiguratorButtons": boolean;
2386
2206
  /**
2387
- * @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
2207
+ * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
2388
2208
  */
2389
2209
  "taskbarManager": TaskbarManager;
2390
- /**
2391
- * @description Atualiza a configuração do formulário.
2392
- * @returns
2393
- */
2394
2210
  "updateConfig": () => Promise<void>;
2395
- /**
2396
- * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
2397
- */
2398
2211
  "useCancelConfirm": boolean;
2399
2212
  /**
2400
- * @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
2213
+ * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
2401
2214
  */
2402
2215
  "useEnterLikeTab": boolean;
2403
2216
  }
@@ -2421,64 +2234,63 @@ export namespace Components {
2421
2234
  }
2422
2235
  interface SnkTaskbar {
2423
2236
  /**
2424
- * @description Lista de ações a serem exibidas no botão "Mais opções".
2237
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
2425
2238
  */
2426
2239
  "actionsList": Array<Action>;
2427
2240
  /**
2428
- * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
2241
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
2429
2242
  */
2430
2243
  "actionsSettingsList": Array<Action>;
2431
2244
  /**
2432
- * @description Define o alinhamento dos itens da barra de tarefas à direita.
2245
+ * Usado para determinar O alinhamento dos items na taskbar.
2433
2246
  */
2434
2247
  "alignRigth": boolean;
2435
2248
  /**
2436
- * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas.
2249
+ * Lista separada por virgula, contendo todos os elementos a serem criados.
2437
2250
  */
2438
2251
  "buttons": string;
2439
2252
  /**
2440
- * @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.
2253
+ * Usado para guardar ou recuperar as configurações do formulário.
2441
2254
  */
2442
2255
  "configName": string;
2443
2256
  /**
2444
- * @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.
2257
+ * 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.
2445
2258
  */
2446
2259
  "customButtons": Map<string, CustomButton>;
2447
2260
  /**
2448
- * @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.
2449
- * @example Elementos customizados na Taskbar da aba de detalhes.
2261
+ * 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.
2450
2262
  */
2451
2263
  "customContainerId": string;
2452
2264
  /**
2453
- * @description Define o identificador do slot que recebe elementos personalizados.
2265
+ * Usado para determinar o identificador do slot que recebe elementos personalizados.
2454
2266
  */
2455
2267
  "customSlotId": string;
2456
2268
  /**
2457
- * @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).
2269
+ * Instância do DataUnit.
2458
2270
  */
2459
2271
  "dataUnit": DataUnit;
2460
2272
  /**
2461
- * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
2273
+ * Array contendo todos os botões a serem desabilitados.
2462
2274
  */
2463
2275
  "disabledButtons": Array<string>;
2464
2276
  /**
2465
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2277
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2466
2278
  */
2467
2279
  "messagesBuilder": SnkMessageBuilder;
2468
2280
  /**
2469
- * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens.
2281
+ * Define como será o comportamento da taskbar quando ocorrer overflow
2470
2282
  */
2471
2283
  "overflowStrategy": 'hiddenItems' | 'none';
2472
2284
  /**
2473
- * @description Altera o modo de apresentação dos botões da barra de tarefas.
2285
+ * Altera o modo de apresentação dos botões do snk-taskbar.
2474
2286
  */
2475
2287
  "presentationMode": PresentationMode1;
2476
2288
  /**
2477
- * @description Define qual botão deve ter a aparência de destaque (primário).
2289
+ * Determina qual botão deve ter aparência primária.
2478
2290
  */
2479
2291
  "primaryButton": string;
2480
2292
  /**
2481
- * @description Identificador de recursos, como configurações e permissões de acesso.
2293
+ * Identificador de recursos como configurações e acesso.
2482
2294
  */
2483
2295
  "resourceID": string;
2484
2296
  }
@@ -3604,112 +3416,78 @@ declare namespace LocalJSX {
3604
3416
  interface SnkDataUnit {
3605
3417
  /**
3606
3418
  * Executado após a ação de salvar.
3607
- * @param dataUnit - A instância do DataUnit.
3608
- * @returns
3609
3419
  */
3610
3420
  "afterSave"?: (dataUnit: DataUnit) => void;
3611
3421
  /**
3612
3422
  * 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.
3613
- * @param dataUnit - A instância do DataUnit.
3614
- * @returns `false` para cancelar a ação, `true` para continuar.
3615
3423
  */
3616
3424
  "beforeSave"?: (dataUnit: DataUnit) => boolean | Promise<boolean>;
3617
3425
  /**
3618
3426
  * Usado para obter configuração de metadados.
3619
- * @type {string}
3620
3427
  */
3621
3428
  "configName"?: string;
3622
3429
  /**
3623
3430
  * Controla o estado atual dos dados.
3624
- * @type {DataState}
3625
3431
  */
3626
3432
  "dataState"?: DataState;
3627
3433
  /**
3628
3434
  * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
3629
- * @type {DataUnit}
3630
3435
  */
3631
3436
  "dataUnit"?: DataUnit;
3632
3437
  /**
3633
3438
  * Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade.
3634
- * @type {string}
3635
3439
  */
3636
3440
  "dataUnitName"?: string;
3637
3441
  /**
3638
3442
  * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
3639
- * @type {string}
3640
3443
  */
3641
3444
  "domainMessagesBuilder"?: string;
3642
3445
  /**
3643
3446
  * Determina qual a entidade que representa os dados em questão.
3644
- * @type {string}
3645
3447
  */
3646
3448
  "entityName"?: string;
3647
3449
  /**
3648
3450
  * Responsável por evitar a mensagem de sucesso ao salvar.
3649
- * @type {boolean}
3650
3451
  */
3651
3452
  "ignoreSaveMessage"?: boolean;
3652
3453
  /**
3653
3454
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
3654
- * @type {SnkMessageBuilder}
3655
3455
  */
3656
3456
  "messagesBuilder"?: SnkMessageBuilder;
3657
3457
  /**
3658
3458
  * Emitido quando se cancela uma inserção ou cópia.
3659
- * @event cancelEdition
3660
- * @type {CustomEvent<void>}
3661
- * @bubbles false
3662
3459
  */
3663
3460
  "onCancelEdition"?: (event: SnkDataUnitCustomEvent<void>) => void;
3664
3461
  /**
3665
3462
  * Emitido quando há qualquer mudança de estado no DataUnit.
3666
- * @event dataStateChange
3667
- * @type {CustomEvent<DataState>}
3668
- * @bubbles false
3669
3463
  */
3670
3464
  "onDataStateChange"?: (event: SnkDataUnitCustomEvent<DataState>) => void;
3671
3465
  /**
3672
3466
  * Emitido quando há campos no DataUnit que devem ser ocultados.
3673
- * @event dataUnitFieldsHidded
3674
- * @type {CustomEvent<void>}
3675
3467
  */
3676
3468
  "onDataUnitFieldsHidded"?: (event: SnkDataUnitCustomEvent<void>) => void;
3677
3469
  /**
3678
3470
  * Emitido quando o DataUnit está pronto.
3679
- * @event dataUnitReady
3680
- * @type {CustomEvent<DataUnit>}
3681
- * @bubbles false
3682
3471
  */
3683
3472
  "onDataUnitReady"?: (event: SnkDataUnitCustomEvent<DataUnit>) => void;
3684
3473
  /**
3685
3474
  * Emitido quando um registro é adicionado ou copiado.
3686
- * @event insertionMode
3687
- * @type {CustomEvent<void>}
3688
- * @bubbles false
3689
3475
  */
3690
3476
  "onInsertionMode"?: (event: SnkDataUnitCustomEvent<void>) => void;
3691
3477
  /**
3692
- * Emitido quando o messagesBuilder é atualizado.
3693
- * @event messagesBuilderUpdated
3694
- * @type {CustomEvent<SnkMessageBuilder>}
3695
- * @bubbles false
3478
+ * Emitido quando o DataUnit está pronto.
3696
3479
  */
3697
3480
  "onMessagesBuilderUpdated"?: (event: SnkDataUnitCustomEvent<SnkMessageBuilder>) => void;
3698
3481
  /**
3699
3482
  * Determina quantas linhas são retornadas por página.
3700
- * @type {number}
3701
- * @default 150
3702
3483
  */
3703
3484
  "pageSize"?: number;
3704
3485
  /**
3705
3486
  * Identificador de recursos como configurações e acesso.
3706
- * @type {string}
3707
3487
  */
3708
3488
  "resourceID"?: string;
3709
3489
  /**
3710
3490
  * Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição.
3711
- * @type {boolean}
3712
- * @default true
3713
3491
  */
3714
3492
  "useCancelConfirm"?: boolean;
3715
3493
  }
@@ -3932,65 +3710,56 @@ declare namespace LocalJSX {
3932
3710
  }
3933
3711
  interface SnkFilterBar {
3934
3712
  /**
3935
- * @description Função chamada depois de aplicar os filtros.
3713
+ * Função chamada depois de aplicar os filtros.
3936
3714
  */
3937
3715
  "afterApplyConfig"?: () => void;
3938
3716
  /**
3939
- * @description Define se a carga dos dados será feita assim que o componente for carregado.
3717
+ * Define se a carga dos dados será feita assim que o componente for carregado.
3940
3718
  */
3941
3719
  "autoLoad"?: boolean;
3942
3720
  /**
3943
- * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
3721
+ * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
3944
3722
  */
3945
3723
  "configName"?: string;
3946
3724
  /**
3947
- * @description Loader customizado para carregar as configurações.
3948
- * @param configName - Nome da configuração.
3949
- * @param resourceId - ID do recurso.
3950
- * @param options - Opções adicionais.
3951
- * @returns Retorna a configuração dos filtros.
3725
+ * Loader customizado para carregar as configurações
3952
3726
  */
3953
3727
  "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
3954
3728
  /**
3955
- * @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.
3729
+ * 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.
3956
3730
  */
3957
3731
  "dataUnit"?: DataUnit;
3958
3732
  /**
3959
- * @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).
3733
+ * 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).
3960
3734
  */
3961
3735
  "disablePersonalizedFilter"?: boolean;
3962
3736
  /**
3963
- * @description Define se o componente deve usar o LockManager para controle de carregamento.
3737
+ * Define se o componente deve usar o LockManager para controle de carregamento
3964
3738
  */
3965
3739
  "enableLockManagerLoadingComp"?: boolean;
3966
3740
  /**
3967
- * @description Chave da configuração legada da barra de filtros.
3741
+ * Chave da configuração legado da barra de filtros.
3968
3742
  */
3969
3743
  "filterBarLegacyConfigName"?: string;
3970
3744
  /**
3971
- * @description Lista todos os filtros disponíveis ao usuário.
3745
+ * Lista todos os filtros disponíveis ao usuário.
3972
3746
  */
3973
3747
  "filterConfig"?: Array<SnkFilterItemConfig>;
3974
3748
  /**
3975
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
3749
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
3976
3750
  */
3977
3751
  "messagesBuilder"?: SnkMessageBuilder;
3978
3752
  /**
3979
- * @description Modo de apresentação da barra de filtros.
3753
+ * Modo de apresentação da filterbar.
3980
3754
  */
3981
3755
  "mode"?: "regular" | "button" | "hidden";
3982
- /**
3983
- * @description Evento emitido quando a configuração dos filtros é atualizada.
3984
- * @param configs - Lista de configurações de filtros atualizadas.
3985
- * @event
3986
- */
3987
3756
  "onConfigUpdated"?: (event: SnkFilterBarCustomEvent<SnkFilterItemConfig[]>) => void;
3988
3757
  /**
3989
- * @description Identificador de recursos como configurações e acesso.
3758
+ * Identificador de recursos como configurações e acesso.
3990
3759
  */
3991
3760
  "resourceID"?: string;
3992
3761
  /**
3993
- * @description Título que será apresentado na barra de filtros.
3762
+ * Título que será apresentado na barra de filtros
3994
3763
  */
3995
3764
  "title"?: string;
3996
3765
  }
@@ -4269,7 +4038,7 @@ declare namespace LocalJSX {
4269
4038
  */
4270
4039
  "configName"?: string;
4271
4040
  /**
4272
- * Chave da configuração legada do formulário.
4041
+ * Chave da configuração legado do formulário.
4273
4042
  */
4274
4043
  "formLegacyConfigName"?: string;
4275
4044
  /**
@@ -4277,15 +4046,15 @@ declare namespace LocalJSX {
4277
4046
  */
4278
4047
  "messagesBuilder"?: SnkMessageBuilder;
4279
4048
  /**
4280
- * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
4049
+ * Emitido sempre que houver click de botão ou ação.
4281
4050
  */
4282
4051
  "onActionClick"?: (event: SnkFormCustomEvent<string>) => void;
4283
4052
  /**
4284
- * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
4053
+ * Emitido quando o botão de voltar é acionado.
4285
4054
  */
4286
4055
  "onExit"?: (event: SnkFormCustomEvent<void>) => void;
4287
4056
  /**
4288
- * Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view
4057
+ * Responsável por notificar quando ocorrer a renderização de itens do formulário.
4289
4058
  */
4290
4059
  "onFormItemsReady"?: (event: SnkFormCustomEvent<Array<HTMLElement>>) => void;
4291
4060
  /**
@@ -4414,43 +4183,40 @@ declare namespace LocalJSX {
4414
4183
  }
4415
4184
  interface SnkGrid {
4416
4185
  /**
4417
- * Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`.
4186
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
4418
4187
  */
4419
4188
  "actionsList"?: Array<Action>;
4420
4189
  /**
4421
- * Define se a grade receberá o foco automaticamente ao ser carregada.
4190
+ * Define se a grid será focada ao ser carregada.
4422
4191
  */
4423
4192
  "autoFocus"?: boolean;
4424
4193
  /**
4425
- * Define se os dados serão carregados automaticamente na inicialização do componente.
4194
+ * Define se a carga dos dados será feita assim que o componente for carregado.
4426
4195
  */
4427
4196
  "autoLoad"?: boolean;
4428
4197
  /**
4429
- * Define se a edição de dados na grade está habilitada.
4198
+ * Define se a edição está habilitada na grid.
4430
4199
  */
4431
4200
  "canEdit"?: boolean;
4432
- /**
4433
- * Define o data source para o filtro de colunas.
4434
- */
4435
4201
  "columnFilterDataSource"?: IMultiSelectionListDataSource;
4436
4202
  /**
4437
- * Define se a grade deve ser exibida em modo compacto.
4203
+ * Define se a grade deve ser exibida em modo compacto
4438
4204
  */
4439
4205
  "compact"?: boolean;
4440
4206
  /**
4441
- * Nome usado para salvar e recuperar a configuração da grade.
4207
+ * Nome usado para salvar/recuperar a configuração.
4442
4208
  */
4443
4209
  "configName"?: string;
4444
4210
  /**
4445
- * 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).
4211
+ * 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).
4446
4212
  */
4447
4213
  "disablePersonalizedFilter"?: boolean;
4448
4214
  /**
4449
- * Habilita a inserção de registros diretamente na grade.
4215
+ * Ativa inserção de registros no modo grade.
4450
4216
  */
4451
4217
  "enableGridInsert"?: boolean;
4452
4218
  /**
4453
- * Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
4219
+ * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
4454
4220
  */
4455
4221
  "enableLockManagerLoadingComp"?: boolean;
4456
4222
  /**
@@ -4458,23 +4224,23 @@ declare namespace LocalJSX {
4458
4224
  */
4459
4225
  "enableLockManagerTaskbarClick"?: boolean;
4460
4226
  /**
4461
- * Chave da configuração legada da barra de filtros.
4227
+ * Chave da configuração legado da barra de filtros.
4462
4228
  */
4463
4229
  "filterBarLegacyConfigName"?: string;
4464
4230
  /**
4465
- * Título que será apresentado na barra de filtros.
4231
+ * Título que será apresentado na barra de filtros
4466
4232
  */
4467
4233
  "filterBarTitle"?: string;
4468
4234
  /**
4469
- * Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade.
4235
+ * Nome do slot de elementos customizados da Taskbar do cabeçalho da grade.
4470
4236
  */
4471
4237
  "gridHeaderCustomSlotId"?: string;
4472
4238
  /**
4473
- * Chave da configuração legada da grade.
4239
+ * Chave da configuração legado da grade.
4474
4240
  */
4475
4241
  "gridLegacyConfigName"?: string;
4476
4242
  /**
4477
- * Determina se a grade está vinculada a um detalhe de outra tela.
4243
+ * Determina se a grade está vinculada a um detalhe.
4478
4244
  */
4479
4245
  "isDetail"?: boolean;
4480
4246
  /**
@@ -4482,17 +4248,15 @@ declare namespace LocalJSX {
4482
4248
  */
4483
4249
  "messagesBuilder"?: SnkMessageBuilder;
4484
4250
  /**
4485
- * Habilita a edição de múltiplos registros simultaneamente.
4251
+ * Habilita a edição de múltiplos registros simultâneos.
4486
4252
  */
4487
4253
  "multipleEditionEnabled"?: boolean;
4488
4254
  /**
4489
- * Determina se a seleção de múltiplas linhas é permitida.
4255
+ * Determina se pode haver mais de uma linha selecionada.
4490
4256
  */
4491
4257
  "multipleSelection"?: boolean;
4492
4258
  /**
4493
- * Emitido ao clicar em um botão de ação ou item de menu.
4494
- * @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.
4495
- * @param detail - O identificador da ação clicada, que pode ser usado para determinar qual ação executar.
4259
+ * Emitido sempre que houver click de botão ou ação.
4496
4260
  */
4497
4261
  "onActionClick"?: (event: SnkGridCustomEvent<string>) => void;
4498
4262
  /**
@@ -4500,74 +4264,67 @@ declare namespace LocalJSX {
4500
4264
  */
4501
4265
  "onComponentReady"?: (event: SnkGridCustomEvent<void>) => void;
4502
4266
  /**
4503
- * Emitido ao realizar um duplo clique em uma linha da grade.
4504
- * @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.
4505
- * @param detail - Detalhes do evento, contendo a linha clicada.
4267
+ * Emitido sempre que houver duplo click na grade.
4506
4268
  */
4507
4269
  "onGridDoubleClick"?: (event: SnkGridCustomEvent<any>) => void;
4508
4270
  /**
4509
- * 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).
4271
+ * 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)
4510
4272
  */
4511
4273
  "outlineMode"?: boolean;
4512
4274
  /**
4513
- * Define o modo de exibição do contador de paginação.
4275
+ * Define se a grid será focada ao ser carregada.
4514
4276
  */
4515
4277
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
4516
4278
  /**
4517
- * Altera o modo de apresentação dos botões do `snk-taskbar`.
4279
+ * Altera o modo de apresentação dos botões do snk-taskbar.
4518
4280
  */
4519
4281
  "presentationMode"?: PresentationMode1;
4520
4282
  /**
4521
- * Validador responsável por verificar a integridade dos dados de um registro.
4283
+ * Validador responsável por checar a integridade das informações do registro.
4522
4284
  */
4523
4285
  "recordsValidator"?: IRecordValidator;
4524
4286
  /**
4525
- * Identificador de recursos, como configurações e permissões de acesso.
4287
+ * Identificador de recursos como configurações e acesso.
4526
4288
  */
4527
4289
  "resourceID"?: string;
4528
4290
  /**
4529
- * Configuração do toast de seleção da grade.
4291
+ * Configuração da seleção de grade no toast.
4530
4292
  */
4531
4293
  "selectionToastConfig"?: ISelectionToastConfig;
4532
4294
  /**
4533
- * Define a configuração de cores para a coluna de status.
4534
- * @example ```json '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' ```
4295
+ * Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
4535
4296
  */
4536
4297
  "statusResolver"?: IStatusResolver | StatusResolverFunction;
4537
4298
  /**
4538
- * Define o modo de exportação dos dados.
4299
+ * Modo de exportação dos dados.
4539
4300
  */
4540
4301
  "strategyExporter"?: IExporterStrategyMode;
4541
4302
  /**
4542
- * Informa se a coluna de checkbox deve ser suprimida.
4303
+ * Informa se a coluna de chechbox deve ser suprimida
4543
4304
  */
4544
4305
  "suppressCheckboxColumn"?: boolean;
4545
4306
  /**
4546
- * Informa se a grade deve suprimir o filtro de coluna.
4547
- */
4548
- "suppressFilterColumn"?: boolean;
4549
- /**
4550
- * Define se a grade deve suprimir a barra de rolagem horizontal.
4307
+ * Define se a grade deve suprimir o scroll horizontal.
4551
4308
  */
4552
4309
  "suppressHorizontalScroll"?: boolean;
4553
4310
  /**
4554
- * Define o identificador do contêiner de elementos customizados da `Taskbar`.
4311
+ * Define o identificador do container de elementos customizados da Taskbar.
4555
4312
  */
4556
4313
  "taskbarCustomContainerId"?: string;
4557
4314
  /**
4558
- * Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões.
4315
+ * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
4559
4316
  */
4560
4317
  "taskbarManager"?: TaskbarManager;
4561
4318
  /**
4562
- * Define o nome do slot para elementos customizados na `Taskbar` principal do componente.
4319
+ * Nome do slot de elementos customizados da Taskbar principal do componente.
4563
4320
  */
4564
4321
  "topTaskbarCustomSlotId"?: string;
4565
4322
  /**
4566
- * Quando `true`, a tecla ENTER navega entre as células como a tecla TAB.
4323
+ * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
4567
4324
  */
4568
4325
  "useEnterLikeTab"?: boolean;
4569
4326
  /**
4570
- * Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`.
4327
+ * Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F
4571
4328
  */
4572
4329
  "useSearchColumn"?: boolean;
4573
4330
  }
@@ -4696,49 +4453,30 @@ declare namespace LocalJSX {
4696
4453
  }
4697
4454
  interface SnkPersonalizedFilter {
4698
4455
  /**
4699
- * Nome da configuração, utilizado para distinguir múltiplas instâncias do componente.
4700
- * @property
4456
+ * Nome da configuração. Serve para distinguir várias instâncias do componente.
4701
4457
  */
4702
4458
  "configName"?: string;
4703
4459
  /**
4704
- * URI da entidade utilizada para buscar os campos disponíveis para filtro.
4705
- * @property
4460
+ * Responsável por receber a URI da entidade.
4706
4461
  */
4707
4462
  "entityUri"?: string;
4708
4463
  /**
4709
- * Identificador do filtro a ser carregado.
4710
- * @property
4464
+ * Id do filtro que será carregado.
4711
4465
  */
4712
4466
  "filterId"?: string;
4713
4467
  /**
4714
- * Indica se o filtro é o filtro padrão do sistema.
4715
- * @property
4716
- * @default false
4468
+ * Define se o filtro em questão é um filtro padrão.
4717
4469
  */
4718
4470
  "isDefaultFilter"?: boolean;
4719
4471
  /**
4720
4472
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4721
- * @property
4722
4473
  */
4723
4474
  "messagesBuilder"?: SnkMessageBuilder;
4724
- /**
4725
- * Evento emitido após salvar as alterações do filtro personalizado.
4726
- * @event
4727
- */
4728
4475
  "onEzAfterSave"?: (event: SnkPersonalizedFilterCustomEvent<void>) => void;
4729
- /**
4730
- * Evento emitido ao cancelar a personalização do filtro.
4731
- * @event
4732
- */
4733
4476
  "onEzCancel"?: (event: SnkPersonalizedFilterCustomEvent<void>) => void;
4734
- /**
4735
- * Evento emitido ao salvar as alterações do filtro personalizado.
4736
- * @event
4737
- */
4738
4477
  "onEzSave"?: (event: SnkPersonalizedFilterCustomEvent<string>) => void;
4739
4478
  /**
4740
- * Identificador do recurso utilizado para salvar e recuperar filtros.
4741
- * @property
4479
+ * Nome da configuração. Serve para distinguir várias instâncias do componente.
4742
4480
  */
4743
4481
  "resourceID"?: string;
4744
4482
  }
@@ -4815,11 +4553,11 @@ declare namespace LocalJSX {
4815
4553
  }
4816
4554
  interface SnkSimpleBar {
4817
4555
  /**
4818
- * Define os itens que serão apresentados no breadcrumb.
4556
+ * Define os itens que serão apresentados pelo breadcrumb
4819
4557
  */
4820
4558
  "breadcrumbItens"?: Array<IBreadcrumbItem>;
4821
4559
  /**
4822
- * Define o título do header.
4560
+ * Define o título do header
4823
4561
  */
4824
4562
  "label"?: string;
4825
4563
  /**
@@ -4827,157 +4565,136 @@ declare namespace LocalJSX {
4827
4565
  */
4828
4566
  "messagesBuilder"?: SnkMessageBuilder;
4829
4567
  /**
4830
- * Emitido quando algum item do breadcrumb é clicado.
4568
+ * Emitido quando algum item do breadcrumb é clicado
4831
4569
  */
4832
4570
  "onClickBreadcrumbItem"?: (event: SnkSimpleBarCustomEvent<IBreadcrumbItem>) => void;
4833
4571
  /**
4834
- * Emitido quando o botão "voltar" é acionado.
4572
+ * Emitido quando o botão voltar é acionado
4835
4573
  */
4836
4574
  "onExit"?: (event: SnkSimpleBarCustomEvent<void>) => void;
4837
4575
  }
4838
4576
  interface SnkSimpleCrud {
4839
4577
  /**
4840
- * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
4578
+ * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
4841
4579
  */
4842
4580
  "actionsList"?: Array<Action>;
4843
4581
  /**
4844
- * @description Define se a grade será focada ao ser carregada.
4582
+ * Define se a grid será focada ao ser carregada.
4845
4583
  */
4846
4584
  "autoFocus"?: boolean;
4847
4585
  /**
4848
- * @description Define se a carga dos dados será feita assim que o componente for carregado.
4586
+ * Define se a carga dos dados será feita assim que o componente for carregado.
4849
4587
  */
4850
4588
  "autoLoad"?: boolean;
4851
4589
  /**
4852
- * @description Usado para salvar as configurações dos blocos de construção.
4590
+ * Usado para salvar as configurações dos blocos de construção.
4853
4591
  */
4854
4592
  "configName"?: string;
4855
- /**
4856
- * @description Estado atual dos dados.
4857
- */
4858
4593
  "dataState"?: DataState1;
4859
- /**
4860
- * @description Instância do DataUnit a ser utilizada pelo componente.
4861
- */
4862
4594
  "dataUnit"?: DataUnit;
4863
4595
  /**
4864
- * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade).
4596
+ * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
4865
4597
  */
4866
4598
  "domainMessagesBuilder"?: string;
4867
- /**
4868
- * @description Habilita a inserção contínua de registros.
4869
- */
4870
4599
  "enableContinuousInsert"?: boolean;
4871
4600
  /**
4872
- * @description Ativa a inserção de registros no modo grade.
4601
+ * Ativa inserção de registros no modo grade.
4873
4602
  */
4874
4603
  "enableGridInsert"?: boolean;
4875
4604
  /**
4876
- * @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
4605
+ * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
4877
4606
  */
4878
4607
  "enableLockManagerLoadingComp"?: boolean;
4879
4608
  /**
4880
- * @description Ativa o gerenciamento de locks na grade pela Taskbar.
4609
+ * Ativa o gerenciamento de locks na grade pela Taskbar.
4881
4610
  */
4882
4611
  "enableLockManagerTaskbarClick"?: boolean;
4883
4612
  /**
4884
- * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD.
4613
+ * Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD
4885
4614
  */
4886
4615
  "entityName"?: string;
4887
- /**
4888
- * @description Configuração do formulário.
4889
- */
4890
4616
  "formConfig"?: IFormConfig;
4891
4617
  /**
4892
- * @description Chave da configuração legada do formulário.
4618
+ * Chave da configuração legado do formulário.
4893
4619
  */
4894
4620
  "formLegacyConfigName"?: string;
4895
- /**
4896
- * @description Configuração da grade.
4897
- */
4898
4621
  "gridConfig"?: IGridConfig;
4899
4622
  /**
4900
- * @description Chave da configuração legada da grade.
4623
+ * Chave da configuração legado da grade.
4901
4624
  */
4902
4625
  "gridLegacyConfigName"?: string;
4903
4626
  /**
4904
- * @description Ignora os campos "somente leitura" no modo de inserção.
4627
+ * Ignora os campos "somente leitura" no modo de inserção.
4905
4628
  */
4906
4629
  "ignoreReadOnlyFormFields"?: boolean;
4907
4630
  /**
4908
- * @description Define se o LayoutFormConfig será exibido no configurador.
4631
+ * Define se o LayoutFormConfig será exibido no configurador.
4909
4632
  */
4910
4633
  "layoutFormConfig"?: boolean;
4911
4634
  /**
4912
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4635
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4913
4636
  */
4914
4637
  "messagesBuilder"?: SnkMessageBuilder;
4915
- /**
4916
- * @description Define o modo de operação do CRUD (servidor ou em memória).
4917
- */
4918
4638
  "mode"?: SIMPLE_CRUD_MODE;
4919
4639
  /**
4920
- * @description Habilita a edição de múltiplos registros simultâneos.
4640
+ * Habilita a edição de múltiplos registros simultâneos.
4921
4641
  */
4922
4642
  "multipleEditionEnabled"?: boolean;
4923
4643
  /**
4924
- * @description Determina se pode haver mais de uma linha selecionada na grade.
4644
+ * Determina se pode haver mais de uma linha selecionada na grade.
4925
4645
  */
4926
4646
  "multipleSelection"?: boolean;
4927
4647
  /**
4928
- * @description Emitido sempre que houver clique de botão ou ação na barra de tarefas.
4648
+ * Emitido sempre que houver click de botão ou ação.
4929
4649
  */
4930
4650
  "onActionClick"?: (event: SnkSimpleCrudCustomEvent<string>) => void;
4931
4651
  /**
4932
- * @description Emitido quando o salvamento da configuração no configurador do CRUD é cancelado.
4652
+ * Emitido quando cancela o salvamento da configuração no configurator do CRUD.
4933
4653
  */
4934
4654
  "onConfiguratorCancel"?: (event: SnkSimpleCrudCustomEvent<any>) => void;
4935
4655
  /**
4936
- * @description Emitido quando a configuração no configurador do CRUD é salva.
4656
+ * Emitido quando salva a configuração no configurator do CRUD.
4937
4657
  */
4938
4658
  "onConfiguratorSave"?: (event: SnkSimpleCrudCustomEvent<any>) => void;
4939
4659
  /**
4940
- * @description Emitido quando há qualquer mudança de estado no DataUnit.
4660
+ * Emitido quando há qualquer mudança de estado no DataUnit.
4941
4661
  */
4942
4662
  "onDataStateChange"?: (event: SnkSimpleCrudCustomEvent<DataState1>) => void;
4943
4663
  /**
4944
- * @description Emitido quando o DataUnit está pronto.
4664
+ * Emitido quando o DataUnit está pronto.
4945
4665
  */
4946
4666
  "onDataUnitReady"?: (event: SnkSimpleCrudCustomEvent<DataUnit>) => void;
4947
4667
  /**
4948
- * @description Responsável por notificar quando ocorrer a renderização de itens do formulário.
4668
+ * Responsável por notificar quando ocorrer a renderização de itens do formulário.
4949
4669
  */
4950
4670
  "onFormItemsReady"?: (event: SnkSimpleCrudCustomEvent<Array<HTMLElement>>) => void;
4951
4671
  /**
4952
- * @description Altera visualmente as sombras e bordas do componente. Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout). Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up).
4672
+ * 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)
4953
4673
  */
4954
4674
  "outlineMode"?: boolean;
4955
4675
  /**
4956
- * @description Determina quantas linhas são retornadas por página.
4676
+ * Determina quantas linhas são retornadas por página.
4957
4677
  */
4958
4678
  "pageSize"?: number;
4959
4679
  /**
4960
- * @description Define o modo de exibição do contador de paginação.
4680
+ * Define se a grid será focada ao ser carregada.
4961
4681
  */
4962
4682
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
4963
4683
  /**
4964
- * @description Identificador de recursos como configurações e acesso.
4684
+ * Identificador de recursos como configurações e acesso.
4965
4685
  */
4966
4686
  "resourceID"?: string;
4967
4687
  /**
4968
- * @description Usado para exibir os botões de ação do snk-configurator.
4688
+ * Usado para exibir os botões de ação do snk-configurator.
4969
4689
  */
4970
4690
  "showConfiguratorButtons"?: boolean;
4971
4691
  /**
4972
- * @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
4692
+ * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
4973
4693
  */
4974
4694
  "taskbarManager"?: TaskbarManager;
4975
- /**
4976
- * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
4977
- */
4978
4695
  "useCancelConfirm"?: boolean;
4979
4696
  /**
4980
- * @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
4697
+ * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
4981
4698
  */
4982
4699
  "useEnterLikeTab"?: boolean;
4983
4700
  }
@@ -4998,79 +4715,75 @@ declare namespace LocalJSX {
4998
4715
  }
4999
4716
  interface SnkTaskbar {
5000
4717
  /**
5001
- * @description Lista de ações a serem exibidas no botão "Mais opções".
4718
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
5002
4719
  */
5003
4720
  "actionsList"?: Array<Action>;
5004
4721
  /**
5005
- * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
4722
+ * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
5006
4723
  */
5007
4724
  "actionsSettingsList"?: Array<Action>;
5008
4725
  /**
5009
- * @description Define o alinhamento dos itens da barra de tarefas à direita.
4726
+ * Usado para determinar O alinhamento dos items na taskbar.
5010
4727
  */
5011
4728
  "alignRigth"?: boolean;
5012
4729
  /**
5013
- * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas.
4730
+ * Lista separada por virgula, contendo todos os elementos a serem criados.
5014
4731
  */
5015
4732
  "buttons"?: string;
5016
4733
  /**
5017
- * @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.
4734
+ * Usado para guardar ou recuperar as configurações do formulário.
5018
4735
  */
5019
4736
  "configName"?: string;
5020
4737
  /**
5021
- * @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.
4738
+ * 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.
5022
4739
  */
5023
4740
  "customButtons"?: Map<string, CustomButton>;
5024
4741
  /**
5025
- * @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.
5026
- * @example Elementos customizados na Taskbar da aba de detalhes.
4742
+ * 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.
5027
4743
  */
5028
4744
  "customContainerId"?: string;
5029
4745
  /**
5030
- * @description Define o identificador do slot que recebe elementos personalizados.
4746
+ * Usado para determinar o identificador do slot que recebe elementos personalizados.
5031
4747
  */
5032
4748
  "customSlotId"?: string;
5033
4749
  /**
5034
- * @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).
4750
+ * Instância do DataUnit.
5035
4751
  */
5036
4752
  "dataUnit"?: DataUnit;
5037
4753
  /**
5038
- * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
4754
+ * Array contendo todos os botões a serem desabilitados.
5039
4755
  */
5040
4756
  "disabledButtons"?: Array<string>;
5041
4757
  /**
5042
- * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4758
+ * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
5043
4759
  */
5044
4760
  "messagesBuilder"?: SnkMessageBuilder;
5045
4761
  /**
5046
- * @description Emitido sempre que um botão ou uma ação da barra de tarefas é clicado.
5047
- * @eventProperty
4762
+ * Emitido sempre que houver click de botão ou ação.
5048
4763
  */
5049
4764
  "onActionClick"?: (event: SnkTaskbarCustomEvent<string>) => void;
5050
4765
  /**
5051
- * @description Emitido quando uma ação de salvar é iniciada pela barra de tarefas, indicando um estado de bloqueio para evitar ações concorrentes.
5052
- * @eventProperty
4766
+ * Emitido sempre que um save é iniciado pela taskbar.
5053
4767
  */
5054
4768
  "onTaskbarSaveLocker"?: (event: SnkTaskbarCustomEvent<void>) => void;
5055
4769
  /**
5056
- * @description Emitido quando a ação de salvar é concluída ou cancelada, liberando o estado de bloqueio.
5057
- * @eventProperty
4770
+ * Emitido sempre que o ocorre alguma action que libera o save.
5058
4771
  */
5059
4772
  "onTaskbarSaveUnlocker"?: (event: SnkTaskbarCustomEvent<void>) => void;
5060
4773
  /**
5061
- * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens.
4774
+ * Define como será o comportamento da taskbar quando ocorrer overflow
5062
4775
  */
5063
4776
  "overflowStrategy"?: 'hiddenItems' | 'none';
5064
4777
  /**
5065
- * @description Altera o modo de apresentação dos botões da barra de tarefas.
4778
+ * Altera o modo de apresentação dos botões do snk-taskbar.
5066
4779
  */
5067
4780
  "presentationMode"?: PresentationMode1;
5068
4781
  /**
5069
- * @description Define qual botão deve ter a aparência de destaque (primário).
4782
+ * Determina qual botão deve ter aparência primária.
5070
4783
  */
5071
4784
  "primaryButton"?: string;
5072
4785
  /**
5073
- * @description Identificador de recursos, como configurações e permissões de acesso.
4786
+ * Identificador de recursos como configurações e acesso.
5074
4787
  */
5075
4788
  "resourceID"?: string;
5076
4789
  }