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