@sankhyalabs/sankhyablocks 9.2.0-dev.15 → 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 (66) 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-pesquisa/snk-pesquisa.js +14 -80
  20. package/dist/collection/components/snk-simple-bar/snk-simple-bar.js +9 -9
  21. package/dist/collection/components/snk-simple-crud/snk-simple-crud.js +119 -414
  22. package/dist/collection/components/snk-taskbar/snk-taskbar.js +36 -102
  23. package/dist/collection/lib/licenses/sankhyalicense.module.js +1 -0
  24. package/dist/components/snk-application2.js +3 -0
  25. package/dist/components/snk-data-unit2.js +1 -11
  26. package/dist/components/snk-filter-bar2.js +15 -26
  27. package/dist/components/snk-form.js +2 -29
  28. package/dist/components/snk-grid2.js +7 -57
  29. package/dist/components/snk-personalized-filter2.js +2 -10
  30. package/dist/components/snk-simple-bar2.js +5 -5
  31. package/dist/components/snk-simple-crud2.js +8 -45
  32. package/dist/esm/loader.js +1 -1
  33. package/dist/esm/sankhyablocks.js +1 -1
  34. package/dist/esm/snk-application.entry.js +3 -0
  35. package/dist/esm/snk-data-exporter.entry.js +1 -1
  36. package/dist/esm/{snk-data-unit-d31619fb.js → snk-data-unit-b7e6e7a6.js} +1 -11
  37. package/dist/esm/snk-data-unit.entry.js +1 -1
  38. package/dist/esm/snk-filter-bar_4.entry.js +15 -25
  39. package/dist/esm/snk-form_2.entry.js +1 -27
  40. package/dist/esm/snk-grid.entry.js +7 -55
  41. package/dist/esm/snk-personalized-filter.entry.js +2 -10
  42. package/dist/esm/snk-simple-bar.entry.js +5 -5
  43. package/dist/esm/snk-simple-crud.entry.js +8 -45
  44. package/dist/sankhyablocks/p-012208e0.entry.js +1 -0
  45. package/dist/sankhyablocks/{p-a2e8c7a7.entry.js → p-158adf33.entry.js} +1 -1
  46. package/dist/sankhyablocks/p-81769310.entry.js +11 -0
  47. package/dist/sankhyablocks/{p-69b815ab.entry.js → p-8d1508aa.entry.js} +1 -1
  48. package/dist/sankhyablocks/p-a86eee47.entry.js +1 -0
  49. package/dist/sankhyablocks/p-fa18530e.entry.js +1 -0
  50. package/dist/sankhyablocks/sankhyablocks.esm.js +1 -1
  51. package/dist/types/components/snk-data-unit/snk-data-unit.d.ts +3 -46
  52. package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts +28 -45
  53. package/dist/types/components/snk-form/snk-form.d.ts +4 -29
  54. package/dist/types/components/snk-grid/snk-grid.d.ts +45 -104
  55. package/dist/types/components/snk-personalized-filter/snk-personalized-filter.d.ts +5 -53
  56. package/dist/types/components/snk-pesquisa/snk-pesquisa.d.ts +6 -44
  57. package/dist/types/components/snk-simple-bar/snk-simple-bar.d.ts +15 -15
  58. package/dist/types/components/snk-simple-crud/snk-simple-crud.d.ts +43 -100
  59. package/dist/types/components/snk-taskbar/snk-taskbar.d.ts +21 -23
  60. package/dist/types/components.d.ts +238 -569
  61. package/package.json +3 -4
  62. package/dist/sankhyablocks/p-51464e95.entry.js +0 -1
  63. package/dist/sankhyablocks/p-665dd170.entry.js +0 -11
  64. package/dist/sankhyablocks/p-6fa3d474.entry.js +0 -1
  65. package/dist/sankhyablocks/p-cf7063a4.entry.js +0 -1
  66. /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
  }
@@ -2151,53 +2022,31 @@ export namespace Components {
2151
2022
  }
2152
2023
  interface SnkPesquisa {
2153
2024
  /**
2154
- * Define se permite a seleção de itens não analíticos.
2155
- * @type {boolean}
2156
- * @default false
2157
- * @example allowsNonAnalytic={true}
2025
+ * Define se permite seleção de items não analíticos
2158
2026
  */
2159
2027
  "allowsNonAnalytic": boolean;
2160
2028
  /**
2161
- * Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente.
2162
- * @type {string}
2163
- * @mutable
2164
- * @example argument="Texto para pesquisa"
2029
+ * Argumentos que serão usados ao chamar a função searchLoader.
2165
2030
  */
2166
2031
  "argument": string;
2167
2032
  /**
2168
- * Nome da entidade sobre a qual a pesquisa será realizada.
2169
- * @type {string}
2170
- * @example entityName="Produto"
2033
+ * Nome da entidade onde a pesquisa é aplicada.
2171
2034
  */
2172
2035
  "entityName": string;
2173
2036
  /**
2174
- * Define se a popup de pesquisa terá ou não modo hierárquico.
2175
- * @type {boolean}
2176
- * @default false
2177
- * @example isHierarchyEntity={true}
2037
+ * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
2178
2038
  */
2179
2039
  "isHierarchyEntity": boolean;
2180
2040
  /**
2181
- * Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados.
2182
- * @type {(text: string) => Promise<any>}
2183
- * @param text Texto utilizado como argumento de pesquisa.
2184
- * @returns Promise com os dados da pesquisa.
2185
- * @example searchLoader={(text) => fetchItems(text)}
2041
+ * Função responsável em carregar os itens do componente snk-pesquisa.
2186
2042
  */
2187
2043
  "searchLoader": (text: string) => Promise<any>;
2188
2044
  /**
2189
- * Função disparada ao selecionar um item da pesquisa.
2190
- * @type {(option: IOption) => void}
2191
- * @param option Item selecionado.
2192
- * @returns void
2193
- * @example selectItem={(option) => handleSelect(option)}
2045
+ * Função disparada ao selecionar um item.
2194
2046
  */
2195
2047
  "selectItem": (option: IOption2) => void;
2196
2048
  /**
2197
- * Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível.
2198
- * @type {(text: string) => Promise<any>}
2199
- * @param text Texto utilizado como argumento de pesquisa para a árvore.
2200
- * @returns Promise com os dados da árvore.
2049
+ * Função responsável por carregar a árvore hierárquica do componente
2201
2050
  */
2202
2051
  "treeLoader"?: (text: string) => Promise<any>;
2203
2052
  }
@@ -2216,11 +2065,11 @@ export namespace Components {
2216
2065
  }
