@sankhyalabs/sankhyablocks 9.2.0-ms.2 → 9.2.0-ms.4
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.
- package/dist/cjs/loader.cjs.js +1 -1
- package/dist/cjs/sankhyablocks.cjs.js +1 -1
- package/dist/cjs/snk-data-exporter.cjs.entry.js +1 -1
- package/dist/cjs/{snk-data-unit-448fce74.js → snk-data-unit-72715da9.js} +11 -1
- package/dist/cjs/snk-data-unit.cjs.entry.js +1 -1
- package/dist/cjs/snk-form_2.cjs.entry.js +27 -1
- package/dist/cjs/snk-grid.cjs.entry.js +51 -7
- package/dist/collection/components/snk-data-unit/snk-data-unit.js +173 -28
- package/dist/collection/components/snk-form/snk-form.js +133 -22
- package/dist/collection/components/snk-grid/snk-grid.js +300 -85
- package/dist/components/snk-data-unit2.js +11 -1
- package/dist/components/snk-form.js +29 -2
- package/dist/components/snk-grid2.js +51 -7
- package/dist/esm/loader.js +1 -1
- package/dist/esm/sankhyablocks.js +1 -1
- package/dist/esm/snk-data-exporter.entry.js +1 -1
- package/dist/esm/{snk-data-unit-b7e6e7a6.js → snk-data-unit-d31619fb.js} +11 -1
- package/dist/esm/snk-data-unit.entry.js +1 -1
- package/dist/esm/snk-form_2.entry.js +27 -1
- package/dist/esm/snk-grid.entry.js +51 -7
- package/dist/sankhyablocks/{p-8d1508aa.entry.js → p-69b815ab.entry.js} +1 -1
- package/dist/sankhyablocks/p-6fa3d474.entry.js +1 -0
- package/dist/sankhyablocks/{p-158adf33.entry.js → p-a2e8c7a7.entry.js} +1 -1
- package/dist/sankhyablocks/sankhyablocks.esm.js +1 -1
- package/dist/types/components/snk-data-unit/snk-data-unit.d.ts +46 -3
- package/dist/types/components/snk-form/snk-form.d.ts +29 -4
- package/dist/types/components/snk-grid/snk-grid.d.ts +100 -46
- package/dist/types/components.d.ts +217 -80
- package/package.json +4 -3
- package/dist/sankhyablocks/p-fa18530e.entry.js +0 -1
- /package/dist/sankhyablocks/{p-0e495575.js → p-8b601472.js} +0 -0
@@ -901,75 +901,102 @@ export namespace Components {
|
|
901
901
|
interface SnkDataUnit {
|
902
902
|
/**
|
903
903
|
* Executado após a ação de salvar.
|
904
|
+
* @param dataUnit - A instância do DataUnit.
|
905
|
+
* @returns
|
904
906
|
*/
|
905
907
|
"afterSave": (dataUnit: DataUnit) => void;
|
906
908
|
/**
|
907
909
|
* Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação.
|
910
|
+
* @param dataUnit - A instância do DataUnit.
|
911
|
+
* @returns `false` para cancelar a ação, `true` para continuar.
|
908
912
|
*/
|
909
913
|
"beforeSave": (dataUnit: DataUnit) => boolean | Promise<boolean>;
|
910
914
|
/**
|
911
915
|
* Usado para obter configuração de metadados.
|
916
|
+
* @type {string}
|
912
917
|
*/
|
913
918
|
"configName": string;
|
914
919
|
/**
|
915
920
|
* Controla o estado atual dos dados.
|
921
|
+
* @type {DataState}
|
916
922
|
*/
|
917
923
|
"dataState": DataState;
|
918
924
|
/**
|
919
925
|
* Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
|
926
|
+
* @type {DataUnit}
|
920
927
|
*/
|
921
928
|
"dataUnit": DataUnit;
|
922
929
|
/**
|
923
930
|
* Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade.
|
931
|
+
* @type {string}
|
924
932
|
*/
|
925
933
|
"dataUnitName": string;
|
926
934
|
/**
|
927
935
|
* Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
|
936
|
+
* @type {string}
|
928
937
|
*/
|
929
938
|
"domainMessagesBuilder": string;
|
930
939
|
/**
|
931
940
|
* Determina qual a entidade que representa os dados em questão.
|
941
|
+
* @type {string}
|
932
942
|
*/
|
933
943
|
"entityName": string;
|
934
944
|
/**
|
935
945
|
* Obtém o dataUnit.
|
946
|
+
* @returns Uma promessa que resolve com a instância do DataUnit.
|
947
|
+
* @async
|
936
948
|
*/
|
937
949
|
"getDataUnit": () => Promise<DataUnit>;
|
938
950
|
/**
|
939
951
|
* Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
|
952
|
+
* @returns Uma promessa que resolve com um array de nomes de campos.
|
953
|
+
* @async
|
940
954
|
*/
|
941
955
|
"getFieldsWithRmPrecision": () => Promise<string[]>;
|
942
956
|
/**
|
943
957
|
* Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
|
958
|
+
* @returns Uma promessa que resolve com um array de nomes de campos.
|
959
|
+
* @async
|
944
960
|
*/
|
945
961
|
"getFieldsWithRmp": () => Promise<string[]>;
|
946
962
|
/**
|
947
963
|
* Busca os metadados da linha selecionada.
|
964
|
+
* @param record - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado.
|
965
|
+
* @returns Uma promessa que resolve com os metadados da linha.
|
966
|
+
* @async
|
948
967
|
*/
|
949
968
|
"getRowMetadata": (record?: Record | string) => Promise<RowMetadata>;
|
950
969
|
/**
|
951
970
|
* Método que retorna a lista de IDs dos registros selecionados.
|
952
|
-
* @returns Retorna a lista de IDs dos registros selecionados.
|
971
|
+
* @returns Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
|
972
|
+
* @async
|
953
973
|
*/
|
954
974
|
"getSelectedRecordsIDsInfo": () => Promise<Array<IRecordID>>;
|
955
975
|
/**
|
956
976
|
* Responsável por evitar a mensagem de sucesso ao salvar.
|
977
|
+
* @type {boolean}
|
957
978
|
*/
|
958
979
|
"ignoreSaveMessage": boolean;
|
959
980
|
/**
|
960
981
|
* Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
982
|
+
* @type {SnkMessageBuilder}
|
961
983
|
*/
|
962
984
|
"messagesBuilder": SnkMessageBuilder;
|
963
985
|
/**
|
964
986
|
* Determina quantas linhas são retornadas por página.
|
987
|
+
* @type {number}
|
988
|
+
* @default 150
|
965
989
|
*/
|
966
990
|
"pageSize": number;
|
967
991
|
/**
|
968
992
|
* Identificador de recursos como configurações e acesso.
|
993
|
+
* @type {string}
|
969
994
|
*/
|
970
995
|
"resourceID": string;
|
971
996
|
/**
|
972
997
|
* Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição.
|
998
|
+
* @type {boolean}
|
999
|
+
* @default true
|
973
1000
|
*/
|
974
1001
|
"useCancelConfirm": boolean;
|
975
1002
|
}
|
@@ -1527,7 +1554,11 @@ export namespace Components {
|
|
1527
1554
|
}
|
1528
1555
|
interface SnkForm {
|
1529
1556
|
/**
|
1530
|
-
* Registra um editor customizado para campos
|
1557
|
+
* Registra um editor customizado para campos do formulário.
|
1558
|
+
* @async
|
1559
|
+
* @param fieldName - Nome do campo.
|
1560
|
+
* @param customEditor - Editor customizado.
|
1561
|
+
* @returns
|
1531
1562
|
*/
|
1532
1563
|
"addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise<void>;
|
1533
1564
|
/**
|
@@ -1535,11 +1566,13 @@ export namespace Components {
|
|
1535
1566
|
*/
|
1536
1567
|
"configName": string;
|
1537
1568
|
/**
|
1538
|
-
* Chave da configuração
|
1569
|
+
* Chave da configuração legada do formulário.
|
1539
1570
|
*/
|
1540
1571
|
"formLegacyConfigName": string;
|
1541
1572
|
/**
|
1542
1573
|
* Fecha a janela de configurações do formulário.
|
1574
|
+
* @async
|
1575
|
+
* @returns
|
1543
1576
|
*/
|
1544
1577
|
"hideConfig": () => Promise<void>;
|
1545
1578
|
/**
|
@@ -1556,12 +1589,26 @@ export namespace Components {
|
|
1556
1589
|
"resourceID": string;
|
1557
1590
|
/**
|
1558
1591
|
* Altera/adiciona uma propriedade nos metadados do campo.
|
1592
|
+
* @async
|
1593
|
+
* @param fieldName - Nome do campo.
|
1594
|
+
* @param propName - Nome da propriedade.
|
1595
|
+
* @param value - Valor da propriedade.
|
1596
|
+
* @returns
|
1559
1597
|
*/
|
1560
1598
|
"setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
|
1561
1599
|
/**
|
1562
1600
|
* Exibe a janela de configurações do formulário.
|
1601
|
+
* @async
|
1602
|
+
* @returns
|
1563
1603
|
*/
|
1564
1604
|
"showConfig": () => Promise<void>;
|
1605
|
+
/**
|
1606
|
+
* Valida o formulário.
|
1607
|
+
* @async
|
1608
|
+
* @returns
|
1609
|
+
* @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.
|
1610
|
+
*/
|
1611
|
+
"validate": () => Promise<void>;
|
1565
1612
|
}
|
1566
1613
|
interface SnkFormConfig {
|
1567
1614
|
/**
|
@@ -1673,52 +1720,72 @@ export namespace Components {
|
|
1673
1720
|
}
|
1674
1721
|
interface SnkGrid {
|
1675
1722
|
/**
|
1676
|
-
* Lista de ações que devem ser usadas no botão "Mais opções" do
|
1723
|
+
* Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`.
|
1677
1724
|
*/
|
1678
1725
|
"actionsList": Array<Action>;
|
1679
1726
|
/**
|
1680
|
-
* Registra um editor customizado para
|
1727
|
+
* Registra um editor customizado para um campo da grade ou formulário.
|
1728
|
+
* @async
|
1729
|
+
* @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.
|
1730
|
+
* @param fieldName O nome do campo que receberá o editor customizado.
|
1731
|
+
* @param customEditor A instância do editor customizado.
|
1732
|
+
* @param detailContext O contexto de detalhe onde o editor será aplicado (opcional).
|
1733
|
+
* @returns Uma promessa que é resolvida quando o editor é registrado.
|
1681
1734
|
*/
|
1682
1735
|
"addCustomEditor": (fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>;
|
1683
1736
|
/**
|
1684
|
-
* Registra um formatador de
|
1737
|
+
* Registra um formatador de valor customizado para uma coluna da grade.
|
1738
|
+
* @async
|
1739
|
+
* @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
|
1740
|
+
* @param columnName O nome da coluna que receberá o formatador.
|
1741
|
+
* @param customFormatter A instância do formatador de valor.
|
1742
|
+
* @returns Uma promessa que é resolvida quando o formatador é registrado.
|
1685
1743
|
*/
|
1686
1744
|
"addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise<void>;
|
1687
1745
|
/**
|
1688
|
-
* Registra um
|
1746
|
+
* Registra um renderizador customizado para uma coluna da grade.
|
1747
|
+
* @async
|
1748
|
+
* @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
|
1749
|
+
* @param fieldName O nome do campo (coluna) que receberá o renderizador customizado.
|
1750
|
+
* @param customRender A instância do renderizador customizado.
|
1751
|
+
* @param detailContext O contexto de detalhe onde o renderizador será aplicado (opcional).
|
1752
|
+
* @returns Uma promessa que é resolvida quando o renderizador é registrado.
|
1689
1753
|
*/
|
1690
1754
|
"addGridCustomRender": (fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>;
|
1691
1755
|
/**
|
1692
|
-
* Define se a
|
1756
|
+
* Define se a grade receberá o foco automaticamente ao ser carregada.
|
1693
1757
|
*/
|
1694
1758
|
"autoFocus"?: boolean;
|
1695
1759
|
/**
|
1696
|
-
* Define se
|
1760
|
+
* Define se os dados serão carregados automaticamente na inicialização do componente.
|
1697
1761
|
*/
|
1698
1762
|
"autoLoad"?: boolean;
|
1699
1763
|
/**
|
1700
|
-
* Define se a edição
|
1764
|
+
* Define se a edição de dados na grade está habilitada.
|
1701
1765
|
*/
|
1702
1766
|
"canEdit": boolean;
|
1767
|
+
/**
|
1768
|
+
* Define o data source para o filtro de colunas.
|
1769
|
+
*/
|
1703
1770
|
"columnFilterDataSource": IMultiSelectionListDataSource;
|
1704
1771
|
/**
|
1705
|
-
* Define se a grade deve ser exibida em modo compacto
|
1772
|
+
* Define se a grade deve ser exibida em modo compacto.
|
1706
1773
|
*/
|
1707
1774
|
"compact": boolean;
|
1708
1775
|
/**
|
1709
|
-
* Nome usado para salvar
|
1776
|
+
* Nome usado para salvar e recuperar a configuração da grade.
|
1710
1777
|
*/
|
1711
1778
|
"configName": string;
|
1712
1779
|
/**
|
1713
|
-
* Desabilita a apresentação da opção de filtros personalizados na
|
1780
|
+
* 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).
|
1714
1781
|
*/
|
1715
1782
|
"disablePersonalizedFilter": boolean;
|
1716
1783
|
/**
|
1717
|
-
*
|
1784
|
+
* Habilita a inserção de registros diretamente na grade.
|
1718
1785
|
*/
|
1719
1786
|
"enableGridInsert"?: boolean;
|
1720
1787
|
/**
|
1721
|
-
* Define se o componente deve usar o LockManager para controle de carregamento da aplicação
|
1788
|
+
* Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
|
1722
1789
|
*/
|
1723
1790
|
"enableLockManagerLoadingComp"?: boolean;
|
1724
1791
|
/**
|
@@ -1726,31 +1793,37 @@ export namespace Components {
|
|
1726
1793
|
*/
|
1727
1794
|
"enableLockManagerTaskbarClick"?: boolean;
|
1728
1795
|
/**
|
1729
|
-
* Chave da configuração
|
1796
|
+
* Chave da configuração legada da barra de filtros.
|
1730
1797
|
*/
|
1731
1798
|
"filterBarLegacyConfigName": string;
|
1732
1799
|
/**
|
1733
|
-
* Título que será apresentado na barra de filtros
|
1800
|
+
* Título que será apresentado na barra de filtros.
|
1734
1801
|
*/
|
1735
1802
|
"filterBarTitle": string;
|
1736
1803
|
/**
|
1737
|
-
* Retorna o elemento da
|
1804
|
+
* Retorna o elemento da barra de filtros da grade.
|
1805
|
+
* @async
|
1806
|
+
* @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.
|
1807
|
+
* @returns O elemento da barra de filtros.
|
1738
1808
|
*/
|
1739
1809
|
"getFilterBar": () => Promise<HTMLSnkFilterBarElement>;
|
1740
1810
|
/**
|
1741
|
-
*
|
1811
|
+
* Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade.
|
1742
1812
|
*/
|
1743
1813
|
"gridHeaderCustomSlotId": string;
|
1744
1814
|
/**
|
1745
|
-
* Chave da configuração
|
1815
|
+
* Chave da configuração legada da grade.
|
1746
1816
|
*/
|
1747
1817
|
"gridLegacyConfigName": string;
|
1748
1818
|
/**
|
1749
1819
|
* Fecha a janela de configurações da grade.
|
1820
|
+
* @async
|
1821
|
+
* @description Este método fecha o pop-up de configuração de colunas da grade.
|
1822
|
+
* @returns Uma promessa que é resolvida quando a janela de configuração é fechada.
|
1750
1823
|
*/
|
1751
1824
|
"hideConfig": () => Promise<void>;
|
1752
1825
|
/**
|
1753
|
-
* Determina se a grade está vinculada a um detalhe.
|
1826
|
+
* Determina se a grade está vinculada a um detalhe de outra tela.
|
1754
1827
|
*/
|
1755
1828
|
"isDetail": boolean;
|
1756
1829
|
/**
|
@@ -1758,92 +1831,114 @@ export namespace Components {
|
|
1758
1831
|
*/
|
1759
1832
|
"messagesBuilder": SnkMessageBuilder;
|
1760
1833
|
/**
|
1761
|
-
* Habilita a edição de múltiplos registros
|
1834
|
+
* Habilita a edição de múltiplos registros simultaneamente.
|
1762
1835
|
*/
|
1763
1836
|
"multipleEditionEnabled": boolean;
|
1764
1837
|
/**
|
1765
|
-
* Determina se
|
1838
|
+
* Determina se a seleção de múltiplas linhas é permitida.
|
1766
1839
|
*/
|
1767
1840
|
"multipleSelection": boolean;
|
1768
1841
|
/**
|
1769
|
-
* Altera
|
1842
|
+
* 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).
|
1770
1843
|
*/
|
1771
1844
|
"outlineMode"?: boolean;
|
1772
1845
|
/**
|
1773
|
-
* Define
|
1846
|
+
* Define o modo de exibição do contador de paginação.
|
1774
1847
|
*/
|
1775
1848
|
"paginationCounterMode"?: 'show' | 'hidden' | 'auto';
|
1776
1849
|
/**
|
1777
|
-
* Altera o modo de apresentação dos botões do snk-taskbar
|
1850
|
+
* Altera o modo de apresentação dos botões do `snk-taskbar`.
|
1778
1851
|
*/
|
1779
1852
|
"presentationMode": PresentationMode1;
|
1780
1853
|
/**
|
1781
|
-
* Validador responsável por
|
1854
|
+
* Validador responsável por verificar a integridade dos dados de um registro.
|
1782
1855
|
*/
|
1783
1856
|
"recordsValidator": IRecordValidator;
|
1857
|
+
/**
|
1858
|
+
* Recarrega a configuração da grade.
|
1859
|
+
* @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.
|
1860
|
+
*/
|
1784
1861
|
"reloadConfig": () => Promise<void>;
|
1785
1862
|
/**
|
1786
|
-
*
|
1863
|
+
* Recarrega a barra de filtros da grade, buscando o estado do servidor.
|
1864
|
+
* @async
|
1865
|
+
* @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
|
1866
|
+
* @returns Uma promessa que é resolvida quando a barra de filtros é recarregada.
|
1787
1867
|
*/
|
1788
1868
|
"reloadFilterBar": () => Promise<void>;
|
1789
1869
|
/**
|
1790
|
-
* Remove
|
1870
|
+
* Remove um formatador de valor customizado de uma coluna da grade.
|
1871
|
+
* @async
|
1872
|
+
* @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
|
1873
|
+
* @param columnName O nome da coluna da qual o formatador será removido.
|
1874
|
+
* @returns Uma promessa que é resolvida quando o formatador é removido.
|
1791
1875
|
*/
|
1792
1876
|
"removeCustomValueFormatter": (columnName: string) => Promise<void>;
|
1793
1877
|
/**
|
1794
|
-
* Identificador de recursos como configurações e acesso.
|
1878
|
+
* Identificador de recursos, como configurações e permissões de acesso.
|
1795
1879
|
*/
|
1796
1880
|
"resourceID": string;
|
1797
1881
|
/**
|
1798
|
-
* Configuração
|
1882
|
+
* Configuração do toast de seleção da grade.
|
1799
1883
|
*/
|
1800
1884
|
"selectionToastConfig": ISelectionToastConfig;
|
1801
1885
|
/**
|
1802
|
-
*
|
1886
|
+
* Define a configuração da grade.
|
1887
|
+
* @async
|
1888
|
+
* @description Aplica uma nova configuração de colunas e ordenação à grade.
|
1889
|
+
* @param config O objeto de configuração a ser aplicado na grade.
|
1890
|
+
* @returns Uma promessa que é resolvida quando a configuração é aplicada.
|
1803
1891
|
*/
|
1804
1892
|
"setConfig": (config: IGridConfig) => Promise<void>;
|
1805
1893
|
/**
|
1806
1894
|
* Atribui o foco para a grade.
|
1895
|
+
* @async
|
1896
|
+
* @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
|
1897
|
+
* @returns Uma promessa que é resolvida quando o foco é atribuído.
|
1807
1898
|
*/
|
1808
1899
|
"setFocus": () => Promise<void>;
|
1809
1900
|
/**
|
1810
1901
|
* Exibe a janela de configurações da grade.
|
1902
|
+
* @async
|
1903
|
+
* @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.
|
1904
|
+
* @returns Uma promessa que é resolvida quando a janela de configuração é exibida.
|
1811
1905
|
*/
|
1812
1906
|
"showConfig": () => Promise<void>;
|
1813
1907
|
/**
|
1814
|
-
*
|
1908
|
+
* Define a configuração de cores para a coluna de status.
|
1909
|
+
* @example ```json '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' ```
|
1815
1910
|
*/
|
1816
1911
|
"statusResolver": IStatusResolver | StatusResolverFunction;
|
1817
1912
|
/**
|
1818
|
-
*
|
1913
|
+
* Define o modo de exportação dos dados.
|
1819
1914
|
*/
|
1820
1915
|
"strategyExporter": IExporterStrategyMode;
|
1821
1916
|
/**
|
1822
|
-
* Informa se a coluna de
|
1917
|
+
* Informa se a coluna de checkbox deve ser suprimida.
|
1823
1918
|
*/
|
1824
1919
|
"suppressCheckboxColumn": boolean;
|
1825
1920
|
/**
|
1826
|
-
* Define se a grade deve suprimir
|
1921
|
+
* Define se a grade deve suprimir a barra de rolagem horizontal.
|
1827
1922
|
*/
|
1828
1923
|
"suppressHorizontalScroll": boolean;
|
1829
1924
|
/**
|
1830
|
-
* Define o identificador do
|
1925
|
+
* Define o identificador do contêiner de elementos customizados da `Taskbar`.
|
1831
1926
|
*/
|
1832
1927
|
"taskbarCustomContainerId": string;
|
1833
1928
|
/**
|
1834
|
-
* Gerenciador das barras de tarefas.
|
1929
|
+
* Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões.
|
1835
1930
|
*/
|
1836
1931
|
"taskbarManager": TaskbarManager;
|
1837
1932
|
/**
|
1838
|
-
*
|
1933
|
+
* Define o nome do slot para elementos customizados na `Taskbar` principal do componente.
|
1839
1934
|
*/
|
1840
1935
|
"topTaskbarCustomSlotId": string;
|
1841
1936
|
/**
|
1842
|
-
* Quando
|
1937
|
+
* Quando `true`, a tecla ENTER navega entre as células como a tecla TAB.
|
1843
1938
|
*/
|
1844
1939
|
"useEnterLikeTab": boolean;
|
1845
1940
|
/**
|
1846
|
-
* Define se a grade deve exibir um buscador de
|
1941
|
+
* Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`.
|
1847
1942
|
*/
|
1848
1943
|
"useSearchColumn": boolean;
|
1849
1944
|
}
|
@@ -3416,78 +3511,112 @@ declare namespace LocalJSX {
|
|
3416
3511
|
interface SnkDataUnit {
|
3417
3512
|
/**
|
3418
3513
|
* Executado após a ação de salvar.
|
3514
|
+
* @param dataUnit - A instância do DataUnit.
|
3515
|
+
* @returns
|
3419
3516
|
*/
|
3420
3517
|
"afterSave"?: (dataUnit: DataUnit) => void;
|
3421
3518
|
/**
|
3422
3519
|
* 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.
|
3520
|
+
* @param dataUnit - A instância do DataUnit.
|
3521
|
+
* @returns `false` para cancelar a ação, `true` para continuar.
|
3423
3522
|
*/
|
3424
3523
|
"beforeSave"?: (dataUnit: DataUnit) => boolean | Promise<boolean>;
|
3425
3524
|
/**
|
3426
3525
|
* Usado para obter configuração de metadados.
|
3526
|
+
* @type {string}
|
3427
3527
|
*/
|
3428
3528
|
"configName"?: string;
|
3429
3529
|
/**
|
3430
3530
|
* Controla o estado atual dos dados.
|
3531
|
+
* @type {DataState}
|
3431
3532
|
*/
|
3432
3533
|
"dataState"?: DataState;
|
3433
3534
|
/**
|
3434
3535
|
* Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
|
3536
|
+
* @type {DataUnit}
|
3435
3537
|
*/
|
3436
3538
|
"dataUnit"?: DataUnit;
|
3437
3539
|
/**
|
3438
3540
|
* Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade.
|
3541
|
+
* @type {string}
|
3439
3542
|
*/
|
3440
3543
|
"dataUnitName"?: string;
|
3441
3544
|
/**
|
3442
3545
|
* Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
|
3546
|
+
* @type {string}
|
3443
3547
|
*/
|
3444
3548
|
"domainMessagesBuilder"?: string;
|
3445
3549
|
/**
|
3446
3550
|
* Determina qual a entidade que representa os dados em questão.
|
3551
|
+
* @type {string}
|
3447
3552
|
*/
|
3448
3553
|
"entityName"?: string;
|
3449
3554
|
/**
|
3450
3555
|
* Responsável por evitar a mensagem de sucesso ao salvar.
|
3556
|
+
* @type {boolean}
|
3451
3557
|
*/
|
3452
3558
|
"ignoreSaveMessage"?: boolean;
|
3453
3559
|
/**
|
3454
3560
|
* Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
3561
|
+
* @type {SnkMessageBuilder}
|
3455
3562
|
*/
|
3456
3563
|
"messagesBuilder"?: SnkMessageBuilder;
|
3457
3564
|
/**
|
3458
3565
|
* Emitido quando se cancela uma inserção ou cópia.
|
3566
|
+
* @event cancelEdition
|
3567
|
+
* @type {CustomEvent<void>}
|
3568
|
+
* @bubbles false
|
3459
3569
|
*/
|
3460
3570
|
"onCancelEdition"?: (event: SnkDataUnitCustomEvent<void>) => void;
|
3461
3571
|
/**
|
3462
3572
|
* Emitido quando há qualquer mudança de estado no DataUnit.
|
3573
|
+
* @event dataStateChange
|
3574
|
+
* @type {CustomEvent<DataState>}
|
3575
|
+
* @bubbles false
|
3463
3576
|
*/
|
3464
3577
|
"onDataStateChange"?: (event: SnkDataUnitCustomEvent<DataState>) => void;
|
3465
3578
|
/**
|
3466
3579
|
* Emitido quando há campos no DataUnit que devem ser ocultados.
|
3580
|
+
* @event dataUnitFieldsHidded
|
3581
|
+
* @type {CustomEvent<void>}
|
3467
3582
|
*/
|
3468
3583
|
"onDataUnitFieldsHidded"?: (event: SnkDataUnitCustomEvent<void>) => void;
|
3469
3584
|
/**
|
3470
3585
|
* Emitido quando o DataUnit está pronto.
|
3586
|
+
* @event dataUnitReady
|
3587
|
+
* @type {CustomEvent<DataUnit>}
|
3588
|
+
* @bubbles false
|
3471
3589
|
*/
|
3472
3590
|
"onDataUnitReady"?: (event: SnkDataUnitCustomEvent<DataUnit>) => void;
|
3473
3591
|
/**
|
3474
3592
|
* Emitido quando um registro é adicionado ou copiado.
|
3593
|
+
* @event insertionMode
|
3594
|
+
* @type {CustomEvent<void>}
|
3595
|
+
* @bubbles false
|
3475
3596
|
*/
|
3476
3597
|
"onInsertionMode"?: (event: SnkDataUnitCustomEvent<void>) => void;
|
3477
3598
|
/**
|
3478
|
-
* Emitido quando o
|
3599
|
+
* Emitido quando o messagesBuilder é atualizado.
|
3600
|
+
* @event messagesBuilderUpdated
|
3601
|
+
* @type {CustomEvent<SnkMessageBuilder>}
|
3602
|
+
* @bubbles false
|
3479
3603
|
*/
|
3480
3604
|
"onMessagesBuilderUpdated"?: (event: SnkDataUnitCustomEvent<SnkMessageBuilder>) => void;
|
3481
3605
|
/**
|
3482
3606
|
* Determina quantas linhas são retornadas por página.
|
3607
|
+
* @type {number}
|
3608
|
+
* @default 150
|
3483
3609
|
*/
|
3484
3610
|
"pageSize"?: number;
|
3485
3611
|
/**
|
3486
3612
|
* Identificador de recursos como configurações e acesso.
|
3613
|
+
* @type {string}
|
3487
3614
|
*/
|
3488
3615
|
"resourceID"?: string;
|
3489
3616
|
/**
|
3490
3617
|
* Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição.
|
3618
|
+
* @type {boolean}
|
3619
|
+
* @default true
|
3491
3620
|
*/
|
3492
3621
|
"useCancelConfirm"?: boolean;
|
3493
3622
|
}
|
@@ -4038,7 +4167,7 @@ declare namespace LocalJSX {
|
|
4038
4167
|
*/
|
4039
4168
|
"configName"?: string;
|
4040
4169
|
/**
|
4041
|
-
* Chave da configuração
|
4170
|
+
* Chave da configuração legada do formulário.
|
4042
4171
|
*/
|
4043
4172
|
"formLegacyConfigName"?: string;
|
4044
4173
|
/**
|
@@ -4046,15 +4175,15 @@ declare namespace LocalJSX {
|
|
4046
4175
|
*/
|
4047
4176
|
"messagesBuilder"?: SnkMessageBuilder;
|
4048
4177
|
/**
|
4049
|
-
*
|
4178
|
+
* @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
|
4050
4179
|
*/
|
4051
4180
|
"onActionClick"?: (event: SnkFormCustomEvent<string>) => void;
|
4052
4181
|
/**
|
4053
|
-
*
|
4182
|
+
* @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
|
4054
4183
|
*/
|
4055
4184
|
"onExit"?: (event: SnkFormCustomEvent<void>) => void;
|
4056
4185
|
/**
|
4057
|
-
* Responsável por notificar quando ocorrer a renderização de itens do formulário.
|
4186
|
+
* Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view
|
4058
4187
|
*/
|
4059
4188
|
"onFormItemsReady"?: (event: SnkFormCustomEvent<Array<HTMLElement>>) => void;
|
4060
4189
|
/**
|
@@ -4183,40 +4312,43 @@ declare namespace LocalJSX {
|
|
4183
4312
|
}
|
4184
4313
|
interface SnkGrid {
|
4185
4314
|
/**
|
4186
|
-
* Lista de ações que devem ser usadas no botão "Mais opções" do
|
4315
|
+
* Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`.
|
4187
4316
|
*/
|
4188
4317
|
"actionsList"?: Array<Action>;
|
4189
4318
|
/**
|
4190
|
-
* Define se a
|
4319
|
+
* Define se a grade receberá o foco automaticamente ao ser carregada.
|
4191
4320
|
*/
|
4192
4321
|
"autoFocus"?: boolean;
|
4193
4322
|
/**
|
4194
|
-
* Define se
|
4323
|
+
* Define se os dados serão carregados automaticamente na inicialização do componente.
|
4195
4324
|
*/
|
4196
4325
|
"autoLoad"?: boolean;
|
4197
4326
|
/**
|
4198
|
-
* Define se a edição
|
4327
|
+
* Define se a edição de dados na grade está habilitada.
|
4199
4328
|
*/
|
4200
4329
|
"canEdit"?: boolean;
|
4330
|
+
/**
|
4331
|
+
* Define o data source para o filtro de colunas.
|
4332
|
+
*/
|
4201
4333
|
"columnFilterDataSource"?: IMultiSelectionListDataSource;
|
4202
4334
|
/**
|
4203
|
-
* Define se a grade deve ser exibida em modo compacto
|
4335
|
+
* Define se a grade deve ser exibida em modo compacto.
|
4204
4336
|
*/
|
4205
4337
|
"compact"?: boolean;
|
4206
4338
|
/**
|
4207
|
-
* Nome usado para salvar
|
4339
|
+
* Nome usado para salvar e recuperar a configuração da grade.
|
4208
4340
|
*/
|
4209
4341
|
"configName"?: string;
|
4210
4342
|
/**
|
4211
|
-
* Desabilita a apresentação da opção de filtros personalizados na
|
4343
|
+
* 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).
|
4212
4344
|
*/
|
4213
4345
|
"disablePersonalizedFilter"?: boolean;
|
4214
4346
|
/**
|
4215
|
-
*
|
4347
|
+
* Habilita a inserção de registros diretamente na grade.
|
4216
4348
|
*/
|
4217
4349
|
"enableGridInsert"?: boolean;
|
4218
4350
|
/**
|
4219
|
-
* Define se o componente deve usar o LockManager para controle de carregamento da aplicação
|
4351
|
+
* Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
|
4220
4352
|
*/
|
4221
4353
|
"enableLockManagerLoadingComp"?: boolean;
|
4222
4354
|
/**
|
@@ -4224,23 +4356,23 @@ declare namespace LocalJSX {
|
|
4224
4356
|
*/
|
4225
4357
|
"enableLockManagerTaskbarClick"?: boolean;
|
4226
4358
|
/**
|
4227
|
-
* Chave da configuração
|
4359
|
+
* Chave da configuração legada da barra de filtros.
|
4228
4360
|
*/
|
4229
4361
|
"filterBarLegacyConfigName"?: string;
|
4230
4362
|
/**
|
4231
|
-
* Título que será apresentado na barra de filtros
|
4363
|
+
* Título que será apresentado na barra de filtros.
|
4232
4364
|
*/
|
4233
4365
|
"filterBarTitle"?: string;
|
4234
4366
|
/**
|
4235
|
-
*
|
4367
|
+
* Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade.
|
4236
4368
|
*/
|
4237
4369
|
"gridHeaderCustomSlotId"?: string;
|
4238
4370
|
/**
|
4239
|
-
* Chave da configuração
|
4371
|
+
* Chave da configuração legada da grade.
|
4240
4372
|
*/
|
4241
4373
|
"gridLegacyConfigName"?: string;
|
4242
4374
|
/**
|
4243
|
-
* Determina se a grade está vinculada a um detalhe.
|
4375
|
+
* Determina se a grade está vinculada a um detalhe de outra tela.
|
4244
4376
|
*/
|
4245
4377
|
"isDetail"?: boolean;
|
4246
4378
|
/**
|
@@ -4248,83 +4380,88 @@ declare namespace LocalJSX {
|
|
4248
4380
|
*/
|
4249
4381
|
"messagesBuilder"?: SnkMessageBuilder;
|
4250
4382
|
/**
|
4251
|
-
* Habilita a edição de múltiplos registros
|
4383
|
+
* Habilita a edição de múltiplos registros simultaneamente.
|
4252
4384
|
*/
|
4253
4385
|
"multipleEditionEnabled"?: boolean;
|
4254
4386
|
/**
|
4255
|
-
* Determina se
|
4387
|
+
* Determina se a seleção de múltiplas linhas é permitida.
|
4256
4388
|
*/
|
4257
4389
|
"multipleSelection"?: boolean;
|
4258
4390
|
/**
|
4259
|
-
* Emitido
|
4391
|
+
* Emitido ao clicar em um botão de ação ou item de menu.
|
4392
|
+
* @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.
|
4393
|
+
* @param detail - O identificador da ação clicada, que pode ser usado para determinar qual ação executar.
|
4260
4394
|
*/
|
4261
4395
|
"onActionClick"?: (event: SnkGridCustomEvent<string>) => void;
|
4262
4396
|
/**
|
4263
|
-
*
|
4397
|
+
* @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
|
4264
4398
|
*/
|
4265
4399
|
"onComponentReady"?: (event: SnkGridCustomEvent<void>) => void;
|
4266
4400
|
/**
|
4267
|
-
* Emitido
|
4401
|
+
* Emitido ao realizar um duplo clique em uma linha da grade.
|
4402
|
+
* @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.
|
4403
|
+
* @param detail - Detalhes do evento, contendo a linha clicada.
|
4268
4404
|
*/
|
4269
4405
|
"onGridDoubleClick"?: (event: SnkGridCustomEvent<any>) => void;
|
4270
4406
|
/**
|
4271
|
-
* Altera
|
4407
|
+
* 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).
|
4272
4408
|
*/
|
4273
4409
|
"outlineMode"?: boolean;
|
4274
4410
|
/**
|
4275
|
-
* Define
|
4411
|
+
* Define o modo de exibição do contador de paginação.
|
4276
4412
|
*/
|
4277
4413
|
"paginationCounterMode"?: 'show' | 'hidden' | 'auto';
|
4278
4414
|
/**
|
4279
|
-
* Altera o modo de apresentação dos botões do snk-taskbar
|
4415
|
+
* Altera o modo de apresentação dos botões do `snk-taskbar`.
|
4280
4416
|
*/
|
4281
4417
|
"presentationMode"?: PresentationMode1;
|
4282
4418
|
/**
|
4283
|
-
* Validador responsável por
|
4419
|
+
* Validador responsável por verificar a integridade dos dados de um registro.
|
4284
4420
|
*/
|
4285
4421
|
"recordsValidator"?: IRecordValidator;
|
4286
4422
|
/**
|
4287
|
-
* Identificador de recursos como configurações e acesso.
|
4423
|
+
* Identificador de recursos, como configurações e permissões de acesso.
|
4288
4424
|
*/
|
4289
4425
|
"resourceID"?: string;
|
4290
4426
|
/**
|
4291
|
-
* Configuração
|
4427
|
+
* Configuração do toast de seleção da grade.
|
4292
4428
|
*/
|
4293
4429
|
"selectionToastConfig"?: ISelectionToastConfig;
|
4294
4430
|
/**
|
4295
|
-
*
|
4431
|
+
* Define a configuração de cores para a coluna de status.
|
4432
|
+
* @example ```json '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' ```
|
4296
4433
|
*/
|
4297
4434
|
"statusResolver"?: IStatusResolver | StatusResolverFunction;
|
4298
4435
|
/**
|
4299
|
-
*
|
4436
|
+
* Define o modo de exportação dos dados.
|
4300
4437
|
*/
|
4301
4438
|
"strategyExporter"?: IExporterStrategyMode;
|
4302
4439
|
/**
|
4303
|
-
* Informa se a coluna de
|
4440
|
+
* Informa se a coluna de checkbox deve ser suprimida.
|
4304
4441
|
*/
|
4305
4442
|
"suppressCheckboxColumn"?: boolean;
|
4306
4443
|
/**
|
4307
|
-
* Define se a grade deve suprimir
|
4444
|
+
* Define se a grade deve suprimir a barra de rolagem horizontal.
|
4308
4445
|
*/
|
4309
4446
|
"suppressHorizontalScroll"?: boolean;
|
4310
4447
|
/**
|
4311
|
-
* Define o identificador do
|
4448
|
+
* Define o identificador do contêiner de elementos customizados da `Taskbar`.
|
4312
4449
|
*/
|
4313
4450
|
"taskbarCustomContainerId"?: string;
|
4314
4451
|
/**
|
4315
|
-
* Gerenciador das barras de tarefas.
|
4452
|
+
* Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões.
|
4316
4453
|
*/
|
4317
4454
|
"taskbarManager"?: TaskbarManager;
|
4318
4455
|
/**
|
4319
|
-
*
|
4456
|
+
* Define o nome do slot para elementos customizados na `Taskbar` principal do componente.
|
4320
4457
|
*/
|
4321
4458
|
"topTaskbarCustomSlotId"?: string;
|
4322
4459
|
/**
|
4323
|
-
* Quando
|
4460
|
+
* Quando `true`, a tecla ENTER navega entre as células como a tecla TAB.
|
4324
4461
|
*/
|
4325
4462
|
"useEnterLikeTab"?: boolean;
|
4326
4463
|
/**
|
4327
|
-
* Define se a grade deve exibir um buscador de
|
4464
|
+
* Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`.
|
4328
4465
|
*/
|
4329
4466
|
"useSearchColumn"?: boolean;
|
4330
4467
|
}
|