2217
2066
  interface SnkSimpleBar {
2218
2067
  /**
2219
- * Define os itens que serão apresentados no breadcrumb.
2068
+ * Define os itens que serão apresentados pelo breadcrumb
2220
2069
  */
2221
2070
  "breadcrumbItens": Array<IBreadcrumbItem>;
2222
2071
  /**
2223
- * Define o título do header.
2072
+ * Define o título do header
2224
2073
  */
2225
2074
  "label": string;
2226
2075
  /**
@@ -2230,196 +2079,138 @@ export namespace Components {
2230
2079
  }
2231
2080
  interface SnkSimpleCrud {
2232
2081
  /**
2233
- * @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.
2234
2083
  */
2235
2084
  "actionsList": Array<Action>;
2236
2085
  /**
2237
- * @description Registra um editor customizado para campos da grade e do formulário.
2238
- * @param fieldName - O nome do campo.
2239
- * @param customEditor - A instância do editor customizado.
2240
- * @returns
2086
+ * Registra um editor customizado para campos da grade e formulário.
2241
2087
  */
2242
2088
  "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise<void>;
2243
2089
  /**
2244
- * @description Registra um formatador de valores para uma coluna da grade.
2245
- * @param columnName - O nome da coluna.
2246
- * @param customFormatter - A instância do formatador customizado.
2247
- * @returns
2090
+ * Registra um formatador de valores para uma coluna da grid.
2248
2091
  */
2249
2092
  "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise<void>;
2250
2093
  /**
2251
- * @description Registra um renderizador customizado para colunas da grade.
2252
- * @param fieldName - O nome do campo.
2253
- * @param customRender - A instância do renderizador customizado.
2254
- * @returns
2094
+ * Registra um render customizado para colunas da grid.
2255
2095
  */
2256
2096
  "addGridCustomRender": (fieldName: string, customRender: ICustomRender) => Promise<void>;
2257
2097
  /**
2258
- * @description Define se a grade será focada ao ser carregada.
2098
+ * Define se a grid será focada ao ser carregada.
2259
2099
  */
2260
2100
  "autoFocus"?: boolean;
2261
2101
  /**
2262
- * @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.
2263
2103
  */
2264
2104
  "autoLoad"?: boolean;
2265
2105
  /**
2266
- * @description Usado para fechar o configurador do CRUD.
2267
- * @returns
2106
+ * Usado para fechar o configurator do CRUD
2268
2107
  */
2269
2108
  "closeConfigurator": () => Promise<void>;
2270
2109
  /**
2271
- * @description Usado para salvar as configurações dos blocos de construção.
2110
+ * Usado para salvar as configurações dos blocos de construção.
2272
2111
  */
2273
2112
  "configName": string;
2274
- /**
2275
- * @description Estado atual dos dados.
2276
- */
2277
2113
  "dataState": DataState1;
2278
- /**
2279
- * @description Instância do DataUnit a ser utilizada pelo componente.
2280
- */
2281
2114
  "dataUnit": DataUnit;
2282
2115
  /**
2283
- * @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)
2284
2117
  */
2285
2118
  "domainMessagesBuilder": string;
2286
- /**
2287
- * @description Habilita a inserção contínua de registros.
2288
- */
2289
2119
  "enableContinuousInsert": boolean;
2290
2120
  /**
2291
- * @description Ativa a inserção de registros no modo grade.
2121
+ * Ativa inserção de registros no modo grade.
2292
2122
  */
2293
2123
  "enableGridInsert"?: boolean;
2294
2124
  /**
2295
- * @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
2296
2126
  */
2297
2127
  "enableLockManagerLoadingComp"?: boolean;
2298
2128
  /**
2299
- * @description Ativa o gerenciamento de locks na grade pela Taskbar.
2129
+ * Ativa o gerenciamento de locks na grade pela Taskbar.
2300
2130
  */
2301
2131
  "enableLockManagerTaskbarClick"?: boolean;
2302
2132
  /**
2303
- * @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
2304
2134
  */
2305
2135
  "entityName": string;
2306
- /**
2307
- * @description Configuração do formulário.
2308
- */
2309
2136
  "formConfig": IFormConfig;
2310
2137
  /**
2311
- * @description Chave da configuração legada do formulário.
2138
+ * Chave da configuração legado do formulário.
2312
2139
  */
2313
2140
  "formLegacyConfigName": string;
2314
- /**
2315
- * @description Obtém os registros do DataUnit.
2316
- * @returns Uma promessa que resolve com a lista de registros.
2317
- */
2318
2141
  "getRecords": () => Promise<Array<Record>>;
2319
2142
  /**
2320
- * @description Usado para alternar a visão entre GRID e FORM externamente.
2321
- * @param view - A visão para a qual navegar.
2322
- * @returns
2143
+ * Usado para alternar a visão entre GRID e FORM externamente.
2323
2144
  */
2324
2145
  "goToView": (view: VIEW_MODE) => Promise<void>;
2325
- /**
2326
- * @description Configuração da grade.
2327
- */
2328
2146
  "gridConfig": IGridConfig;
2329
2147
  /**
2330
- * @description Chave da configuração legada da grade.
2148
+ * Chave da configuração legado da grade.
2331
2149
  */
2332
2150
  "gridLegacyConfigName": string;
2333
2151
  /**
2334
- * @description Ignora os campos "somente leitura" no modo de inserção.
2152
+ * Ignora os campos "somente leitura" no modo de inserção.
2335
2153
  */
2336
2154
  "ignoreReadOnlyFormFields": boolean;
2337
2155
  /**
2338
- * @description Define se o LayoutFormConfig será exibido no configurador.
2156
+ * Define se o LayoutFormConfig será exibido no configurador.
2339
2157
  */
2340
2158
  "layoutFormConfig": boolean;
2341
2159
  /**
2342
- * @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.
2343
2161
  */
2344
2162
  "messagesBuilder": SnkMessageBuilder;
2345
- /**
2346
- * @description Define o modo de operação do CRUD (servidor ou em memória).
2347
- */
2348
2163
  "mode": SIMPLE_CRUD_MODE;
2349
2164
  /**
2350
- * @description Habilita a edição de múltiplos registros simultâneos.
2165
+ * Habilita a edição de múltiplos registros simultâneos.
2351
2166
  */
2352
2167
  "multipleEditionEnabled": boolean;
2353
2168
  /**
2354
- * @description Determina se pode haver mais de uma linha selecionada na grade.
2169
+ * Determina se pode haver mais de uma linha selecionada na grade.
2355
2170
  */
2356
2171
  "multipleSelection": boolean;
2357
2172
  /**
2358
- * @description Usado para abrir o configurador do CRUD.
2359
- * @returns
2173
+ * Usado para abrir o configurator do CRUD
2360
2174
  */
2361
2175
  "openConfigurator": () => Promise<void>;
2362
2176
  /**
2363
- * @description Altera visualmente as sombras e bordas do componente. Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout). Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up).
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)
2364
2178
  */
2365
2179
  "outlineMode"?: boolean;
2366
2180
  /**
2367
- * @description Determina quantas linhas são retornadas por página.
2181
+ * Determina quantas linhas são retornadas por página.
2368
2182
  */
2369
2183
  "pageSize": number;
2370
2184
  /**
2371
- * @description Define o modo de exibição do contador de paginação.
2185
+ * Define se a grid será focada ao ser carregada.
2372
2186
  */
2373
2187
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
2374
2188
  /**
2375
- * @description Remove o formatador de valores de uma coluna da grade.
2376
- * @param columnName - O nome da coluna.
2377
- * @returns
2189
+ * Remove o formatador de valores de uma coluna da grid.
2378
2190
  */
2379
2191
  "removeCustomValueFormatter": (columnName: string) => Promise<void>;
2380
2192
  /**
2381
- * @description Identificador de recursos como configurações e acesso.
2193
+ * Identificador de recursos como configurações e acesso.
2382
2194
  */
2383
2195
  "resourceID": string;
2384
2196
  /**
2385
- * @description Altera/adiciona uma propriedade nos metadados do campo.
2386
- * @param fieldName - O nome do campo.
2387
- * @param propName - O nome da propriedade.
2388
- * @param value - O valor da propriedade.
2389
- * @returns
2197
+ * Altera/adiciona uma propriedade nos metadados do campo.
2390
2198
  */
2391
2199
  "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
2392
- /**
2393
- * @description Define os metadados do DataUnit.
2394
- * @param metadata - Os metadados a serem definidos.
2395
- * @returns
2396
- */
2397
2200
  "setMetadata": (metadata: UnitMetadata) => Promise<void>;
2398
- /**
2399
- * @description Define os registros do DataUnit.
2400
- * @param records - Os registros a serem definidos.
2401
- * @returns
2402
- */
2403
2201
  "setRecords": (records: Array<Record>) => Promise<void>;
2404
2202
  /**
2405
- * @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.
2406
2204
  */
2407
2205
  "showConfiguratorButtons": boolean;
2408
2206
  /**
2409
- * @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.
2410
2208
  */
2411
2209
  "taskbarManager": TaskbarManager;
2412
- /**
2413
- * @description Atualiza a configuração do formulário.
2414
- * @returns
2415
- */
2416
2210
  "updateConfig": () => Promise<void>;
2417
- /**
2418
- * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
2419
- */
2420
2211
  "useCancelConfirm": boolean;
2421
2212
  /**
2422
- * @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.
2423
2214
  */
2424
2215
  "useEnterLikeTab": boolean;
2425
2216
  }
@@ -2443,64 +2234,63 @@ export namespace Components {
2443
2234
  }
2444
2235
  interface SnkTaskbar {
2445
2236
  /**
2446
- * @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.
2447
2238
  */
2448
2239
  "actionsList": Array<Action>;
2449
2240
  /**
2450
- * @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.
2451
2242
  */
2452
2243
  "actionsSettingsList": Array<Action>;
2453
2244
  /**
2454
- * @description Define o alinhamento dos itens da barra de tarefas à direita.
2245
+ * Usado para determinar O alinhamento dos items na taskbar.
2455
2246
  */
2456
2247
  "alignRigth": boolean;
2457
2248
  /**
2458
- * @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.
2459
2250
  */
2460
2251
  "buttons": string;
2461
2252
  /**
2462
- * @description Nome da configuração usada para salvar ou recuperar as configurações do formulário. Também é utilizado como fallback para a chave de armazenamento do exportador de dados.
2253
+ * Usado para guardar ou recuperar as configurações do formulário.
2463
2254
  */
2464
2255
  "configName": string;
2465
2256
  /**
2466
- * @description Mapa com definições de botões personalizados. A chave do mapa deve ser informada na propriedade `buttons` no local onde o botão deve ser renderizado.
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.
2467
2258
  */
2468
2259
  "customButtons": Map<string, CustomButton>;
2469
2260
  /**
2470
- * @description Define o identificador do contêiner na DOM que é responsável por guardar os elementos personalizados que não podem ser passados por slot.
2471
- * @example Elementos customizados na Taskbar da aba de detalhes.
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.
2472
2262
  */
2473
2263
  "customContainerId": string;
2474
2264
  /**
2475
- * @description Define o identificador do slot que recebe elementos personalizados.
2265
+ * Usado para determinar o identificador do slot que recebe elementos personalizados.
2476
2266
  */
2477
2267
  "customSlotId": string;
2478
2268
  /**
2479
- * @description Instância do `DataUnit` com a qual a barra de tarefas irá interagir para realizar operações de dados (ex: salvar, próximo, anterior).
2269
+ * Instância do DataUnit.
2480
2270
  */
2481
2271
  "dataUnit": DataUnit;
2482
2272
  /**
2483
- * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
2273
+ * Array contendo todos os botões a serem desabilitados.
2484
2274
  */
2485
2275
  "disabledButtons": Array<string>;
2486
2276
  /**
2487
- * @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.
2488
2278
  */
2489
2279
  "messagesBuilder": SnkMessageBuilder;
2490
2280
  /**
2491
- * @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
2492
2282
  */
2493
2283
  "overflowStrategy": 'hiddenItems' | 'none';
2494
2284
  /**
2495
- * @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.
2496
2286
  */
2497
2287
  "presentationMode": PresentationMode1;
2498
2288
  /**
2499
- * @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.
2500
2290
  */
2501
2291
  "primaryButton": string;
2502
2292
  /**
2503
- * @description Identificador de recursos, como configurações e permissões de acesso.
2293
+ * Identificador de recursos como configurações e acesso.
2504
2294
  */
2505
2295
  "resourceID": string;
2506
2296
  }
@@ -3626,112 +3416,78 @@ declare namespace LocalJSX {
3626
3416
  interface SnkDataUnit {
3627
3417
  /**
3628
3418
  * Executado após a ação de salvar.
3629
- * @param dataUnit - A instância do DataUnit.
3630
- * @returns
3631
3419
  */
3632
3420
  "afterSave"?: (dataUnit: DataUnit) => void;
3633
3421
  /**
3634
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.
3635
- * @param dataUnit - A instância do DataUnit.
3636
- * @returns `false` para cancelar a ação, `true` para continuar.
3637
3423
  */
3638
3424
  "beforeSave"?: (dataUnit: DataUnit) => boolean | Promise<boolean>;
3639
3425
  /**
3640
3426
  * Usado para obter configuração de metadados.
3641
- * @type {string}
3642
3427
  */
3643
3428
  "configName"?: string;
3644
3429
  /**
3645
3430
  * Controla o estado atual dos dados.
3646
- * @type {DataState}
3647
3431
  */
3648
3432
  "dataState"?: DataState;
3649
3433
  /**
3650
3434
  * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
3651
- * @type {DataUnit}
3652
3435
  */
3653
3436
  "dataUnit"?: DataUnit;
3654
3437
  /**
3655
3438
  * Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade.
3656
- * @type {string}
3657
3439
  */
3658
3440
  "dataUnitName"?: string;
3659
3441
  /**
3660
3442
  * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
3661
- * @type {string}
3662
3443
  */
3663
3444
  "domainMessagesBuilder"?: string;
3664
3445
  /**
3665
3446
  * Determina qual a entidade que representa os dados em questão.
3666
- * @type {string}
3667
3447
  */
3668
3448
  "entityName"?: string;
3669
3449
  /**
3670
3450
  * Responsável por evitar a mensagem de sucesso ao salvar.
3671
- * @type {boolean}
3672
3451
  */
3673
3452
  "ignoreSaveMessage"?: boolean;
3674
3453
  /**
3675
3454
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
3676
- * @type {SnkMessageBuilder}
3677
3455
  */
3678
3456
  "messagesBuilder"?: SnkMessageBuilder;
3679
3457
  /**
3680
3458
  * Emitido quando se cancela uma inserção ou cópia.
3681
- * @event cancelEdition
3682
- * @type {CustomEvent<void>}
3683
- * @bubbles false
3684
3459
  */
3685
3460
  "onCancelEdition"?: (event: SnkDataUnitCustomEvent<void>) => void;
3686
3461
  /**
3687
3462
  * Emitido quando há qualquer mudança de estado no DataUnit.
3688
- * @event dataStateChange
3689
- * @type {CustomEvent<DataState>}
3690
- * @bubbles false
3691
3463
  */
3692
3464
  "onDataStateChange"?: (event: SnkDataUnitCustomEvent<DataState>) => void;
3693
3465
  /**
3694
3466
  * Emitido quando há campos no DataUnit que devem ser ocultados.
3695
- * @event dataUnitFieldsHidded
3696
- * @type {CustomEvent<void>}
3697
3467
  */
3698
3468
  "onDataUnitFieldsHidded"?: (event: SnkDataUnitCustomEvent<void>) => void;
3699
3469
  /**
3700
3470
  * Emitido quando o DataUnit está pronto.
3701
- * @event dataUnitReady
3702
- * @type {CustomEvent<DataUnit>}
3703
- * @bubbles false
3704
3471
  */
3705
3472
  "onDataUnitReady"?: (event: SnkDataUnitCustomEvent<DataUnit>) => void;
3706
3473
  /**
3707
3474
  * Emitido quando um registro é adicionado ou copiado.
3708
- * @event insertionMode
3709
- * @type {CustomEvent<void>}
3710
- * @bubbles false
3711
3475
  */
3712
3476
  "onInsertionMode"?: (event: SnkDataUnitCustomEvent<void>) => void;
3713
3477
  /**
3714
- * Emitido quando o messagesBuilder é atualizado.
3715
- * @event messagesBuilderUpdated
3716
- * @type {CustomEvent<SnkMessageBuilder>}
3717
- * @bubbles false
3478
+ * Emitido quando o DataUnit está pronto.
3718
3479
  */
3719
3480
  "onMessagesBuilderUpdated"?: (event: SnkDataUnitCustomEvent<SnkMessageBuilder>) => void;
3720
3481
  /**
3721
3482
  * Determina quantas linhas são retornadas por página.
3722
- * @type {number}
3723
- * @default 150
3724
3483
  */
3725
3484
  "pageSize"?: number;
3726
3485
  /**
3727
3486
  * Identificador de recursos como configurações e acesso.
3728
- * @type {string}
3729
3487
  */
3730
3488
  "resourceID"?: string;
3731
3489
  /**
3732
3490
  * Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição.
3733
- * @type {boolean}
3734
- * @default true
3735
3491
  */
3736
3492
  "useCancelConfirm"?: boolean;
3737
3493
  }
@@ -3954,65 +3710,56 @@ declare namespace LocalJSX {
3954
3710
  }
3955
3711
  interface SnkFilterBar {
3956
3712
  /**
3957
- * @description Função chamada depois de aplicar os filtros.
3713
+ * Função chamada depois de aplicar os filtros.
3958
3714
  */
3959
3715
  "afterApplyConfig"?: () => void;
3960
3716
  /**
3961
- * @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.
3962
3718
  */
3963
3719
  "autoLoad"?: boolean;
3964
3720
  /**
3965
- * @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.
3966
3722
  */
3967
3723
  "configName"?: string;
3968
3724
  /**
3969
- * @description Loader customizado para carregar as configurações.
3970
- * @param configName - Nome da configuração.
3971
- * @param resourceId - ID do recurso.
3972
- * @param options - Opções adicionais.
3973
- * @returns Retorna a configuração dos filtros.
3725
+ * Loader customizado para carregar as configurações
3974
3726
  */
3975
3727
  "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
3976
3728
  /**
3977
- * @description Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros.
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.
3978
3730
  */
3979
3731
  "dataUnit"?: DataUnit;
3980
3732
  /**
3981
- * @description Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados).
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).
3982
3734
  */
3983
3735
  "disablePersonalizedFilter"?: boolean;
3984
3736
  /**
3985
- * @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
3986
3738
  */
3987
3739
  "enableLockManagerLoadingComp"?: boolean;
3988
3740
  /**
3989
- * @description Chave da configuração legada da barra de filtros.
3741
+ * Chave da configuração legado da barra de filtros.
3990
3742
  */
3991
3743
  "filterBarLegacyConfigName"?: string;
3992
3744
  /**
3993
- * @description Lista todos os filtros disponíveis ao usuário.
3745
+ * Lista todos os filtros disponíveis ao usuário.
3994
3746
  */
3995
3747
  "filterConfig"?: Array<SnkFilterItemConfig>;
3996
3748
  /**
3997
- * @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.
3998
3750
  */
3999
3751
  "messagesBuilder"?: SnkMessageBuilder;
4000
3752
  /**
4001
- * @description Modo de apresentação da barra de filtros.
3753
+ * Modo de apresentação da filterbar.
4002
3754
  */
4003
3755
  "mode"?: "regular" | "button" | "hidden";
4004
- /**
4005
- * @description Evento emitido quando a configuração dos filtros é atualizada.
4006
- * @param configs - Lista de configurações de filtros atualizadas.
4007
- * @event
4008
- */
4009
3756
  "onConfigUpdated"?: (event: SnkFilterBarCustomEvent<SnkFilterItemConfig[]>) => void;
4010
3757
  /**
4011
- * @description Identificador de recursos como configurações e acesso.
3758
+ * Identificador de recursos como configurações e acesso.
4012
3759
  */
4013
3760
  "resourceID"?: string;
4014
3761
  /**
4015
- * @description Título que será apresentado na barra de filtros.
3762
+ * Título que será apresentado na barra de filtros
4016
3763
  */
4017
3764
  "title"?: string;
4018
3765
  }
@@ -4291,7 +4038,7 @@ declare namespace LocalJSX {
4291
4038
  */
4292
4039
  "configName"?: string;
4293
4040
  /**
4294
- * Chave da configuração legada do formulário.
4041
+ * Chave da configuração legado do formulário.
4295
4042
  */
4296
4043
  "formLegacyConfigName"?: string;
4297
4044
  /**
@@ -4299,15 +4046,15 @@ declare namespace LocalJSX {
4299
4046
  */
4300
4047
  "messagesBuilder"?: SnkMessageBuilder;
4301
4048
  /**
4302
- * @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.
4303
4050
  */
4304
4051
  "onActionClick"?: (event: SnkFormCustomEvent<string>) => void;
4305
4052
  /**
4306
- * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
4053
+ * Emitido quando o botão de voltar é acionado.
4307
4054
  */
4308
4055
  "onExit"?: (event: SnkFormCustomEvent<void>) => void;
4309
4056
  /**
4310
- * 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.
4311
4058
  */
4312
4059
  "onFormItemsReady"?: (event: SnkFormCustomEvent<Array<HTMLElement>>) => void;
4313
4060
  /**
@@ -4436,43 +4183,40 @@ declare namespace LocalJSX {
4436
4183
  }
4437
4184
  interface SnkGrid {
4438
4185
  /**
4439
- * 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.
4440
4187
  */
4441
4188
  "actionsList"?: Array<Action>;
4442
4189
  /**
4443
- * Define se a grade receberá o foco automaticamente ao ser carregada.
4190
+ * Define se a grid será focada ao ser carregada.
4444
4191
  */
4445
4192
  "autoFocus"?: boolean;
4446
4193
  /**
4447
- * 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.
4448
4195
  */
4449
4196
  "autoLoad"?: boolean;
4450
4197
  /**
4451
- * Define se a edição de dados na grade está habilitada.
4198
+ * Define se a edição está habilitada na grid.
4452
4199
  */
4453
4200
  "canEdit"?: boolean;
4454
- /**
4455
- * Define o data source para o filtro de colunas.
4456
- */
4457
4201
  "columnFilterDataSource"?: IMultiSelectionListDataSource;
4458
4202
  /**
4459
- * Define se a grade deve ser exibida em modo compacto.
4203
+ * Define se a grade deve ser exibida em modo compacto
4460
4204
  */
4461
4205
  "compact"?: boolean;
4462
4206
  /**
4463
- * Nome usado para salvar e recuperar a configuração da grade.
4207
+ * Nome usado para salvar/recuperar a configuração.
4464
4208
  */
4465
4209
  "configName"?: string;
4466
4210
  /**
4467
- * 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).
4468
4212
  */
4469
4213
  "disablePersonalizedFilter"?: boolean;
4470
4214
  /**
4471
- * Habilita a inserção de registros diretamente na grade.
4215
+ * Ativa inserção de registros no modo grade.
4472
4216
  */
4473
4217
  "enableGridInsert"?: boolean;
4474
4218
  /**
4475
- * 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
4476
4220
  */
4477
4221
  "enableLockManagerLoadingComp"?: boolean;
4478
4222
  /**
@@ -4480,23 +4224,23 @@ declare namespace LocalJSX {
4480
4224
  */
4481
4225
  "enableLockManagerTaskbarClick"?: boolean;
4482
4226
  /**
4483
- * Chave da configuração legada da barra de filtros.
4227
+ * Chave da configuração legado da barra de filtros.
4484
4228
  */
4485
4229
  "filterBarLegacyConfigName"?: string;
4486
4230
  /**
4487
- * Título que será apresentado na barra de filtros.
4231
+ * Título que será apresentado na barra de filtros
4488
4232
  */
4489
4233
  "filterBarTitle"?: string;
4490
4234
  /**
4491
- * 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.
4492
4236
  */
4493
4237
  "gridHeaderCustomSlotId"?: string;
4494
4238
  /**
4495
- * Chave da configuração legada da grade.
4239
+ * Chave da configuração legado da grade.
4496
4240
  */
4497
4241
  "gridLegacyConfigName"?: string;
4498
4242
  /**
4499
- * Determina se a grade está vinculada a um detalhe de outra tela.
4243
+ * Determina se a grade está vinculada a um detalhe.
4500
4244
  */
4501
4245
  "isDetail"?: boolean;
4502
4246
  /**
@@ -4504,17 +4248,15 @@ declare namespace LocalJSX {
4504
4248
  */
4505
4249
  "messagesBuilder"?: SnkMessageBuilder;
4506
4250
  /**
4507
- * Habilita a edição de múltiplos registros simultaneamente.
4251
+ * Habilita a edição de múltiplos registros simultâneos.
4508
4252
  */
4509
4253
  "multipleEditionEnabled"?: boolean;
4510
4254
  /**
4511
- * Determina se a seleção de múltiplas linhas é permitida.
4255
+ * Determina se pode haver mais de uma linha selecionada.
4512
4256
  */
4513
4257
  "multipleSelection"?: boolean;
4514
4258
  /**
4515
- * Emitido ao clicar em um botão de ação ou item de menu.
4516
- * @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.
4517
- * @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.
4518
4260
  */
4519
4261
  "onActionClick"?: (event: SnkGridCustomEvent<string>) => void;
4520
4262
  /**
@@ -4522,74 +4264,67 @@ declare namespace LocalJSX {
4522
4264
  */
4523
4265
  "onComponentReady"?: (event: SnkGridCustomEvent<void>) => void;
4524
4266
  /**
4525
- * Emitido ao realizar um duplo clique em uma linha da grade.
4526
- * @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.
4527
- * @param detail - Detalhes do evento, contendo a linha clicada.
4267
+ * Emitido sempre que houver duplo click na grade.
4528
4268
  */
4529
4269
  "onGridDoubleClick"?: (event: SnkGridCustomEvent<any>) => void;
4530
4270
  /**
4531
- * 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)
4532
4272
  */
4533
4273
  "outlineMode"?: boolean;
4534
4274
  /**
4535
- * Define o modo de exibição do contador de paginação.
4275
+ * Define se a grid será focada ao ser carregada.
4536
4276
  */
4537
4277
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
4538
4278
  /**
4539
- * 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.
4540
4280
  */
4541
4281
  "presentationMode"?: PresentationMode1;
4542
4282
  /**
4543
- * 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.
4544
4284
  */
4545
4285
  "recordsValidator"?: IRecordValidator;
4546
4286
  /**
4547
- * Identificador de recursos, como configurações e permissões de acesso.
4287
+ * Identificador de recursos como configurações e acesso.
4548
4288
  */
4549
4289
  "resourceID"?: string;
4550
4290
  /**
4551
- * Configuração do toast de seleção da grade.
4291
+ * Configuração da seleção de grade no toast.
4552
4292
  */
4553
4293
  "selectionToastConfig"?: ISelectionToastConfig;
4554
4294
  /**
4555
- * Define a configuração de cores para a coluna de status.
4556
- * @example ```json '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' ```
4295
+ * Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
4557
4296
  */
4558
4297
  "statusResolver"?: IStatusResolver | StatusResolverFunction;
4559
4298
  /**
4560
- * Define o modo de exportação dos dados.
4299
+ * Modo de exportação dos dados.
4561
4300
  */
4562
4301
  "strategyExporter"?: IExporterStrategyMode;
4563
4302
  /**
4564
- * Informa se a coluna de checkbox deve ser suprimida.
4303
+ * Informa se a coluna de chechbox deve ser suprimida
4565
4304
  */
4566
4305
  "suppressCheckboxColumn"?: boolean;
4567
4306
  /**
4568
- * Informa se a grade deve suprimir o filtro de coluna.
4569
- */
4570
- "suppressFilterColumn"?: boolean;
4571
- /**
4572
- * Define se a grade deve suprimir a barra de rolagem horizontal.
4307
+ * Define se a grade deve suprimir o scroll horizontal.
4573
4308
  */
4574
4309
  "suppressHorizontalScroll"?: boolean;
4575
4310
  /**
4576
- * Define o identificador do contêiner de elementos customizados da `Taskbar`.
4311
+ * Define o identificador do container de elementos customizados da Taskbar.
4577
4312
  */
4578
4313
  "taskbarCustomContainerId"?: string;
4579
4314
  /**
4580
- * 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.
4581
4316
  */
4582
4317
  "taskbarManager"?: TaskbarManager;
4583
4318
  /**
4584
- * 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.
4585
4320
  */
4586
4321
  "topTaskbarCustomSlotId"?: string;
4587
4322
  /**
4588
- * 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.
4589
4324
  */
4590
4325
  "useEnterLikeTab"?: boolean;
4591
4326
  /**
4592
- * 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
4593
4328
  */
4594
4329
  "useSearchColumn"?: boolean;
4595
4330
  }
@@ -4718,49 +4453,30 @@ declare namespace LocalJSX {
4718
4453
  }
4719
4454
  interface SnkPersonalizedFilter {
4720
4455
  /**
4721
- * Nome da configuração, utilizado para distinguir múltiplas instâncias do componente.
4722
- * @property
4456
+ * Nome da configuração. Serve para distinguir várias instâncias do componente.
4723
4457
  */
4724
4458
  "configName"?: string;
4725
4459
  /**
4726
- * URI da entidade utilizada para buscar os campos disponíveis para filtro.
4727
- * @property
4460
+ * Responsável por receber a URI da entidade.
4728
4461
  */
4729
4462
  "entityUri"?: string;
4730
4463
  /**
4731
- * Identificador do filtro a ser carregado.
4732
- * @property
4464
+ * Id do filtro que será carregado.
4733
4465
  */
4734
4466
  "filterId"?: string;
4735
4467
  /**
4736
- * Indica se o filtro é o filtro padrão do sistema.
4737
- * @property
4738
- * @default false
4468
+ * Define se o filtro em questão é um filtro padrão.
4739
4469
  */
4740
4470
  "isDefaultFilter"?: boolean;
4741
4471
  /**
4742
4472
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4743
- * @property
4744
4473
  */
4745
4474
  "messagesBuilder"?: SnkMessageBuilder;
4746
- /**
4747
- * Evento emitido após salvar as alterações do filtro personalizado.
4748
- * @event
4749
- */
4750
4475
  "onEzAfterSave"?: (event: SnkPersonalizedFilterCustomEvent<void>) => void;
4751
- /**
4752
- * Evento emitido ao cancelar a personalização do filtro.
4753
- * @event
4754
- */
4755
4476
  "onEzCancel"?: (event: SnkPersonalizedFilterCustomEvent<void>) => void;
4756
- /**
4757
- * Evento emitido ao salvar as alterações do filtro personalizado.
4758
- * @event
4759
- */
4760
4477
  "onEzSave"?: (event: SnkPersonalizedFilterCustomEvent<string>) => void;
4761
4478
  /**
4762
- * Identificador do recurso utilizado para salvar e recuperar filtros.
4763
- * @property
4479
+ * Nome da configuração. Serve para distinguir várias instâncias do componente.
4764
4480
  */
4765
4481
  "resourceID"?: string;
4766
4482
  }
@@ -4791,53 +4507,31 @@ declare namespace LocalJSX {
4791
4507
  }
4792
4508
  interface SnkPesquisa {
4793
4509
  /**
4794
- * Define se permite a seleção de itens não analíticos.
4795
- * @type {boolean}
4796
- * @default false
4797
- * @example allowsNonAnalytic={true}
4510
+ * Define se permite seleção de items não analíticos
4798
4511
  */
4799
4512
  "allowsNonAnalytic"?: boolean;
4800
4513
  /**
4801
- * Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente.
4802
- * @type {string}
4803
- * @mutable
4804
- * @example argument="Texto para pesquisa"
4514
+ * Argumentos que serão usados ao chamar a função searchLoader.
4805
4515
  */
4806
4516
  "argument"?: string;
4807
4517
  /**
4808
- * Nome da entidade sobre a qual a pesquisa será realizada.
4809
- * @type {string}
4810
- * @example entityName="Produto"
4518
+ * Nome da entidade onde a pesquisa é aplicada.
4811
4519
  */
4812
4520
  "entityName"?: string;
4813
4521
  /**
4814
- * Define se a popup de pesquisa terá ou não modo hierárquico.
4815
- * @type {boolean}
4816
- * @default false
4817
- * @example isHierarchyEntity={true}
4522
+ * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
4818
4523
  */
4819
4524
  "isHierarchyEntity"?: boolean;
4820
4525
  /**
4821
- * Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados.
4822
- * @type {(text: string) => Promise<any>}
4823
- * @param text Texto utilizado como argumento de pesquisa.
4824
- * @returns Promise com os dados da pesquisa.
4825
- * @example searchLoader={(text) => fetchItems(text)}
4526
+ * Função responsável em carregar os itens do componente snk-pesquisa.
4826
4527
  */
4827
4528
  "searchLoader"?: (text: string) => Promise<any>;
4828
4529
  /**
4829
- * Função disparada ao selecionar um item da pesquisa.
4830
- * @type {(option: IOption) => void}
4831
- * @param option Item selecionado.
4832
- * @returns void
4833
- * @example selectItem={(option) => handleSelect(option)}
4530
+ * Função disparada ao selecionar um item.
4834
4531
  */
4835
4532
  "selectItem"?: (option: IOption2) => void;
4836
4533
  /**
4837
- * Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível.
4838
- * @type {(text: string) => Promise<any>}
4839
- * @param text Texto utilizado como argumento de pesquisa para a árvore.
4840
- * @returns Promise com os dados da árvore.
4534
+ * Função responsável por carregar a árvore hierárquica do componente
4841
4535
  */
4842
4536
  "treeLoader"?: (text: string) => Promise<any>;
4843
4537
  }
@@ -4859,11 +4553,11 @@ declare namespace LocalJSX {
4859
4553
  }
4860
4554
  interface SnkSimpleBar {
4861
4555
  /**
4862
- * Define os itens que serão apresentados no breadcrumb.
4556
+ * Define os itens que serão apresentados pelo breadcrumb
4863
4557
  */
4864
4558
  "breadcrumbItens"?: Array<IBreadcrumbItem>;
4865
4559
  /**
4866
- * Define o título do header.
4560
+ * Define o título do header
4867
4561
  */
4868
4562
  "label"?: string;
4869
4563
  /**
@@ -4871,157 +4565,136 @@ declare namespace LocalJSX {
4871
4565
  */
4872
4566
  "messagesBuilder"?: SnkMessageBuilder;
4873
4567
  /**
4874
- * Emitido quando algum item do breadcrumb é clicado.
4568
+ * Emitido quando algum item do breadcrumb é clicado
4875
4569
  */
4876
4570
  "onClickBreadcrumbItem"?: (event: SnkSimpleBarCustomEvent<IBreadcrumbItem>) => void;
4877
4571
  /**
4878
- * Emitido quando o botão "voltar" é acionado.
4572
+ * Emitido quando o botão voltar é acionado
4879
4573
  */
4880
4574
  "onExit"?: (event: SnkSimpleBarCustomEvent<void>) => void;
4881
4575
  }
4882
4576
  interface SnkSimpleCrud {
4883
4577
  /**
4884
- * @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.
4885
4579
  */
4886
4580
  "actionsList"?: Array<Action>;
4887
4581
  /**
4888
- * @description Define se a grade será focada ao ser carregada.
4582
+ * Define se a grid será focada ao ser carregada.
4889
4583
  */
4890
4584
  "autoFocus"?: boolean;
4891
4585
  /**
4892
- * @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.
4893
4587
  */
4894
4588
  "autoLoad"?: boolean;
4895
4589
  /**
4896
- * @description Usado para salvar as configurações dos blocos de construção.
4590
+ * Usado para salvar as configurações dos blocos de construção.
4897
4591
  */
4898
4592
  "configName"?: string;
4899
- /**
4900
- * @description Estado atual dos dados.
4901
- */
4902
4593
  "dataState"?: DataState1;
4903
- /**
4904
- * @description Instância do DataUnit a ser utilizada pelo componente.
4905
- */
4906
4594
  "dataUnit"?: DataUnit;
4907
4595
  /**
4908
- * @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)
4909
4597
  */
4910
4598
  "domainMessagesBuilder"?: string;
4911
- /**
4912
- * @description Habilita a inserção contínua de registros.
4913
- */
4914
4599
  "enableContinuousInsert"?: boolean;
4915
4600
  /**
4916
- * @description Ativa a inserção de registros no modo grade.
4601
+ * Ativa inserção de registros no modo grade.
4917
4602
  */
4918
4603
  "enableGridInsert"?: boolean;
4919
4604
  /**
4920
- * @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
4921
4606
  */
4922
4607
  "enableLockManagerLoadingComp"?: boolean;
4923
4608
  /**
4924
- * @description Ativa o gerenciamento de locks na grade pela Taskbar.
4609
+ * Ativa o gerenciamento de locks na grade pela Taskbar.
4925
4610
  */
4926
4611
  "enableLockManagerTaskbarClick"?: boolean;
4927
4612
  /**
4928
- * @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
4929
4614
  */
4930
4615
  "entityName"?: string;
4931
- /**
4932
- * @description Configuração do formulário.
4933
- */
4934
4616
  "formConfig"?: IFormConfig;
4935
4617
  /**
4936
- * @description Chave da configuração legada do formulário.
4618
+ * Chave da configuração legado do formulário.
4937
4619
  */
4938
4620
  "formLegacyConfigName"?: string;
4939
- /**
4940
- * @description Configuração da grade.
4941
- */
4942
4621
  "gridConfig"?: IGridConfig;
4943
4622
  /**
4944
- * @description Chave da configuração legada da grade.
4623
+ * Chave da configuração legado da grade.
4945
4624
  */
4946
4625
  "gridLegacyConfigName"?: string;
4947
4626
  /**
4948
- * @description Ignora os campos "somente leitura" no modo de inserção.
4627
+ * Ignora os campos "somente leitura" no modo de inserção.
4949
4628
  */
4950
4629
  "ignoreReadOnlyFormFields"?: boolean;
4951
4630
  /**
4952
- * @description Define se o LayoutFormConfig será exibido no configurador.
4631
+ * Define se o LayoutFormConfig será exibido no configurador.
4953
4632
  */
4954
4633
  "layoutFormConfig"?: boolean;
4955
4634
  /**
4956
- * @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.
4957
4636
  */
4958
4637
  "messagesBuilder"?: SnkMessageBuilder;
4959
- /**
4960
- * @description Define o modo de operação do CRUD (servidor ou em memória).
4961
- */
4962
4638
  "mode"?: SIMPLE_CRUD_MODE;
4963
4639
  /**
4964
- * @description Habilita a edição de múltiplos registros simultâneos.
4640
+ * Habilita a edição de múltiplos registros simultâneos.
4965
4641
  */
4966
4642
  "multipleEditionEnabled"?: boolean;
4967
4643
  /**
4968
- * @description Determina se pode haver mais de uma linha selecionada na grade.
4644
+ * Determina se pode haver mais de uma linha selecionada na grade.
4969
4645
  */
4970
4646
  "multipleSelection"?: boolean;
4971
4647
  /**
4972
- * @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.
4973
4649
  */
4974
4650
  "onActionClick"?: (event: SnkSimpleCrudCustomEvent<string>) => void;
4975
4651
  /**
4976
- * @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.
4977
4653
  */
4978
4654
  "onConfiguratorCancel"?: (event: SnkSimpleCrudCustomEvent<any>) => void;
4979
4655
  /**
4980
- * @description Emitido quando a configuração no configurador do CRUD é salva.
4656
+ * Emitido quando salva a configuração no configurator do CRUD.
4981
4657
  */
4982
4658
  "onConfiguratorSave"?: (event: SnkSimpleCrudCustomEvent<any>) => void;
4983
4659
  /**
4984
- * @description Emitido quando há qualquer mudança de estado no DataUnit.
4660
+ * Emitido quando há qualquer mudança de estado no DataUnit.
4985
4661
  */
4986
4662
  "onDataStateChange"?: (event: SnkSimpleCrudCustomEvent<DataState1>) => void;
4987
4663
  /**
4988
- * @description Emitido quando o DataUnit está pronto.
4664
+ * Emitido quando o DataUnit está pronto.
4989
4665
  */
4990
4666
  "onDataUnitReady"?: (event: SnkSimpleCrudCustomEvent<DataUnit>) => void;
4991
4667
  /**
4992
- * @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.
4993
4669
  */
4994
4670
  "onFormItemsReady"?: (event: SnkSimpleCrudCustomEvent<Array<HTMLElement>>) => void;
4995
4671
  /**
4996
- * @description Altera visualmente as sombras e bordas do componente. Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout). Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up).
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)
4997
4673
  */
4998
4674
  "outlineMode"?: boolean;
4999
4675
  /**
5000
- * @description Determina quantas linhas são retornadas por página.
4676
+ * Determina quantas linhas são retornadas por página.
5001
4677
  */
5002
4678
  "pageSize"?: number;
5003
4679
  /**
5004
- * @description Define o modo de exibição do contador de paginação.
4680
+ * Define se a grid será focada ao ser carregada.
5005
4681
  */
5006
4682
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
5007
4683
  /**
5008
- * @description Identificador de recursos como configurações e acesso.
4684
+ * Identificador de recursos como configurações e acesso.
5009
4685
  */
5010
4686
  "resourceID"?: string;
5011
4687
  /**
5012
- * @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.
5013
4689
  */
5014
4690
  "showConfiguratorButtons"?: boolean;
5015
4691
  /**
5016
- * @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.
5017
4693
  */
5018
4694
  "taskbarManager"?: TaskbarManager;
5019
- /**
5020
- * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
5021
- */
5022
4695
  "useCancelConfirm"?: boolean;
5023
4696
  /**
5024
- * @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.
5025
4698
  */
5026
4699
  "useEnterLikeTab"?: boolean;
5027
4700
  }
@@ -5042,79 +4715,75 @@ declare namespace LocalJSX {
5042
4715
  }
5043
4716
  interface SnkTaskbar {
5044
4717
  /**
5045
- * @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.
5046
4719
  */
5047
4720
  "actionsList"?: Array<Action>;
5048
4721
  /**
5049
- * @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.
5050
4723
  */
5051
4724
  "actionsSettingsList"?: Array<Action>;
5052
4725
  /**
5053
- * @description Define o alinhamento dos itens da barra de tarefas à direita.
4726
+ * Usado para determinar O alinhamento dos items na taskbar.
5054
4727
  */
5055
4728
  "alignRigth"?: boolean;
5056
4729
  /**
5057
- * @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.
5058
4731
  */
5059
4732
  "buttons"?: string;
5060
4733
  /**
5061
- * @description Nome da configuração usada para salvar ou recuperar as configurações do formulário. Também é utilizado como fallback para a chave de armazenamento do exportador de dados.
4734
+ * Usado para guardar ou recuperar as configurações do formulário.
5062
4735
  */
5063
4736
  "configName"?: string;
5064
4737
  /**
5065
- * @description Mapa com definições de botões personalizados. A chave do mapa deve ser informada na propriedade `buttons` no local onde o botão deve ser renderizado.
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.
5066
4739
  */
5067
4740
  "customButtons"?: Map<string, CustomButton>;
5068
4741
  /**
5069
- * @description Define o identificador do contêiner na DOM que é responsável por guardar os elementos personalizados que não podem ser passados por slot.
5070
- * @example Elementos customizados na Taskbar da aba de detalhes.
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.
5071
4743
  */
5072
4744
  "customContainerId"?: string;
5073
4745
  /**
5074
- * @description Define o identificador do slot que recebe elementos personalizados.
4746
+ * Usado para determinar o identificador do slot que recebe elementos personalizados.
5075
4747
  */
5076
4748
  "customSlotId"?: string;
5077
4749
  /**
5078
- * @description Instância do `DataUnit` com a qual a barra de tarefas irá interagir para realizar operações de dados (ex: salvar, próximo, anterior).
4750
+ * Instância do DataUnit.
5079
4751
  */
5080
4752
  "dataUnit"?: DataUnit;
5081
4753
  /**
5082
- * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
4754
+ * Array contendo todos os botões a serem desabilitados.
5083
4755
  */
5084
4756
  "disabledButtons"?: Array<string>;
5085
4757
  /**
5086
- * @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.
5087
4759
  */
5088
4760
  "messagesBuilder"?: SnkMessageBuilder;
5089
4761
  /**
5090
- * @description Emitido sempre que um botão ou uma ação da barra de tarefas é clicado.
5091
- * @eventProperty
4762
+ * Emitido sempre que houver click de botão ou ação.
5092
4763
  */
5093
4764
  "onActionClick"?: (event: SnkTaskbarCustomEvent<string>) => void;
5094
4765
  /**
5095
- * @description Emitido quando uma ação de salvar é iniciada pela barra de tarefas, indicando um estado de bloqueio para evitar ações concorrentes.
5096
- * @eventProperty
4766
+ * Emitido sempre que um save é iniciado pela taskbar.
5097
4767
  */
5098
4768
  "onTaskbarSaveLocker"?: (event: SnkTaskbarCustomEvent<void>) => void;
5099
4769
  /**
5100
- * @description Emitido quando a ação de salvar é concluída ou cancelada, liberando o estado de bloqueio.
5101
- * @eventProperty
4770
+ * Emitido sempre que o ocorre alguma action que libera o save.
5102
4771
  */
5103
4772
  "onTaskbarSaveUnlocker"?: (event: SnkTaskbarCustomEvent<void>) => void;
5104
4773
  /**
5105
- * @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
5106
4775
  */
5107
4776
  "overflowStrategy"?: 'hiddenItems' | 'none';
5108
4777
  /**
5109
- * @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.
5110
4779
  */
5111
4780
  "presentationMode"?: PresentationMode1;
5112
4781
  /**
5113
- * @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.
5114
4783
  */
5115
4784
  "primaryButton"?: string;
5116
4785
  /**
5117
- * @description Identificador de recursos, como configurações e permissões de acesso.
4786
+ * Identificador de recursos como configurações e acesso.
5118
4787
  */
5119
4788
  "resourceID"?: string;
5120
4789
  }