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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (236) hide show
  1. package/dist/cjs/{ConfigStorage-1931defc.js → ConfigStorage-8b6def32.js} +2 -2
  2. package/dist/cjs/{DataFetcher-ad9fb3bb.js → DataFetcher-2c37b6a1.js} +52 -1
  3. package/dist/cjs/{ISave-18ffb73e.js → ISave-b22b3cf0.js} +1 -1
  4. package/dist/cjs/{SnkFormConfigManager-65e5288e.js → SnkFormConfigManager-477a27de.js} +2 -2
  5. package/dist/cjs/{ClientSideExporterProvider-994f6e26.js → SnkMultiSelectionListDataSource-b7ab26ba.js} +82 -79
  6. package/dist/cjs/{auth-fetcher-afbe69ab.js → auth-fetcher-78a90b36.js} +1 -1
  7. package/dist/cjs/{dataunit-fetcher-c7253b02.js → dataunit-fetcher-877944a9.js} +1 -1
  8. package/dist/cjs/filter-validate-6993f6f2.js +30 -0
  9. package/dist/cjs/{form-config-fetcher-f6e66d64.js → form-config-fetcher-dee08eb4.js} +1 -1
  10. package/dist/cjs/{index-0ad2baeb.js → index-13d05f03.js} +21 -5
  11. package/dist/cjs/index-1cf293c1.js +8 -8
  12. package/dist/cjs/loader.cjs.js +1 -1
  13. package/dist/cjs/pesquisa-grid_2.cjs.entry.js +4 -4
  14. package/dist/cjs/sankhyablocks.cjs.js +1 -1
  15. package/dist/cjs/snk-actions-button_8.cjs.entry.js +5 -5
  16. package/dist/cjs/snk-application.cjs.entry.js +6 -9
  17. package/dist/cjs/snk-attach.cjs.entry.js +7 -7
  18. package/dist/cjs/snk-crud.cjs.entry.js +7 -7
  19. package/dist/cjs/snk-data-exporter.cjs.entry.js +5 -5
  20. package/dist/cjs/{snk-data-unit-448fce74.js → snk-data-unit-0cfa7622.js} +14 -4
  21. package/dist/cjs/snk-data-unit.cjs.entry.js +3 -3
  22. package/dist/cjs/snk-detail-view.cjs.entry.js +9 -9
  23. package/dist/cjs/snk-entity-list.cjs.entry.js +10 -3
  24. package/dist/cjs/snk-expression-group_2.cjs.entry.js +1 -1
  25. package/dist/cjs/snk-filter-bar_4.cjs.entry.js +189 -115
  26. package/dist/cjs/snk-filter-binary-select.cjs.entry.js +23 -2
  27. package/dist/cjs/snk-filter-checkbox-list.cjs.entry.js +20 -2
  28. package/dist/cjs/snk-filter-detail.cjs.entry.js +25 -8
  29. package/dist/cjs/snk-filter-modal-item.cjs.entry.js +9 -14
  30. package/dist/cjs/snk-filter-multi-select.cjs.entry.js +16 -3
  31. package/dist/cjs/snk-filter-number.cjs.entry.js +34 -3
  32. package/dist/cjs/snk-filter-period.cjs.entry.js +59 -14
  33. package/dist/cjs/snk-filter-search.cjs.entry.js +14 -3
  34. package/dist/cjs/snk-filter-text.cjs.entry.js +18 -1
  35. package/dist/cjs/snk-form_2.cjs.entry.js +31 -5
  36. package/dist/cjs/snk-grid.cjs.entry.js +158 -66
  37. package/dist/cjs/{snk-guides-viewer-c23ed218.js → snk-guides-viewer-38277265.js} +6 -6
  38. package/dist/cjs/snk-guides-viewer.cjs.entry.js +9 -9
  39. package/dist/cjs/snk-personalized-filter.cjs.entry.js +14 -6
  40. package/dist/cjs/snk-pesquisa.cjs.entry.js +4 -4
  41. package/dist/cjs/snk-simple-bar.cjs.entry.js +5 -5
  42. package/dist/cjs/snk-simple-crud.cjs.entry.js +60 -23
  43. package/dist/cjs/snk-taskbar.cjs.entry.js +2 -2
  44. package/dist/cjs/{taskbar-elements-3b74cd21.js → taskbar-elements-fb5d1e08.js} +1 -1
  45. package/dist/collection/components/snk-application/snk-application.js +0 -2
  46. package/dist/collection/components/snk-data-exporter/providers/ClientSideExporterProvider.js +4 -1
  47. package/dist/collection/components/snk-data-unit/snk-data-unit.js +174 -29
  48. package/dist/collection/components/snk-entity-list/snk-entity-list.js +28 -4
  49. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-binary-select.js +72 -2
  50. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-checkbox-list.js +73 -2
  51. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-multi-select.js +51 -5
  52. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-number.js +83 -3
  53. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-period.js +118 -27
  54. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-search.js +49 -5
  55. package/dist/collection/components/snk-filter-bar/filter-item/editors/snk-filter-text.js +71 -1
  56. package/dist/collection/components/snk-filter-bar/filter-item/snk-filter-detail.js +62 -11
  57. package/dist/collection/components/snk-filter-bar/filter-item/snk-filter-item.js +70 -8
  58. package/dist/collection/components/snk-filter-bar/filter-modal/snk-filter-modal.css +0 -4
  59. package/dist/collection/components/snk-filter-bar/filter-modal/snk-filter-modal.js +112 -16
  60. package/dist/collection/components/snk-filter-bar/filter-modal/subcomponents/snk-filter-modal-item.js +8 -16
  61. package/dist/collection/components/snk-filter-bar/snk-filter-bar.js +315 -114
  62. package/dist/collection/components/snk-filter-bar/utils/SnkFilterModalFactory.js +3 -1
  63. package/dist/collection/components/snk-filter-bar/utils/filter-validate.js +24 -0
  64. package/dist/collection/components/snk-form/snk-form.js +133 -22
  65. package/dist/collection/components/snk-grid/snk-grid.js +488 -133
  66. package/dist/collection/components/snk-personalized-filter/snk-personalized-filter.js +83 -21
  67. package/dist/collection/components/snk-pesquisa/snk-pesquisa.js +80 -14
  68. package/dist/collection/components/snk-simple-bar/snk-simple-bar.js +9 -9
  69. package/dist/collection/components/snk-simple-crud/snk-simple-crud.js +414 -119
  70. package/dist/collection/components/snk-taskbar/snk-taskbar.js +102 -36
  71. package/dist/collection/lib/http/data-fetcher/DataFetcher.js +1 -0
  72. package/dist/collection/lib/http/data-fetcher/custom-xhr-override.js +39 -0
  73. package/dist/collection/lib/message/resources/en-us/snk-filter-bar.msg.js +1 -0
  74. package/dist/collection/lib/message/resources/en-us/snk-grid.msg.js +4 -0
  75. package/dist/collection/lib/message/resources/es-es/snk-filter-bar.msg.js +1 -0
  76. package/dist/collection/lib/message/resources/es-es/snk-grid.msg.js +4 -0
  77. package/dist/collection/lib/message/resources/pt-br/snk-filter-bar.msg.js +1 -0
  78. package/dist/collection/lib/message/resources/pt-br/snk-grid.msg.js +4 -0
  79. package/dist/components/ContinuousInsertUtils.js +4 -1
  80. package/dist/components/DataFetcher.js +52 -1
  81. package/dist/components/index2.js +21 -5
  82. package/dist/components/snk-application2.js +0 -3
  83. package/dist/components/snk-crud.js +62 -44
  84. package/dist/components/snk-data-unit2.js +12 -2
  85. package/dist/components/snk-detail-view2.js +89 -56
  86. package/dist/components/snk-entity-list.js +11 -3
  87. package/dist/components/snk-filter-bar2.js +103 -108
  88. package/dist/components/snk-filter-binary-select.js +27 -3
  89. package/dist/components/snk-filter-checkbox-list.js +24 -3
  90. package/dist/components/snk-filter-detail2.js +28 -9
  91. package/dist/components/snk-filter-item2.js +70 -8
  92. package/dist/components/snk-filter-modal-item2.js +7 -12
  93. package/dist/components/snk-filter-modal.js +1 -325
  94. package/dist/components/snk-filter-modal2.js +391 -0
  95. package/dist/components/snk-filter-multi-select.js +19 -4
  96. package/dist/components/snk-filter-number.js +38 -4
  97. package/dist/components/snk-filter-period.js +64 -16
  98. package/dist/components/snk-filter-search.js +17 -4
  99. package/dist/components/snk-filter-text.js +22 -2
  100. package/dist/components/snk-form.js +29 -2
  101. package/dist/components/snk-grid2.js +188 -75
  102. package/dist/components/snk-personalized-filter2.js +10 -2
  103. package/dist/components/snk-simple-bar2.js +5 -5
  104. package/dist/components/snk-simple-crud2.js +45 -8
  105. package/dist/esm/{ConfigStorage-b5a1dba3.js → ConfigStorage-22eace3a.js} +2 -2
  106. package/dist/esm/{DataFetcher-6f6de657.js → DataFetcher-f6b2961a.js} +52 -1
  107. package/dist/esm/{ISave-7ecdca20.js → ISave-6b7b0423.js} +1 -1
  108. package/dist/esm/{SnkFormConfigManager-34fc1dc7.js → SnkFormConfigManager-968b97e7.js} +2 -2
  109. package/dist/esm/{ClientSideExporterProvider-7c2781f4.js → SnkMultiSelectionListDataSource-1136c4e7.js} +87 -84
  110. package/dist/esm/{auth-fetcher-7332a9a9.js → auth-fetcher-cf39e42b.js} +1 -1
  111. package/dist/esm/{dataunit-fetcher-f21cbad0.js → dataunit-fetcher-6314b19d.js} +1 -1
  112. package/dist/esm/filter-validate-d765d450.js +27 -0
  113. package/dist/esm/{form-config-fetcher-6ab4e805.js → form-config-fetcher-bc6f0f1f.js} +1 -1
  114. package/dist/esm/{index-b72af127.js → index-446f9341.js} +21 -5
  115. package/dist/esm/index-479e1293.js +8 -8
  116. package/dist/esm/loader.js +1 -1
  117. package/dist/esm/pesquisa-grid_2.entry.js +4 -4
  118. package/dist/esm/sankhyablocks.js +1 -1
  119. package/dist/esm/snk-actions-button_8.entry.js +5 -5
  120. package/dist/esm/snk-application.entry.js +6 -9
  121. package/dist/esm/snk-attach.entry.js +7 -7
  122. package/dist/esm/snk-crud.entry.js +7 -7
  123. package/dist/esm/snk-data-exporter.entry.js +5 -5
  124. package/dist/esm/{snk-data-unit-b7e6e7a6.js → snk-data-unit-4acf4781.js} +14 -4
  125. package/dist/esm/snk-data-unit.entry.js +3 -3
  126. package/dist/esm/snk-detail-view.entry.js +9 -9
  127. package/dist/esm/snk-entity-list.entry.js +10 -3
  128. package/dist/esm/snk-expression-group_2.entry.js +1 -1
  129. package/dist/esm/snk-filter-bar_4.entry.js +190 -116
  130. package/dist/esm/snk-filter-binary-select.entry.js +23 -2
  131. package/dist/esm/snk-filter-checkbox-list.entry.js +20 -2
  132. package/dist/esm/snk-filter-detail.entry.js +25 -8
  133. package/dist/esm/snk-filter-modal-item.entry.js +9 -14
  134. package/dist/esm/snk-filter-multi-select.entry.js +16 -3
  135. package/dist/esm/snk-filter-number.entry.js +34 -3
  136. package/dist/esm/snk-filter-period.entry.js +59 -14
  137. package/dist/esm/snk-filter-search.entry.js +14 -3
  138. package/dist/esm/snk-filter-text.entry.js +18 -1
  139. package/dist/esm/snk-form_2.entry.js +31 -5
  140. package/dist/esm/snk-grid.entry.js +152 -60
  141. package/dist/esm/{snk-guides-viewer-fbfece85.js → snk-guides-viewer-19cb7f1f.js} +6 -6
  142. package/dist/esm/snk-guides-viewer.entry.js +9 -9
  143. package/dist/esm/snk-personalized-filter.entry.js +14 -6
  144. package/dist/esm/snk-pesquisa.entry.js +4 -4
  145. package/dist/esm/snk-simple-bar.entry.js +5 -5
  146. package/dist/esm/snk-simple-crud.entry.js +55 -18
  147. package/dist/esm/snk-taskbar.entry.js +2 -2
  148. package/dist/esm/{taskbar-elements-171476d4.js → taskbar-elements-faaf5d8f.js} +1 -1
  149. package/dist/sankhyablocks/p-093f58fa.entry.js +1 -0
  150. package/dist/sankhyablocks/{p-0e495575.js → p-0a317e81.js} +1 -1
  151. package/dist/sankhyablocks/{p-ad2ae575.entry.js → p-0e1f0344.entry.js} +1 -1
  152. package/dist/sankhyablocks/{p-8d1508aa.entry.js → p-16c1c209.entry.js} +1 -1
  153. package/dist/sankhyablocks/p-29cacaf3.entry.js +1 -0
  154. package/dist/sankhyablocks/{p-eb0616d3.entry.js → p-32450ea2.entry.js} +1 -1
  155. package/dist/sankhyablocks/{p-b49281be.entry.js → p-3c29939c.entry.js} +1 -1
  156. package/dist/sankhyablocks/p-3ed04f0d.entry.js +1 -0
  157. package/dist/sankhyablocks/{p-4872dc3a.entry.js → p-44c5ec49.entry.js} +1 -1
  158. package/dist/sankhyablocks/p-49ddc27a.entry.js +1 -0
  159. package/dist/sankhyablocks/p-4c763b10.entry.js +1 -0
  160. package/dist/sankhyablocks/p-4eeb06fc.js +1 -0
  161. package/dist/sankhyablocks/p-505172c8.entry.js +1 -0
  162. package/dist/sankhyablocks/p-55798617.js +1 -0
  163. package/dist/sankhyablocks/p-658f67a5.js +1 -0
  164. package/dist/sankhyablocks/{p-158adf33.entry.js → p-701b024c.entry.js} +1 -1
  165. package/dist/sankhyablocks/p-72a9285d.entry.js +1 -0
  166. package/dist/sankhyablocks/p-7f7fe6c4.entry.js +1 -0
  167. package/dist/sankhyablocks/p-88b7bc09.js +1 -0
  168. package/dist/sankhyablocks/{p-c6331595.js → p-8d256def.js} +1 -1
  169. package/dist/sankhyablocks/p-8f37b75b.entry.js +1 -0
  170. package/dist/sankhyablocks/{p-b35574b5.js → p-9062d640.js} +1 -1
  171. package/dist/sankhyablocks/{p-72c8c847.entry.js → p-95c71f5e.entry.js} +1 -1
  172. package/dist/sankhyablocks/p-96d45943.entry.js +1 -0
  173. package/dist/sankhyablocks/{p-eacff4b7.entry.js → p-b2d7f4cd.entry.js} +1 -1
  174. package/dist/sankhyablocks/{p-6a015ba2.js → p-b7f5caf6.js} +1 -1
  175. package/dist/sankhyablocks/p-b9200e77.entry.js +11 -0
  176. package/dist/sankhyablocks/{p-7de79adf.js → p-b987e15d.js} +1 -1
  177. package/dist/sankhyablocks/{p-ba4979b4.js → p-bf017a1f.js} +1 -1
  178. package/dist/sankhyablocks/{p-735a1175.entry.js → p-c3dbf441.entry.js} +1 -1
  179. package/dist/sankhyablocks/{p-3dba3468.js → p-c71dcb2d.js} +1 -1
  180. package/dist/sankhyablocks/{p-5e282b33.entry.js → p-c95f20d9.entry.js} +1 -1
  181. package/dist/sankhyablocks/p-c98e2085.js +1 -0
  182. package/dist/sankhyablocks/p-cb4343c4.entry.js +1 -0
  183. package/dist/sankhyablocks/p-d03ae54e.entry.js +1 -0
  184. package/dist/sankhyablocks/p-d235314c.entry.js +1 -0
  185. package/dist/sankhyablocks/p-d75a732c.js +1 -0
  186. package/dist/sankhyablocks/{p-f39b0ebe.entry.js → p-df7979fd.entry.js} +1 -1
  187. package/dist/sankhyablocks/p-e258de96.entry.js +1 -0
  188. package/dist/sankhyablocks/{p-d377aa7a.entry.js → p-f8e87cf1.entry.js} +1 -1
  189. package/dist/sankhyablocks/sankhyablocks.esm.js +1 -1
  190. package/dist/types/components/snk-data-unit/snk-data-unit.d.ts +46 -3
  191. package/dist/types/components/snk-entity-list/snk-entity-list.d.ts +8 -4
  192. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-binary-select.d.ts +12 -0
  193. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-checkbox-list.d.ts +12 -0
  194. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-multi-select.d.ts +12 -4
  195. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-number.d.ts +16 -4
  196. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-period.d.ts +17 -3
  197. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-search.d.ts +10 -2
  198. package/dist/types/components/snk-filter-bar/filter-item/editors/snk-filter-text.d.ts +12 -0
  199. package/dist/types/components/snk-filter-bar/filter-item/snk-filter-detail.d.ts +8 -3
  200. package/dist/types/components/snk-filter-bar/filter-item/snk-filter-item.d.ts +27 -4
  201. package/dist/types/components/snk-filter-bar/filter-modal/snk-filter-modal.d.ts +17 -3
  202. package/dist/types/components/snk-filter-bar/filter-modal/subcomponents/snk-filter-modal-item.d.ts +2 -3
  203. package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts +60 -30
  204. package/dist/types/components/snk-filter-bar/utils/SnkFilterModalFactory.d.ts +4 -2
  205. package/dist/types/components/snk-filter-bar/utils/filter-validate.d.ts +11 -0
  206. package/dist/types/components/snk-form/snk-form.d.ts +29 -4
  207. package/dist/types/components/snk-grid/snk-grid.d.ts +132 -58
  208. package/dist/types/components/snk-personalized-filter/snk-personalized-filter.d.ts +53 -5
  209. package/dist/types/components/snk-pesquisa/snk-pesquisa.d.ts +44 -6
  210. package/dist/types/components/snk-simple-bar/snk-simple-bar.d.ts +15 -15
  211. package/dist/types/components/snk-simple-crud/snk-simple-crud.d.ts +100 -43
  212. package/dist/types/components/snk-taskbar/snk-taskbar.d.ts +23 -21
  213. package/dist/types/components.d.ts +771 -255
  214. package/dist/types/lib/http/data-fetcher/DataFetcher.d.ts +1 -0
  215. package/package.json +4 -3
  216. package/dist/collection/lib/licenses/sankhyalicense.module.js +0 -1
  217. package/dist/sankhyablocks/p-012208e0.entry.js +0 -1
  218. package/dist/sankhyablocks/p-07b14811.entry.js +0 -1
  219. package/dist/sankhyablocks/p-0dac8fef.js +0 -1
  220. package/dist/sankhyablocks/p-1210500e.js +0 -1
  221. package/dist/sankhyablocks/p-16fc4acd.js +0 -1
  222. package/dist/sankhyablocks/p-25209340.entry.js +0 -1
  223. package/dist/sankhyablocks/p-295b83ae.entry.js +0 -1
  224. package/dist/sankhyablocks/p-398cdd67.entry.js +0 -1
  225. package/dist/sankhyablocks/p-4e63ffed.entry.js +0 -1
  226. package/dist/sankhyablocks/p-5bab470d.entry.js +0 -1
  227. package/dist/sankhyablocks/p-5c7af8a9.entry.js +0 -1
  228. package/dist/sankhyablocks/p-81769310.entry.js +0 -11
  229. package/dist/sankhyablocks/p-9fd87bfd.entry.js +0 -1
  230. package/dist/sankhyablocks/p-a349689a.js +0 -1
  231. package/dist/sankhyablocks/p-a76e6d51.entry.js +0 -1
  232. package/dist/sankhyablocks/p-a86eee47.entry.js +0 -1
  233. package/dist/sankhyablocks/p-c6a8a8bc.entry.js +0 -1
  234. package/dist/sankhyablocks/p-c9e6d720.js +0 -1
  235. package/dist/sankhyablocks/p-dff65083.entry.js +0 -1
  236. package/dist/sankhyablocks/p-fa18530e.entry.js +0 -1
@@ -52,12 +52,13 @@ import { IExportConfig } from "./components/snk-data-exporter/data/export-config
52
52
  import { IExpressionGroup, IExpressionItem } from "./components/snk-personalized-filter/interfaces/IExpressionItem";
53
53
  import { IPersonalizedFilter } from "./components/snk-personalized-filter/interfaces/IPersonalizedFilter";
54
54
  import { SnkApplication } from "./components/snk-application/snk-application";
55
- import { SnkFilterModalFactoryParams } from "./components/snk-filter-bar/utils/SnkFilterModalFactory";
55
+ import { Filter as Filter1 } from "@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata";
56
56
  import { EPresentationMode } from "./components/snk-filter-bar/filter-item/editors/enum/presentationMode";
57
57
  import { FilterFieldsDataSource, IFilterField, IFilterLink } from "./components/snk-filter-field-search/interfaces";
58
58
  import { IEzPopoverAnchorOptions } from "@sankhyalabs/ezui/dist/types/components/ez-popover/ez-popover";
59
59
  import { SnkFilterItemConfig as SnkFilterItemConfig1 } from "./components/snk-filter-bar/filter-item/snk-filter-item";
60
60
  import { ListItem as ListItem1 } from "./components/snk-filter-bar/filter-list/snk-filter-list";
61
+ import { Period } from "./components/snk-filter-bar/filter-item/editors/snk-filter-period";
61
62
  import { IFormViewField } from "@sankhyalabs/ezui/dist/types/components/ez-form-view/interfaces/IFormViewField";
62
63
  import { FormMetadata } from "@sankhyalabs/ezui/dist/collection/utils/form";
63
64
  import { ICustomEditor as ICustomEditor1 } from "@sankhyalabs/ezui/dist/types/utils/customEditor/interfaces/ICustomEditor";
@@ -901,75 +902,102 @@ export namespace Components {
901
902
  interface SnkDataUnit {
902
903
  /**
903
904
  * Executado após a ação de salvar.
905
+ * @param dataUnit - A instância do DataUnit.
906
+ * @returns
904
907
  */
905
908
  "afterSave": (dataUnit: DataUnit) => void;
906
909
  /**
907
910
  * Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação.
911
+ * @param dataUnit - A instância do DataUnit.
912
+ * @returns `false` para cancelar a ação, `true` para continuar.
908
913
  */
909
914
  "beforeSave": (dataUnit: DataUnit) => boolean | Promise<boolean>;
910
915
  /**
911
916
  * Usado para obter configuração de metadados.
917
+ * @type {string}
912
918
  */
913
919
  "configName": string;
914
920
  /**
915
921
  * Controla o estado atual dos dados.
922
+ * @type {DataState}
916
923
  */
917
924
  "dataState": DataState;
918
925
  /**
919
926
  * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
927
+ * @type {DataUnit}
920
928
  */
921
929
  "dataUnit": DataUnit;
922
930
  /**
923
931
  * Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade.
932
+ * @type {string}
924
933
  */
925
934
  "dataUnitName": string;
926
935
  /**
927
936
  * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
937
+ * @type {string}
928
938
  */
929
939
  "domainMessagesBuilder": string;
930
940
  /**
931
941
  * Determina qual a entidade que representa os dados em questão.
942
+ * @type {string}
932
943
  */
933
944
  "entityName": string;
934
945
  /**
935
946
  * Obtém o dataUnit.
947
+ * @returns Uma promessa que resolve com a instância do DataUnit.
948
+ * @async
936
949
  */
937
950
  "getDataUnit": () => Promise<DataUnit>;
938
951
  /**
939
952
  * Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
953
+ * @returns Uma promessa que resolve com um array de nomes de campos.
954
+ * @async
940
955
  */
941
956
  "getFieldsWithRmPrecision": () => Promise<string[]>;
942
957
  /**
943
958
  * Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
959
+ * @returns Uma promessa que resolve com um array de nomes de campos.
960
+ * @async
944
961
  */
945
962
  "getFieldsWithRmp": () => Promise<string[]>;
946
963
  /**
947
964
  * Busca os metadados da linha selecionada.
965
+ * @param record - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado.
966
+ * @returns Uma promessa que resolve com os metadados da linha.
967
+ * @async
948
968
  */
949
969
  "getRowMetadata": (record?: Record | string) => Promise<RowMetadata>;
950
970
  /**
951
971
  * Método que retorna a lista de IDs dos registros selecionados.
952
- * @returns Retorna a lista de IDs dos registros selecionados.
972
+ * @returns Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
973
+ * @async
953
974
  */
954
975
  "getSelectedRecordsIDsInfo": () => Promise<Array<IRecordID>>;
955
976
  /**
956
977
  * Responsável por evitar a mensagem de sucesso ao salvar.
978
+ * @type {boolean}
957
979
  */
958
980
  "ignoreSaveMessage": boolean;
959
981
  /**
960
982
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
983
+ * @type {SnkMessageBuilder}
961
984
  */
962
985
  "messagesBuilder": SnkMessageBuilder;
963
986
  /**
964
987
  * Determina quantas linhas são retornadas por página.
988
+ * @type {number}
989
+ * @default 150
965
990
  */
966
991
  "pageSize": number;
967
992
  /**
968
993
  * Identificador de recursos como configurações e acesso.
994
+ * @type {string}
969
995
  */
970
996
  "resourceID": string;
971
997
  /**
972
998
  * Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição.
999
+ * @type {boolean}
1000
+ * @default true
973
1001
  */
974
1002
  "useCancelConfirm": boolean;
975
1003
  }
@@ -1066,6 +1094,10 @@ export namespace Components {
1066
1094
  * Configurações para carregar os dados do componente
1067
1095
  */
1068
1096
  "config": SnkFilterItemConfig;
1097
+ /**
1098
+ * Usado para exibir mensagens de erro.
1099
+ */
1100
+ "errorMessage": string;
1069
1101
  /**
1070
1102
  * Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida
1071
1103
  */
@@ -1172,91 +1204,126 @@ export namespace Components {
1172
1204
  }
1173
1205
  interface SnkFilterBar {
1174
1206
  /**
1175
- * Adiciona um item de filtro.
1176
- * @param filterItem - Item a ser adicionado, caso o item já exista com o ID ele não será adicionado novamente
1207
+ * @description Adiciona um item de filtro.
1208
+ * @async
1209
+ * @param filterItem - Item a ser adicionado, caso o item já exista com o ID, ele não será adicionado novamente.
1210
+ * @return Retorna uma Promise que resolve quando o item for adicionado.
1177
1211
  */
1178
1212
  "addFilterItem": (filterItem: SnkFilterItemConfig) => Promise<void>;
1179
1213
  /**
1180
- * Função chamada depois de aplicar os filtros.
1214
+ * @description Função chamada depois de aplicar os filtros.
1181
1215
  */
1182
1216
  "afterApplyConfig"?: () => void;
1183
1217
  /**
1184
- * Define se a carga dos dados será feita assim que o componente for carregado.
1218
+ * @description Define se a carga dos dados será feita assim que o componente for carregado.
1185
1219
  */
1186
1220
  "autoLoad"?: boolean;
1187
1221
  /**
1188
- * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
1222
+ * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
1189
1223
  */
1190
1224
  "configName": string;
1191
1225
  /**
1192
- * Loader customizado para carregar as configurações
1226
+ * @description Loader customizado para carregar as configurações.
1227
+ * @param configName - Nome da configuração.
1228
+ * @param resourceId - ID do recurso.
1229
+ * @param options - Opções adicionais.
1230
+ * @returns Retorna a configuração dos filtros.
1193
1231
  */
1194
1232
  "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
1195
1233
  /**
1196
- * Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros.
1234
+ * @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.
1197
1235
  */
1198
1236
  "dataUnit": DataUnit;
1199
1237
  /**
1200
- * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados).
1238
+ * @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).
1201
1239
  */
1202
1240
  "disablePersonalizedFilter": boolean;
1203
1241
  /**
1204
- * Define se o componente deve usar o LockManager para controle de carregamento
1242
+ * @description Define se o componente deve usar o LockManager para controle de carregamento.
1205
1243
  */
1206
1244
  "enableLockManagerLoadingComp"?: boolean;
1207
1245
  /**
1208
- * Chave da configuração legado da barra de filtros.
1246
+ * @description Chave da configuração legada da barra de filtros.
1209
1247
  */
1210
1248
  "filterBarLegacyConfigName": string;
1211
1249
  /**
1212
- * Lista todos os filtros disponíveis ao usuário.
1250
+ * @description Lista todos os filtros disponíveis ao usuário.
1213
1251
  */
1214
1252
  "filterConfig": Array<SnkFilterItemConfig>;
1215
1253
  /**
1216
- * Retorna um item de filtro pelo ID.
1254
+ * @description Configuração customizada dos filtros.
1255
+ * @param config - Lista de configurações de filtros.
1256
+ */
1257
+ "filterCustomConfig"?: Array<SnkFilterItemConfig>;
1258
+ /**
1259
+ * @description Intercepta a configuração dos filtros antes de serem aplicadas.
1260
+ * @param config - Lista de configurações de filtros.
1261
+ * @returns Retorna a lista de configurações de filtros.
1262
+ */
1263
+ "filterCustomConfigInterceptor"?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
1264
+ /**
1265
+ * @description Retorna um item de filtro pelo ID.
1266
+ * @async
1267
+ * @param id - ID do item de filtro.
1268
+ * @returns O item de filtro correspondente ou undefined se não for encontrado.
1217
1269
  */
1218
1270
  "getFilterItem": (id: string) => Promise<SnkFilterItemConfig | undefined>;
1271
+ "getFilters": () => Promise<Filter1[]>;
1219
1272
  /**
1220
- * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
1273
+ * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
1221
1274
  */
1222
1275
  "messagesBuilder": SnkMessageBuilder;
1223
1276
  /**
1224
- * Modo de apresentação da filterbar.
1277
+ * @description Modo de apresentação da barra de filtros.
1225
1278
  */
1226
1279
  "mode": "regular" | "button" | "hidden";
1227
1280
  /**
1228
- * Faz o recarregamento da filterbar buscando o state no servidor.
1281
+ * @description Faz o recarregamento da barra de filtros buscando o state no servidor.
1282
+ * @async
1283
+ * @return Retorna uma Promise que resolve quando o recarregamento for concluído.
1229
1284
  */
1230
1285
  "reload": () => Promise<void>;
1231
1286
  /**
1232
- * Remove um item de filtro.
1233
- * @param filterID - ID do a ser adicionado
1234
- * @returns - Retorna o item de filtro removido, ou undefined caso não encontrado.
1287
+ * @description Remove um item de filtro.
1288
+ * @async
1289
+ * @param filterID - ID do item a ser removido.
1290
+ * @returns Retorna o item de filtro removido, ou undefined caso não seja encontrado.
1235
1291
  */
1236
1292
  "removeFilterItem": (filterID: string) => Promise<SnkFilterItemConfig | undefined>;
1237
1293
  /**
1238
- * Identificador de recursos como configurações e acesso.
1294
+ * @description Identificador de recursos como configurações e acesso.
1239
1295
  */
1240
1296
  "resourceID": string;
1241
1297
  /**
1242
- * Abre o modal de filtros
1298
+ * @description Abre o modal de filtros.
1299
+ * @async
1243
1300
  */
1244
1301
  "showFilterModal": () => Promise<void>;
1245
1302
  /**
1246
- * Título que será apresentado na barra de filtros
1303
+ * @description Título que será apresentado na barra de filtros.
1247
1304
  */
1248
1305
  "title": string;
1249
1306
  /**
1250
- * Atualiza um item do filtro.
1251
- * @param filterItem - Item com as informações atualizadas, caso o item não seja encontrado no array ele mão será modificado
1307
+ * @description Atualiza um item do filtro.
1308
+ * @async
1309
+ * @param newFilterItem - Item com as informações atualizadas, caso o item não seja encontrado no array, ele não será modificado.
1310
+ * @return Retorna uma Promise que resolve quando a atualização for concluída.
1252
1311
  */
1253
1312
  "updateFilterItem": (newFilterItem: SnkFilterItemConfig) => Promise<void>;
1254
1313
  }
1255
1314
  interface SnkFilterBinarySelect {
1315
+ /**
1316
+ * Limpa o valor do componente restaurando o valor original da configuração.
1317
+ */
1318
+ "clearValue": () => Promise<void>;
1256
1319
  /**
1257
1320
  * Define as configurações do componente snk-filter-binary-select
1258
1321
  */
1259
1322
  "config": SnkFilterItemConfig;
1323
+ /**
1324
+ * Usado para exibir mensagens de erro.
1325
+ */
1326
+ "errorMessage": string;
1260
1327
  /**
1261
1328
  * Define a variação do componente
1262
1329
  */
@@ -1265,18 +1332,35 @@ export namespace Components {
1265
1332
  * Redefine os valores padrão do componente.
1266
1333
  */
1267
1334
  "resetValues": () => Promise<void>;
1335
+ /**
1336
+ * Define o foco no componente snk-filter-binary-select.
1337
+ */
1338
+ "setFocus": () => Promise<void>;
1268
1339
  /**
1269
1340
  * Define o valor do componente snk-filter-binary-select
1270
1341
  */
1271
1342
  "value": any;
1272
1343
  }
1273
1344
  interface SnkFilterCheckboxList {
1345
+ /**
1346
+ * Limpa o valor do componente restaurando o valor original da configuração.
1347
+ */
1348
+ "clearValue": () => Promise<void>;
1274
1349
  /**
1275
1350
  * Define as configurações do componente snk-filter-multi-select
1276
1351
  */
1277
1352
  "config": SnkFilterItemConfig;
1353
+ /**
1354
+ * Usado para exibir mensagens de erro.
1355
+ */
1356
+ "errorMessage": string;
1357
+ /**
1358
+ * Define o foco no componente snk-filter-checkbox-list.
1359
+ */
1360
+ "setFocus": () => Promise<void>;
1278
1361
  }
1279
1362
  interface SnkFilterDetail {
1363
+ "clearValue": () => Promise<void>;
1280
1364
  /**
1281
1365
  * Define as configurações do componente snk-filter-detail.
1282
1366
  */
@@ -1286,9 +1370,13 @@ export namespace Components {
1286
1370
  */
1287
1371
  "getMessage": (key: string, props?: any) => string;
1288
1372
  /**
1289
- * Exibe o componente snk-filter-detail.
1373
+ * Define se o filtro pode ser removido.
1290
1374
  */
1291
- "show": () => Promise<void>;
1375
+ "removalBlocked": boolean;
1376
+ /**
1377
+ * Define o foco no campo do editor.
1378
+ */
1379
+ "setFocusField": () => Promise<void>;
1292
1380
  /**
1293
1381
  * Controla a visibilidade do botão de fixar elemento
1294
1382
  */
@@ -1402,13 +1490,19 @@ export namespace Components {
1402
1490
  */
1403
1491
  "editPersonalizedFilter": (id:string, isDefault?: boolean) => void;
1404
1492
  /**
1405
- * Guarda o filtro a ser deletado no Apply do modal
1493
+ * Filtros a serem apresentados
1406
1494
  */
1407
- "filterDefaultToDelete": SnkFilterItemConfig;
1495
+ "filterConfig": Array<SnkFilterItemConfig>;
1408
1496
  /**
1409
- * Filtros a serem apresentados
1497
+ * @description Intercepta a configuração dos filtros antes de serem aplicadas.
1498
+ * @param config - Lista de configurações de filtros.
1499
+ * @returns Retorna a lista de configurações de filtros.
1410
1500
  */
1411
- "filters": Array<SnkFilterItemConfig>;
1501
+ "filterCustomConfigInterceptor"?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
1502
+ /**
1503
+ * Guarda o filtro a ser deletado no Apply do modal
1504
+ */
1505
+ "filterDefaultToDelete": SnkFilterItemConfig;
1412
1506
  /**
1413
1507
  * Guarda filtros a serem deletados no Apply do modal
1414
1508
  */
@@ -1417,6 +1511,10 @@ export namespace Components {
1417
1511
  * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
1418
1512
  */
1419
1513
  "getMessage": (key: string, props?: any) => string;
1514
+ /**
1515
+ * Define se o modal está aberto ou não.
1516
+ */
1517
+ "opened": boolean;
1420
1518
  }
1421
1519
  interface SnkFilterModalItem {
1422
1520
  /**
@@ -1430,24 +1528,40 @@ export namespace Components {
1430
1528
  "resourceID": string;
1431
1529
  }
1432
1530
  interface SnkFilterMultiSelect {
1531
+ /**
1532
+ * Limpa o valor do componente restaurando o valor original da configuração.
1533
+ */
1534
+ "clearValue": () => Promise<void>;
1433
1535
  /**
1434
1536
  * Define as configurações do componente snk-filter-multi-select
1435
1537
  */
1436
1538
  "config": SnkFilterItemConfig;
1437
1539
  /**
1438
- * Exibe o componente snk-filter-multi-select
1540
+ * Usado para exibir mensagens de erro.
1439
1541
  */
1440
- "show": () => Promise<void>;
1542
+ "errorMessage": string;
1543
+ /**
1544
+ * Define o foco no componente snk-filter-multi-select.
1545
+ */
1546
+ "setFocus": () => Promise<void>;
1441
1547
  /**
1442
1548
  * Define o valor do componente snk-filter-multi-select
1443
1549
  */
1444
1550
  "value": any;
1445
1551
  }
1446
1552
  interface SnkFilterNumber {
1553
+ /**
1554
+ * Limpa o valor do componente restaurando o valor original da configuração.
1555
+ */
1556
+ "clearValue": () => Promise<void>;
1447
1557
  /**
1448
1558
  * Define as configurações do componente snk-filter-number
1449
1559
  */
1450
1560
  "config": SnkFilterItemConfig;
1561
+ /**
1562
+ * Usado para exibir mensagens de erro.
1563
+ */
1564
+ "errorMessage": string;
1451
1565
  /**
1452
1566
  * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
1453
1567
  */
@@ -1456,6 +1570,10 @@ export namespace Components {
1456
1570
  * Define a variação do componente
1457
1571
  */
1458
1572
  "presentationMode": EPresentationMode;
1573
+ /**
1574
+ * Define o foco no componente snk-filter-number
1575
+ */
1576
+ "setFocus": () => Promise<void>;
1459
1577
  /**
1460
1578
  * Exibe o componente snk-filter-number
1461
1579
  */
@@ -1480,10 +1598,18 @@ export namespace Components {
1480
1598
  "open": (expressionItem: IExpressionItem) => Promise<IExpressionItem>;
1481
1599
  }
1482
1600
  interface SnkFilterPeriod {
1601
+ /**
1602
+ * Limpa o valor do componente restaurando o valor original da configuração.
1603
+ */
1604
+ "clearValue": () => Promise<void>;
1483
1605
  /**
1484
1606
  * Define as configurações do componente snk-filter-period
1485
1607
  */
1486
1608
  "config": SnkFilterItemConfig;
1609
+ /**
1610
+ * Usado para exibir mensagens de erro.
1611
+ */
1612
+ "errorMessage": string;
1487
1613
  /**
1488
1614
  * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
1489
1615
  */
@@ -1492,6 +1618,10 @@ export namespace Components {
1492
1618
  * Define a variação do componente
1493
1619
  */
1494
1620
  "presentationMode": EPresentationMode;
1621
+ /**
1622
+ * Define o foco no componente snk-filter-period.
1623
+ */
1624
+ "setFocus": () => Promise<void>;
1495
1625
  /**
1496
1626
  * Exibe o componente snk-filter-period
1497
1627
  */
@@ -1499,27 +1629,47 @@ export namespace Components {
1499
1629
  /**
1500
1630
  * Define o valor do componente snk-filter-period
1501
1631
  */
1502
- "value": any;
1632
+ "value": Period;
1503
1633
  }
1504
1634
  interface SnkFilterSearch {
1635
+ /**
1636
+ * Limpa o valor do componente restaurando o valor original da configuração.
1637
+ */
1638
+ "clearValue": () => Promise<void>;
1505
1639
  /**
1506
1640
  * Define as configurações do componente snk-filter-search
1507
1641
  */
1508
1642
  "config": SnkFilterItemConfig;
1509
1643
  /**
1510
- * Exibe o componente snk-filter-search
1644
+ * Usado para exibir mensagens de erro.
1511
1645
  */
1512
- "show": () => Promise<void>;
1646
+ "errorMessage": string;
1647
+ /**
1648
+ * Define o foco no componente snk-filter-search.
1649
+ */
1650
+ "setFocus": () => Promise<void>;
1513
1651
  /**
1514
1652
  * Define o valor do componente snk-filter-search
1515
1653
  */
1516
1654
  "value": IOption2;
1517
1655
  }
1518
1656
  interface SnkFilterText {
1657
+ /**
1658
+ * Limpa o valor do componente restaurando o valor original da configuração.
1659
+ */
1660
+ "clearValue": () => Promise<void>;
1519
1661
  /**
1520
1662
  * Define as configurações do componente snk-filter-text.
1521
1663
  */
1522
1664
  "config": SnkFilterItemConfig;
1665
+ /**
1666
+ * Usado para exibir mensagens de erro.
1667
+ */
1668
+ "errorMessage": string;
1669
+ /**
1670
+ * Define o foco no componente snk-filter-text.
1671
+ */
1672
+ "setFocus": () => Promise<void>;
1523
1673
  /**
1524
1674
  * Define o valor do componente snk-filter-text.
1525
1675
  */
@@ -1527,7 +1677,11 @@ export namespace Components {
1527
1677
  }
1528
1678
  interface SnkForm {
1529
1679
  /**
1530
- * Registra um editor customizado para campos da grade e formulário.
1680
+ * Registra um editor customizado para campos do formulário.
1681
+ * @async
1682
+ * @param fieldName - Nome do campo.
1683
+ * @param customEditor - Editor customizado.
1684
+ * @returns
1531
1685
  */
1532
1686
  "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise<void>;
1533
1687
  /**
@@ -1535,11 +1689,13 @@ export namespace Components {
1535
1689
  */
1536
1690
  "configName": string;
1537
1691
  /**
1538
- * Chave da configuração legado do formulário.
1692
+ * Chave da configuração legada do formulário.
1539
1693
  */
1540
1694
  "formLegacyConfigName": string;
1541
1695
  /**
1542
1696
  * Fecha a janela de configurações do formulário.
1697
+ * @async
1698
+ * @returns
1543
1699
  */
1544
1700
  "hideConfig": () => Promise<void>;
1545
1701
  /**
@@ -1556,12 +1712,26 @@ export namespace Components {
1556
1712
  "resourceID": string;
1557
1713
  /**
1558
1714
  * Altera/adiciona uma propriedade nos metadados do campo.
1715
+ * @async
1716
+ * @param fieldName - Nome do campo.
1717
+ * @param propName - Nome da propriedade.
1718
+ * @param value - Valor da propriedade.
1719
+ * @returns
1559
1720
  */
1560
1721
  "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
1561
1722
  /**
1562
1723
  * Exibe a janela de configurações do formulário.
1724
+ * @async
1725
+ * @returns
1563
1726
  */
1564
1727
  "showConfig": () => Promise<void>;
1728
+ /**
1729
+ * Valida o formulário.
1730
+ * @async
1731
+ * @returns
1732
+ * @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.
1733
+ */
1734
+ "validate": () => Promise<void>;
1565
1735
  }
1566
1736
  interface SnkFormConfig {
1567
1737
  /**
@@ -1673,52 +1843,72 @@ export namespace Components {
1673
1843
  }
1674
1844
  interface SnkGrid {
1675
1845
  /**
1676
- * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
1846
+ * Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`.
1677
1847
  */
1678
1848
  "actionsList": Array<Action>;
1679
1849
  /**
1680
- * Registra um editor customizado para campos da grade e formulário
1850
+ * Registra um editor customizado para um campo da grade ou formulário.
1851
+ * @async
1852
+ * @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.
1853
+ * @param fieldName O nome do campo que receberá o editor customizado.
1854
+ * @param customEditor A instância do editor customizado.
1855
+ * @param detailContext O contexto de detalhe onde o editor será aplicado (opcional).
1856
+ * @returns Uma promessa que é resolvida quando o editor é registrado.
1681
1857
  */
1682
1858
  "addCustomEditor": (fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>;
1683
1859
  /**
1684
- * Registra um formatador de valores para uma coluna da grid.
1860
+ * Registra um formatador de valor customizado para uma coluna da grade.
1861
+ * @async
1862
+ * @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
1863
+ * @param columnName O nome da coluna que receberá o formatador.
1864
+ * @param customFormatter A instância do formatador de valor.
1865
+ * @returns Uma promessa que é resolvida quando o formatador é registrado.
1685
1866
  */
1686
1867
  "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise<void>;
1687
1868
  /**
1688
- * Registra um render customizado para colunas da grid.
1869
+ * Registra um renderizador customizado para uma coluna da grade.
1870
+ * @async
1871
+ * @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
1872
+ * @param fieldName O nome do campo (coluna) que receberá o renderizador customizado.
1873
+ * @param customRender A instância do renderizador customizado.
1874
+ * @param detailContext O contexto de detalhe onde o renderizador será aplicado (opcional).
1875
+ * @returns Uma promessa que é resolvida quando o renderizador é registrado.
1689
1876
  */
1690
1877
  "addGridCustomRender": (fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>;
1691
1878
  /**
1692
- * Define se a grid será focada ao ser carregada.
1879
+ * Define se a grade receberá o foco automaticamente ao ser carregada.
1693
1880
  */
1694
1881
  "autoFocus"?: boolean;
1695
1882
  /**
1696
- * Define se a carga dos dados será feita assim que o componente for carregado.
1883
+ * Define se os dados serão carregados automaticamente na inicialização do componente.
1697
1884
  */
1698
1885
  "autoLoad"?: boolean;
1699
1886
  /**
1700
- * Define se a edição está habilitada na grid.
1887
+ * Define se a edição de dados na grade está habilitada.
1701
1888
  */
1702
1889
  "canEdit": boolean;
1890
+ /**
1891
+ * Define o data source para o filtro de colunas.
1892
+ */
1703
1893
  "columnFilterDataSource": IMultiSelectionListDataSource;
1704
1894
  /**
1705
- * Define se a grade deve ser exibida em modo compacto
1895
+ * Define se a grade deve ser exibida em modo compacto.
1706
1896
  */
1707
1897
  "compact": boolean;
1708
1898
  /**
1709
- * Nome usado para salvar/recuperar a configuração.
1899
+ * Nome usado para salvar e recuperar a configuração da grade.
1710
1900
  */
1711
1901
  "configName": string;
1712
1902
  /**
1713
- * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados).
1903
+ * 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
1904
  */
1715
1905
  "disablePersonalizedFilter": boolean;
1716
1906
  /**
1717
- * Ativa inserção de registros no modo grade.
1907
+ * Habilita a inserção de registros diretamente na grade.
1718
1908
  */
1719
1909
  "enableGridInsert"?: boolean;
1720
1910
  /**
1721
- * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
1911
+ * Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
1722
1912
  */
1723
1913
  "enableLockManagerLoadingComp"?: boolean;
1724
1914
  /**
@@ -1726,31 +1916,48 @@ export namespace Components {
1726
1916
  */
1727
1917
  "enableLockManagerTaskbarClick"?: boolean;
1728
1918
  /**
1729
- * Chave da configuração legado da barra de filtros.
1919
+ * Chave da configuração legada da barra de filtros.
1730
1920
  */
1731
1921
  "filterBarLegacyConfigName": string;
1732
1922
  /**
1733
- * Título que será apresentado na barra de filtros
1923
+ * Título que será apresentado na barra de filtros.
1734
1924
  */
1735
1925
  "filterBarTitle": string;
1736
1926
  /**
1737
- * Retorna o elemento da filter-bar da grade.
1927
+ * @description Configuração customizada dos filtros.
1928
+ * @param config - Lista de configurações de filtros.
1929
+ */
1930
+ "filterCustomConfig"?: Array<SnkFilterItemConfig>;
1931
+ /**
1932
+ * @description Intercepta a configuração dos filtros antes de serem aplicadas.
1933
+ * @param config - Lista de configurações de filtros.
1934
+ * @returns Retorna a lista de configurações de filtros.
1935
+ */
1936
+ "filterCustomConfigInterceptor"?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
1937
+ /**
1938
+ * Retorna o elemento da barra de filtros da grade.
1939
+ * @async
1940
+ * @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.
1941
+ * @returns O elemento da barra de filtros.
1738
1942
  */
1739
1943
  "getFilterBar": () => Promise<HTMLSnkFilterBarElement>;
1740
1944
  /**
1741
- * Nome do slot de elementos customizados da Taskbar do cabeçalho da grade.
1945
+ * Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade.
1742
1946
  */
1743
1947
  "gridHeaderCustomSlotId": string;
1744
1948
  /**
1745
- * Chave da configuração legado da grade.
1949
+ * Chave da configuração legada da grade.
1746
1950
  */
1747
1951
  "gridLegacyConfigName": string;
1748
1952
  /**
1749
1953
  * Fecha a janela de configurações da grade.
1954
+ * @async
1955
+ * @description Este método fecha o pop-up de configuração de colunas da grade.
1956
+ * @returns Uma promessa que é resolvida quando a janela de configuração é fechada.
1750
1957
  */
1751
1958
  "hideConfig": () => Promise<void>;
1752
1959
  /**
1753
- * Determina se a grade está vinculada a um detalhe.
1960
+ * Determina se a grade está vinculada a um detalhe de outra tela.
1754
1961
  */
1755
1962
  "isDetail": boolean;
1756
1963
  /**
@@ -1758,92 +1965,119 @@ export namespace Components {
1758
1965
  */
1759
1966
  "messagesBuilder": SnkMessageBuilder;
1760
1967
  /**
1761
- * Habilita a edição de múltiplos registros simultâneos.
1968
+ * Habilita a edição de múltiplos registros simultaneamente.
1762
1969
  */
1763
1970
  "multipleEditionEnabled": boolean;
1764
1971
  /**
1765
- * Determina se pode haver mais de uma linha selecionada.
1972
+ * Determina se a seleção de múltiplas linhas é permitida.
1766
1973
  */
1767
1974
  "multipleSelection": boolean;
1768
1975
  /**
1769
- * Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
1976
+ * 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
1977
  */
1771
1978
  "outlineMode"?: boolean;
1772
1979
  /**
1773
- * Define se a grid será focada ao ser carregada.
1980
+ * Define o modo de exibição do contador de paginação.
1774
1981
  */
1775
1982
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
1776
1983
  /**
1777
- * Altera o modo de apresentação dos botões do snk-taskbar.
1984
+ * Altera o modo de apresentação dos botões do `snk-taskbar`.
1778
1985
  */
1779
1986
  "presentationMode": PresentationMode1;
1780
1987
  /**
1781
- * Validador responsável por checar a integridade das informações do registro.
1988
+ * Validador responsável por verificar a integridade dos dados de um registro.
1782
1989
  */
1783
1990
  "recordsValidator": IRecordValidator;
1991
+ "refreshColumnFilterDataSource": () => Promise<void>;
1992
+ /**
1993
+ * Recarrega a configuração da grade.
1994
+ * @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.
1995
+ */
1784
1996
  "reloadConfig": () => Promise<void>;
1785
1997
  /**
1786
- * Faz o recarregamento da filter-bar da grade buscando o state no servidor.
1998
+ * Recarrega a barra de filtros da grade, buscando o estado do servidor.
1999
+ * @async
2000
+ * @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
2001
+ * @returns Uma promessa que é resolvida quando a barra de filtros é recarregada.
1787
2002
  */
1788
2003
  "reloadFilterBar": () => Promise<void>;
1789
2004
  /**
1790
- * Remove o formatador de valores de uma coluna da grid.
2005
+ * Remove um formatador de valor customizado de uma coluna da grade.
2006
+ * @async
2007
+ * @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
2008
+ * @param columnName O nome da coluna da qual o formatador será removido.
2009
+ * @returns Uma promessa que é resolvida quando o formatador é removido.
1791
2010
  */
1792
2011
  "removeCustomValueFormatter": (columnName: string) => Promise<void>;
1793
2012
  /**
1794
- * Identificador de recursos como configurações e acesso.
2013
+ * Identificador de recursos, como configurações e permissões de acesso.
1795
2014
  */
1796
2015
  "resourceID": string;
1797
2016
  /**
1798
- * Configuração da seleção de grade no toast.
2017
+ * Configuração do toast de seleção da grade.
1799
2018
  */
1800
2019
  "selectionToastConfig": ISelectionToastConfig;
1801
2020
  /**
1802
- * Atribui o valor da configuração da grade.
2021
+ * Define a configuração da grade.
2022
+ * @async
2023
+ * @description Aplica uma nova configuração de colunas e ordenação à grade.
2024
+ * @param config O objeto de configuração a ser aplicado na grade.
2025
+ * @returns Uma promessa que é resolvida quando a configuração é aplicada.
1803
2026
  */
1804
2027
  "setConfig": (config: IGridConfig) => Promise<void>;
1805
2028
  /**
1806
2029
  * Atribui o foco para a grade.
2030
+ * @async
2031
+ * @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
2032
+ * @returns Uma promessa que é resolvida quando o foco é atribuído.
1807
2033
  */
1808
2034
  "setFocus": () => Promise<void>;
1809
2035
  /**
1810
2036
  * Exibe a janela de configurações da grade.
2037
+ * @async
2038
+ * @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.
2039
+ * @returns Uma promessa que é resolvida quando a janela de configuração é exibida.
1811
2040
  */
1812
2041
  "showConfig": () => Promise<void>;
1813
2042
  /**
1814
- * Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
2043
+ * Define a configuração de cores para a coluna de status.
2044
+ * @example ```json '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' ```
1815
2045
  */
1816
2046
  "statusResolver": IStatusResolver | StatusResolverFunction;
1817
2047
  /**
1818
- * Modo de exportação dos dados.
2048
+ * Define o modo de exportação dos dados.
1819
2049
  */
1820
2050
  "strategyExporter": IExporterStrategyMode;
1821
2051
  /**
1822
- * Informa se a coluna de chechbox deve ser suprimida
2052
+ * Informa se a coluna de checkbox deve ser suprimida.
1823
2053
  */
1824
2054
  "suppressCheckboxColumn": boolean;
1825
2055
  /**
1826
- * Define se a grade deve suprimir o scroll horizontal.
2056
+ * Informa se a grade deve suprimir o filtro de coluna.
2057
+ */
2058
+ "suppressFilterColumn"?: boolean;
2059
+ /**
2060
+ * Define se a grade deve suprimir a barra de rolagem horizontal.
1827
2061
  */
1828
2062
  "suppressHorizontalScroll": boolean;
1829
2063
  /**
1830
- * Define o identificador do container de elementos customizados da Taskbar.
2064
+ * Define o identificador do contêiner de elementos customizados da `Taskbar`.
1831
2065
  */
1832
2066
  "taskbarCustomContainerId": string;
1833
2067
  /**
1834
- * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
2068
+ * Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões.
1835
2069
  */
1836
2070
  "taskbarManager": TaskbarManager;
1837
2071
  /**
1838
- * Nome do slot de elementos customizados da Taskbar principal do componente.
2072
+ * Define o nome do slot para elementos customizados na `Taskbar` principal do componente.
1839
2073
  */
1840
2074
  "topTaskbarCustomSlotId": string;
1841
2075
  /**
1842
- * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
2076
+ * Quando `true`, a tecla ENTER navega entre as células como a tecla TAB.
1843
2077
  */
1844
2078
  "useEnterLikeTab": boolean;
1845
2079
  /**
1846
- * Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F
2080
+ * Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`.
1847
2081
  */
1848
2082
  "useSearchColumn": boolean;
1849
2083
  }
@@ -1973,28 +2207,40 @@ export namespace Components {
1973
2207
  }
1974
2208
  interface SnkPersonalizedFilter {
1975
2209
  /**
1976
- * Nome da configuração. Serve para distinguir várias instâncias do componente.
2210
+ * Nome da configuração, utilizado para distinguir múltiplas instâncias do componente.
2211
+ * @property
1977
2212
  */
1978
2213
  "configName": string;
2214
+ /**
2215
+ * Cria um novo filtro personalizado caso não exista nenhum.
2216
+ * @method
2217
+ * @returns
2218
+ */
1979
2219
  "createPersonalizedFilter": () => Promise<void>;
1980
2220
  /**
1981
- * Responsável por receber a URI da entidade.
2221
+ * URI da entidade utilizada para buscar os campos disponíveis para filtro.
2222
+ * @property
1982
2223
  */
1983
2224
  "entityUri": string;
1984
2225
  /**
1985
- * Id do filtro que será carregado.
2226
+ * Identificador do filtro a ser carregado.
2227
+ * @property
1986
2228
  */
1987
2229
  "filterId": string;
1988
2230
  /**
1989
- * Define se o filtro em questão é um filtro padrão.
2231
+ * Indica se o filtro é o filtro padrão do sistema.
2232
+ * @property
2233
+ * @default false
1990
2234
  */
1991
2235
  "isDefaultFilter": boolean;
1992
2236
  /**
1993
2237
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2238
+ * @property
1994
2239
  */
1995
2240
  "messagesBuilder": SnkMessageBuilder;
1996
2241
  /**
1997
- * Nome da configuração. Serve para distinguir várias instâncias do componente.
2242
+ * Identificador do recurso utilizado para salvar e recuperar filtros.
2243
+ * @property
1998
2244
  */
1999
2245
  "resourceID": string;
2000
2246
  }
@@ -2022,31 +2268,53 @@ export namespace Components {
2022
2268
  }
2023
2269
  interface SnkPesquisa {
2024
2270
  /**
2025
- * Define se permite seleção de items não analíticos
2271
+ * Define se permite a seleção de itens não analíticos.
2272
+ * @type {boolean}
2273
+ * @default false
2274
+ * @example allowsNonAnalytic={true}
2026
2275
  */
2027
2276
  "allowsNonAnalytic": boolean;
2028
2277
  /**
2029
- * Argumentos que serão usados ao chamar a função searchLoader.
2278
+ * Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente.
2279
+ * @type {string}
2280
+ * @mutable
2281
+ * @example argument="Texto para pesquisa"
2030
2282
  */
2031
2283
  "argument": string;
2032
2284
  /**
2033
- * Nome da entidade onde a pesquisa é aplicada.
2285
+ * Nome da entidade sobre a qual a pesquisa será realizada.
2286
+ * @type {string}
2287
+ * @example entityName="Produto"
2034
2288
  */
2035
2289
  "entityName": string;
2036
2290
  /**
2037
- * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
2291
+ * Define se a popup de pesquisa terá ou não modo hierárquico.
2292
+ * @type {boolean}
2293
+ * @default false
2294
+ * @example isHierarchyEntity={true}
2038
2295
  */
2039
2296
  "isHierarchyEntity": boolean;
2040
2297
  /**
2041
- * Função responsável em carregar os itens do componente snk-pesquisa.
2298
+ * Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados.
2299
+ * @type {(text: string) => Promise<any>}
2300
+ * @param text Texto utilizado como argumento de pesquisa.
2301
+ * @returns Promise com os dados da pesquisa.
2302
+ * @example searchLoader={(text) => fetchItems(text)}
2042
2303
  */
2043
2304
  "searchLoader": (text: string) => Promise<any>;
2044
2305
  /**
2045
- * Função disparada ao selecionar um item.
2306
+ * Função disparada ao selecionar um item da pesquisa.
2307
+ * @type {(option: IOption) => void}
2308
+ * @param option Item selecionado.
2309
+ * @returns void
2310
+ * @example selectItem={(option) => handleSelect(option)}
2046
2311
  */
2047
2312
  "selectItem": (option: IOption2) => void;
2048
2313
  /**
2049
- * Função responsável por carregar a árvore hierárquica do componente
2314
+ * Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível.
2315
+ * @type {(text: string) => Promise<any>}
2316
+ * @param text Texto utilizado como argumento de pesquisa para a árvore.
2317
+ * @returns Promise com os dados da árvore.
2050
2318
  */
2051
2319
  "treeLoader"?: (text: string) => Promise<any>;
2052
2320
  }
@@ -2065,11 +2333,11 @@ export namespace Components {
2065
2333
  }
2066
2334
  interface SnkSimpleBar {
2067
2335
  /**
2068
- * Define os itens que serão apresentados pelo breadcrumb
2336
+ * Define os itens que serão apresentados no breadcrumb.
2069
2337
  */
2070
2338
  "breadcrumbItens": Array<IBreadcrumbItem>;
2071
2339
  /**
2072
- * Define o título do header
2340
+ * Define o título do header.
2073
2341
  */
2074
2342
  "label": string;
2075
2343
  /**
@@ -2079,138 +2347,196 @@ export namespace Components {
2079
2347
  }
2080
2348
  interface SnkSimpleCrud {
2081
2349
  /**
2082
- * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
2350
+ * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
2083
2351
  */
2084
2352
  "actionsList": Array<Action>;
2085
2353
  /**
2086
- * Registra um editor customizado para campos da grade e formulário.
2354
+ * @description Registra um editor customizado para campos da grade e do formulário.
2355
+ * @param fieldName - O nome do campo.
2356
+ * @param customEditor - A instância do editor customizado.
2357
+ * @returns
2087
2358
  */
2088
2359
  "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise<void>;
2089
2360
  /**
2090
- * Registra um formatador de valores para uma coluna da grid.
2361
+ * @description Registra um formatador de valores para uma coluna da grade.
2362
+ * @param columnName - O nome da coluna.
2363
+ * @param customFormatter - A instância do formatador customizado.
2364
+ * @returns
2091
2365
  */
2092
2366
  "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise<void>;
2093
2367
  /**
2094
- * Registra um render customizado para colunas da grid.
2368
+ * @description Registra um renderizador customizado para colunas da grade.
2369
+ * @param fieldName - O nome do campo.
2370
+ * @param customRender - A instância do renderizador customizado.
2371
+ * @returns
2095
2372
  */
2096
2373
  "addGridCustomRender": (fieldName: string, customRender: ICustomRender) => Promise<void>;
2097
2374
  /**
2098
- * Define se a grid será focada ao ser carregada.
2375
+ * @description Define se a grade será focada ao ser carregada.
2099
2376
  */
2100
2377
  "autoFocus"?: boolean;
2101
2378
  /**
2102
- * Define se a carga dos dados será feita assim que o componente for carregado.
2379
+ * @description Define se a carga dos dados será feita assim que o componente for carregado.
2103
2380
  */
2104
2381
  "autoLoad"?: boolean;
2105
2382
  /**
2106
- * Usado para fechar o configurator do CRUD
2383
+ * @description Usado para fechar o configurador do CRUD.
2384
+ * @returns
2107
2385
  */
2108
2386
  "closeConfigurator": () => Promise<void>;
2109
2387
  /**
2110
- * Usado para salvar as configurações dos blocos de construção.
2388
+ * @description Usado para salvar as configurações dos blocos de construção.
2111
2389
  */
2112
2390
  "configName": string;
2391
+ /**
2392
+ * @description Estado atual dos dados.
2393
+ */
2113
2394
  "dataState": DataState1;
2395
+ /**
2396
+ * @description Instância do DataUnit a ser utilizada pelo componente.
2397
+ */
2114
2398
  "dataUnit": DataUnit;
2115
2399
  /**
2116
- * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
2400
+ * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade).
2117
2401
  */
2118
2402
  "domainMessagesBuilder": string;
2403
+ /**
2404
+ * @description Habilita a inserção contínua de registros.
2405
+ */
2119
2406
  "enableContinuousInsert": boolean;
2120
2407
  /**
2121
- * Ativa inserção de registros no modo grade.
2408
+ * @description Ativa a inserção de registros no modo grade.
2122
2409
  */
2123
2410
  "enableGridInsert"?: boolean;
2124
2411
  /**
2125
- * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
2412
+ * @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
2126
2413
  */
2127
2414
  "enableLockManagerLoadingComp"?: boolean;
2128
2415
  /**
2129
- * Ativa o gerenciamento de locks na grade pela Taskbar.
2416
+ * @description Ativa o gerenciamento de locks na grade pela Taskbar.
2130
2417
  */
2131
2418
  "enableLockManagerTaskbarClick"?: boolean;
2132
2419
  /**
2133
- * Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD
2420
+ * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD.
2134
2421
  */
2135
2422
  "entityName": string;
2423
+ /**
2424
+ * @description Configuração do formulário.
2425
+ */
2136
2426
  "formConfig": IFormConfig;
2137
2427
  /**
2138
- * Chave da configuração legado do formulário.
2428
+ * @description Chave da configuração legada do formulário.
2139
2429
  */
2140
2430
  "formLegacyConfigName": string;
2431
+ /**
2432
+ * @description Obtém os registros do DataUnit.
2433
+ * @returns Uma promessa que resolve com a lista de registros.
2434
+ */
2141
2435
  "getRecords": () => Promise<Array<Record>>;
2142
2436
  /**
2143
- * Usado para alternar a visão entre GRID e FORM externamente.
2437
+ * @description Usado para alternar a visão entre GRID e FORM externamente.
2438
+ * @param view - A visão para a qual navegar.
2439
+ * @returns
2144
2440
  */
2145
2441
  "goToView": (view: VIEW_MODE) => Promise<void>;
2442
+ /**
2443
+ * @description Configuração da grade.
2444
+ */
2146
2445
  "gridConfig": IGridConfig;
2147
2446
  /**
2148
- * Chave da configuração legado da grade.
2447
+ * @description Chave da configuração legada da grade.
2149
2448
  */
2150
2449
  "gridLegacyConfigName": string;
2151
2450
  /**
2152
- * Ignora os campos "somente leitura" no modo de inserção.
2451
+ * @description Ignora os campos "somente leitura" no modo de inserção.
2153
2452
  */
2154
2453
  "ignoreReadOnlyFormFields": boolean;
2155
2454
  /**
2156
- * Define se o LayoutFormConfig será exibido no configurador.
2455
+ * @description Define se o LayoutFormConfig será exibido no configurador.
2157
2456
  */
2158
2457
  "layoutFormConfig": boolean;
2159
2458
  /**
2160
- * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2459
+ * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2161
2460
  */
2162
2461
  "messagesBuilder": SnkMessageBuilder;
2462
+ /**
2463
+ * @description Define o modo de operação do CRUD (servidor ou em memória).
2464
+ */
2163
2465
  "mode": SIMPLE_CRUD_MODE;
2164
2466
  /**
2165
- * Habilita a edição de múltiplos registros simultâneos.
2467
+ * @description Habilita a edição de múltiplos registros simultâneos.
2166
2468
  */
2167
2469
  "multipleEditionEnabled": boolean;
2168
2470
  /**
2169
- * Determina se pode haver mais de uma linha selecionada na grade.
2471
+ * @description Determina se pode haver mais de uma linha selecionada na grade.
2170
2472
  */
2171
2473
  "multipleSelection": boolean;
2172
2474
  /**
2173
- * Usado para abrir o configurator do CRUD
2475
+ * @description Usado para abrir o configurador do CRUD.
2476
+ * @returns
2174
2477
  */
2175
2478
  "openConfigurator": () => Promise<void>;
2176
2479
  /**
2177
- * Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
2480
+ * @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).
2178
2481
  */
2179
2482
  "outlineMode"?: boolean;
2180
2483
  /**
2181
- * Determina quantas linhas são retornadas por página.
2484
+ * @description Determina quantas linhas são retornadas por página.
2182
2485
  */
2183
2486
  "pageSize": number;
2184
2487
  /**
2185
- * Define se a grid será focada ao ser carregada.
2488
+ * @description Define o modo de exibição do contador de paginação.
2186
2489
  */
2187
2490
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
2188
2491
  /**
2189
- * Remove o formatador de valores de uma coluna da grid.
2492
+ * @description Remove o formatador de valores de uma coluna da grade.
2493
+ * @param columnName - O nome da coluna.
2494
+ * @returns
2190
2495
  */
2191
2496
  "removeCustomValueFormatter": (columnName: string) => Promise<void>;
2192
2497
  /**
2193
- * Identificador de recursos como configurações e acesso.
2498
+ * @description Identificador de recursos como configurações e acesso.
2194
2499
  */
2195
2500
  "resourceID": string;
2196
2501
  /**
2197
- * Altera/adiciona uma propriedade nos metadados do campo.
2502
+ * @description Altera/adiciona uma propriedade nos metadados do campo.
2503
+ * @param fieldName - O nome do campo.
2504
+ * @param propName - O nome da propriedade.
2505
+ * @param value - O valor da propriedade.
2506
+ * @returns
2198
2507
  */
2199
2508
  "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
2509
+ /**
2510
+ * @description Define os metadados do DataUnit.
2511
+ * @param metadata - Os metadados a serem definidos.
2512
+ * @returns
2513
+ */
2200
2514
  "setMetadata": (metadata: UnitMetadata) => Promise<void>;
2515
+ /**
2516
+ * @description Define os registros do DataUnit.
2517
+ * @param records - Os registros a serem definidos.
2518
+ * @returns
2519
+ */
2201
2520
  "setRecords": (records: Array<Record>) => Promise<void>;
2202
2521
  /**
2203
- * Usado para exibir os botões de ação do snk-configurator.
2522
+ * @description Usado para exibir os botões de ação do snk-configurator.
2204
2523
  */
2205
2524
  "showConfiguratorButtons": boolean;
2206
2525
  /**
2207
- * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
2526
+ * @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
2208
2527
  */
2209
2528
  "taskbarManager": TaskbarManager;
2529
+ /**
2530
+ * @description Atualiza a configuração do formulário.
2531
+ * @returns
2532
+ */
2210
2533
  "updateConfig": () => Promise<void>;
2534
+ /**
2535
+ * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
2536
+ */
2211
2537
  "useCancelConfirm": boolean;
2212
2538
  /**
2213
- * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
2539
+ * @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
2214
2540
  */
2215
2541
  "useEnterLikeTab": boolean;
2216
2542
  }
@@ -2234,63 +2560,64 @@ export namespace Components {
2234
2560
  }
2235
2561
  interface SnkTaskbar {
2236
2562
  /**
2237
- * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
2563
+ * @description Lista de ações a serem exibidas no botão "Mais opções".
2238
2564
  */
2239
2565
  "actionsList": Array<Action>;
2240
2566
  /**
2241
- * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
2567
+ * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
2242
2568
  */
2243
2569
  "actionsSettingsList": Array<Action>;
2244
2570
  /**
2245
- * Usado para determinar O alinhamento dos items na taskbar.
2571
+ * @description Define o alinhamento dos itens da barra de tarefas à direita.
2246
2572
  */
2247
2573
  "alignRigth": boolean;
2248
2574
  /**
2249
- * Lista separada por virgula, contendo todos os elementos a serem criados.
2575
+ * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas.
2250
2576
  */
2251
2577
  "buttons": string;
2252
2578
  /**
2253
- * Usado para guardar ou recuperar as configurações do formulário.
2579
+ * @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.
2254
2580
  */
2255
2581
  "configName": string;
2256
2582
  /**
2257
- * Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer.
2583
+ * @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.
2258
2584
  */
2259
2585
  "customButtons": Map<string, CustomButton>;
2260
2586
  /**
2261
- * Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados que não podem ser passados por slot. Exemplo: Elementos customizados na Taskbar da aba de detalhes.
2587
+ * @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.
2588
+ * @example Elementos customizados na Taskbar da aba de detalhes.
2262
2589
  */
2263
2590
  "customContainerId": string;
2264
2591
  /**
2265
- * Usado para determinar o identificador do slot que recebe elementos personalizados.
2592
+ * @description Define o identificador do slot que recebe elementos personalizados.
2266
2593
  */
2267
2594
  "customSlotId": string;
2268
2595
  /**
2269
- * Instância do DataUnit.
2596
+ * @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).
2270
2597
  */
2271
2598
  "dataUnit": DataUnit;
2272
2599
  /**
2273
- * Array contendo todos os botões a serem desabilitados.
2600
+ * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
2274
2601
  */
2275
2602
  "disabledButtons": Array<string>;
2276
2603
  /**
2277
- * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2604
+ * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
2278
2605
  */
2279
2606
  "messagesBuilder": SnkMessageBuilder;
2280
2607
  /**
2281
- * Define como será o comportamento da taskbar quando ocorrer overflow
2608
+ * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens.
2282
2609
  */
2283
2610
  "overflowStrategy": 'hiddenItems' | 'none';
2284
2611
  /**
2285
- * Altera o modo de apresentação dos botões do snk-taskbar.
2612
+ * @description Altera o modo de apresentação dos botões da barra de tarefas.
2286
2613
  */
2287
2614
  "presentationMode": PresentationMode1;
2288
2615
  /**
2289
- * Determina qual botão deve ter aparência primária.
2616
+ * @description Define qual botão deve ter a aparência de destaque (primário).
2290
2617
  */
2291
2618
  "primaryButton": string;
2292
2619
  /**
2293
- * Identificador de recursos como configurações e acesso.
2620
+ * @description Identificador de recursos, como configurações e permissões de acesso.
2294
2621
  */
2295
2622
  "resourceID": string;
2296
2623
  }
@@ -3416,78 +3743,112 @@ declare namespace LocalJSX {
3416
3743
  interface SnkDataUnit {
3417
3744
  /**
3418
3745
  * Executado após a ação de salvar.
3746
+ * @param dataUnit - A instância do DataUnit.
3747
+ * @returns
3419
3748
  */
3420
3749
  "afterSave"?: (dataUnit: DataUnit) => void;
3421
3750
  /**
3422
3751
  * 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.
3752
+ * @param dataUnit - A instância do DataUnit.
3753
+ * @returns `false` para cancelar a ação, `true` para continuar.
3423
3754
  */
3424
3755
  "beforeSave"?: (dataUnit: DataUnit) => boolean | Promise<boolean>;
3425
3756
  /**
3426
3757
  * Usado para obter configuração de metadados.
3758
+ * @type {string}
3427
3759
  */
3428
3760
  "configName"?: string;
3429
3761
  /**
3430
3762
  * Controla o estado atual dos dados.
3763
+ * @type {DataState}
3431
3764
  */
3432
3765
  "dataState"?: DataState;
3433
3766
  /**
3434
3767
  * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
3768
+ * @type {DataUnit}
3435
3769
  */
3436
3770
  "dataUnit"?: DataUnit;
3437
3771
  /**
3438
3772
  * Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade.
3773
+ * @type {string}
3439
3774
  */
3440
3775
  "dataUnitName"?: string;
3441
3776
  /**
3442
3777
  * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
3778
+ * @type {string}
3443
3779
  */
3444
3780
  "domainMessagesBuilder"?: string;
3445
3781
  /**
3446
3782
  * Determina qual a entidade que representa os dados em questão.
3783
+ * @type {string}
3447
3784
  */
3448
3785
  "entityName"?: string;
3449
3786
  /**
3450
3787
  * Responsável por evitar a mensagem de sucesso ao salvar.
3788
+ * @type {boolean}
3451
3789
  */
3452
3790
  "ignoreSaveMessage"?: boolean;
3453
3791
  /**
3454
3792
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
3793
+ * @type {SnkMessageBuilder}
3455
3794
  */
3456
3795
  "messagesBuilder"?: SnkMessageBuilder;
3457
3796
  /**
3458
3797
  * Emitido quando se cancela uma inserção ou cópia.
3798
+ * @event cancelEdition
3799
+ * @type {CustomEvent<void>}
3800
+ * @bubbles false
3459
3801
  */
3460
3802
  "onCancelEdition"?: (event: SnkDataUnitCustomEvent<void>) => void;
3461
3803
  /**
3462
3804
  * Emitido quando há qualquer mudança de estado no DataUnit.
3805
+ * @event dataStateChange
3806
+ * @type {CustomEvent<DataState>}
3807
+ * @bubbles false
3463
3808
  */
3464
3809
  "onDataStateChange"?: (event: SnkDataUnitCustomEvent<DataState>) => void;
3465
3810
  /**
3466
3811
  * Emitido quando há campos no DataUnit que devem ser ocultados.
3812
+ * @event dataUnitFieldsHidded
3813
+ * @type {CustomEvent<void>}
3467
3814
  */
3468
3815
  "onDataUnitFieldsHidded"?: (event: SnkDataUnitCustomEvent<void>) => void;
3469
3816
  /**
3470
3817
  * Emitido quando o DataUnit está pronto.
3818
+ * @event dataUnitReady
3819
+ * @type {CustomEvent<DataUnit>}
3820
+ * @bubbles false
3471
3821
  */
3472
3822
  "onDataUnitReady"?: (event: SnkDataUnitCustomEvent<DataUnit>) => void;
3473
3823
  /**
3474
3824
  * Emitido quando um registro é adicionado ou copiado.
3825
+ * @event insertionMode
3826
+ * @type {CustomEvent<void>}
3827
+ * @bubbles false
3475
3828
  */
3476
3829
  "onInsertionMode"?: (event: SnkDataUnitCustomEvent<void>) => void;
3477
3830
  /**
3478
- * Emitido quando o DataUnit está pronto.
3831
+ * Emitido quando o messagesBuilder é atualizado.
3832
+ * @event messagesBuilderUpdated
3833
+ * @type {CustomEvent<SnkMessageBuilder>}
3834
+ * @bubbles false
3479
3835
  */
3480
3836
  "onMessagesBuilderUpdated"?: (event: SnkDataUnitCustomEvent<SnkMessageBuilder>) => void;
3481
3837
  /**
3482
3838
  * Determina quantas linhas são retornadas por página.
3839
+ * @type {number}
3840
+ * @default 150
3483
3841
  */
3484
3842
  "pageSize"?: number;
3485
3843
  /**
3486
3844
  * Identificador de recursos como configurações e acesso.
3845
+ * @type {string}
3487
3846
  */
3488
3847
  "resourceID"?: string;
3489
3848
  /**
3490
3849
  * Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição.
3850
+ * @type {boolean}
3851
+ * @default true
3491
3852
  */
3492
3853
  "useCancelConfirm"?: boolean;
3493
3854
  }
@@ -3579,6 +3940,10 @@ declare namespace LocalJSX {
3579
3940
  * Configurações para carregar os dados do componente
3580
3941
  */
3581
3942
  "config"?: SnkFilterItemConfig;
3943
+ /**
3944
+ * Usado para exibir mensagens de erro.
3945
+ */
3946
+ "errorMessage"?: string;
3582
3947
  /**
3583
3948
  * Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida
3584
3949
  */
@@ -3710,56 +4075,76 @@ declare namespace LocalJSX {
3710
4075
  }
3711
4076
  interface SnkFilterBar {
3712
4077
  /**
3713
- * Função chamada depois de aplicar os filtros.
4078
+ * @description Função chamada depois de aplicar os filtros.
3714
4079
  */
3715
4080
  "afterApplyConfig"?: () => void;
3716
4081
  /**
3717
- * Define se a carga dos dados será feita assim que o componente for carregado.
4082
+ * @description Define se a carga dos dados será feita assim que o componente for carregado.
3718
4083
  */
3719
4084
  "autoLoad"?: boolean;
3720
4085
  /**
3721
- * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
4086
+ * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
3722
4087
  */
3723
4088
  "configName"?: string;
3724
4089
  /**
3725
- * Loader customizado para carregar as configurações
4090
+ * @description Loader customizado para carregar as configurações.
4091
+ * @param configName - Nome da configuração.
4092
+ * @param resourceId - ID do recurso.
4093
+ * @param options - Opções adicionais.
4094
+ * @returns Retorna a configuração dos filtros.
3726
4095
  */
3727
4096
  "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
3728
4097
  /**
3729
- * Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros.
4098
+ * @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.
3730
4099
  */
3731
4100
  "dataUnit"?: DataUnit;
3732
4101
  /**
3733
- * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados).
4102
+ * @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).
3734
4103
  */
3735
4104
  "disablePersonalizedFilter"?: boolean;
3736
4105
  /**
3737
- * Define se o componente deve usar o LockManager para controle de carregamento
4106
+ * @description Define se o componente deve usar o LockManager para controle de carregamento.
3738
4107
  */
3739
4108
  "enableLockManagerLoadingComp"?: boolean;
3740
4109
  /**
3741
- * Chave da configuração legado da barra de filtros.
4110
+ * @description Chave da configuração legada da barra de filtros.
3742
4111
  */
3743
4112
  "filterBarLegacyConfigName"?: string;
3744
4113
  /**
3745
- * Lista todos os filtros disponíveis ao usuário.
4114
+ * @description Lista todos os filtros disponíveis ao usuário.
3746
4115
  */
3747
4116
  "filterConfig"?: Array<SnkFilterItemConfig>;
3748
4117
  /**
3749
- * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4118
+ * @description Configuração customizada dos filtros.
4119
+ * @param config - Lista de configurações de filtros.
4120
+ */
4121
+ "filterCustomConfig"?: Array<SnkFilterItemConfig>;
4122
+ /**
4123
+ * @description Intercepta a configuração dos filtros antes de serem aplicadas.
4124
+ * @param config - Lista de configurações de filtros.
4125
+ * @returns Retorna a lista de configurações de filtros.
4126
+ */
4127
+ "filterCustomConfigInterceptor"?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
4128
+ /**
4129
+ * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
3750
4130
  */
3751
4131
  "messagesBuilder"?: SnkMessageBuilder;
3752
4132
  /**
3753
- * Modo de apresentação da filterbar.
4133
+ * @description Modo de apresentação da barra de filtros.
3754
4134
  */
3755
4135
  "mode"?: "regular" | "button" | "hidden";
4136
+ /**
4137
+ * @description Evento emitido quando a configuração dos filtros é atualizada.
4138
+ * @param configs - Lista de configurações de filtros atualizadas.
4139
+ * @event
4140
+ */
3756
4141
  "onConfigUpdated"?: (event: SnkFilterBarCustomEvent<SnkFilterItemConfig[]>) => void;
3757
4142
  /**
3758
- * Identificador de recursos como configurações e acesso.
4143
+ * @description Identificador de recursos como configurações e acesso.
3759
4144
  */
3760
4145
  "resourceID"?: string;
3761
4146
  /**
3762
- * Título que será apresentado na barra de filtros
4147
+ * @description Título que será apresentado na barra de filtros.
3763
4148
  */
3764
4149
  "title"?: string;
3765
4150
  }
@@ -3768,6 +4153,10 @@ declare namespace LocalJSX {
3768
4153
  * Define as configurações do componente snk-filter-binary-select
3769
4154
  */
3770
4155
  "config"?: SnkFilterItemConfig;
4156
+ /**
4157
+ * Usado para exibir mensagens de erro.
4158
+ */
4159
+ "errorMessage"?: string;
3771
4160
  /**
3772
4161
  * Emitido quando o valor do filtro é alterado.
3773
4162
  */
@@ -3786,6 +4175,10 @@ declare namespace LocalJSX {
3786
4175
  * Define as configurações do componente snk-filter-multi-select
3787
4176
  */
3788
4177
  "config"?: SnkFilterItemConfig;
4178
+ /**
4179
+ * Usado para exibir mensagens de erro.
4180
+ */
4181
+ "errorMessage"?: string;
3789
4182
  /**
3790
4183
  * Emite um evento customizado ao realizar alteração nos valores do componente
3791
4184
  */
@@ -3804,6 +4197,10 @@ declare namespace LocalJSX {
3804
4197
  * Emitido quando há uma alteração nos filtros.
3805
4198
  */
3806
4199
  "onFilterChange"?: (event: SnkFilterDetailCustomEvent<SnkFilterItemConfig>) => void;
4200
+ /**
4201
+ * Define se o filtro pode ser removido.
4202
+ */
4203
+ "removalBlocked"?: boolean;
3807
4204
  /**
3808
4205
  * Controla a visibilidade do botão de fixar elemento
3809
4206
  */
@@ -3910,13 +4307,19 @@ declare namespace LocalJSX {
3910
4307
  */
3911
4308
  "editPersonalizedFilter"?: (id:string, isDefault?: boolean) => void;
3912
4309
  /**
3913
- * Guarda o filtro a ser deletado no Apply do modal
4310
+ * Filtros a serem apresentados
3914
4311
  */
3915
- "filterDefaultToDelete"?: SnkFilterItemConfig;
4312
+ "filterConfig"?: Array<SnkFilterItemConfig>;
3916
4313
  /**
3917
- * Filtros a serem apresentados
4314
+ * @description Intercepta a configuração dos filtros antes de serem aplicadas.
4315
+ * @param config - Lista de configurações de filtros.
4316
+ * @returns Retorna a lista de configurações de filtros.
4317
+ */
4318
+ "filterCustomConfigInterceptor"?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
4319
+ /**
4320
+ * Guarda o filtro a ser deletado no Apply do modal
3918
4321
  */
3919
- "filters"?: Array<SnkFilterItemConfig>;
4322
+ "filterDefaultToDelete"?: SnkFilterItemConfig;
3920
4323
  /**
3921
4324
  * Guarda filtros a serem deletados no Apply do modal
3922
4325
  */
@@ -3925,6 +4328,10 @@ declare namespace LocalJSX {
3925
4328
  * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
3926
4329
  */
3927
4330
  "getMessage"?: (key: string, props?: any) => string;
4331
+ /**
4332
+ * Define se o modal está aberto ou não.
4333
+ */
4334
+ "opened"?: boolean;
3928
4335
  }
3929
4336
  interface SnkFilterModalItem {
3930
4337
  /**
@@ -3945,6 +4352,10 @@ declare namespace LocalJSX {
3945
4352
  * Define as configurações do componente snk-filter-multi-select
3946
4353
  */
3947
4354
  "config"?: SnkFilterItemConfig;
4355
+ /**
4356
+ * Usado para exibir mensagens de erro.
4357
+ */
4358
+ "errorMessage"?: string;
3948
4359
  /**
3949
4360
  * Emitido quando o valor do filtro é alterado.
3950
4361
  */
@@ -3959,6 +4370,10 @@ declare namespace LocalJSX {
3959
4370
  * Define as configurações do componente snk-filter-number
3960
4371
  */
3961
4372
  "config"?: SnkFilterItemConfig;
4373
+ /**
4374
+ * Usado para exibir mensagens de erro.
4375
+ */
4376
+ "errorMessage"?: string;
3962
4377
  /**
3963
4378
  * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
3964
4379
  */
@@ -3987,6 +4402,10 @@ declare namespace LocalJSX {
3987
4402
  * Define as configurações do componente snk-filter-period
3988
4403
  */
3989
4404
  "config"?: SnkFilterItemConfig;
4405
+ /**
4406
+ * Usado para exibir mensagens de erro.
4407
+ */
4408
+ "errorMessage"?: string;
3990
4409
  /**
3991
4410
  * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
3992
4411
  */
@@ -4002,13 +4421,17 @@ declare namespace LocalJSX {
4002
4421
  /**
4003
4422
  * Define o valor do componente snk-filter-period
4004
4423
  */
4005
- "value"?: any;
4424
+ "value"?: Period;
4006
4425
  }
4007
4426
  interface SnkFilterSearch {
4008
4427
  /**
4009
4428
  * Define as configurações do componente snk-filter-search
4010
4429
  */
4011
4430
  "config"?: SnkFilterItemConfig;
4431
+ /**
4432
+ * Usado para exibir mensagens de erro.
4433
+ */
4434
+ "errorMessage"?: string;
4012
4435
  /**
4013
4436
  * Emitido quando o valor do filtro é alterado.
4014
4437
  */
@@ -4023,6 +4446,10 @@ declare namespace LocalJSX {
4023
4446
  * Define as configurações do componente snk-filter-text.
4024
4447
  */
4025
4448
  "config"?: SnkFilterItemConfig;
4449
+ /**
4450
+ * Usado para exibir mensagens de erro.
4451
+ */
4452
+ "errorMessage"?: string;
4026
4453
  /**
4027
4454
  * Emitido quando o valor do filtro é alterado.
4028
4455
  */
@@ -4038,7 +4465,7 @@ declare namespace LocalJSX {
4038
4465
  */
4039
4466
  "configName"?: string;
4040
4467
  /**
4041
- * Chave da configuração legado do formulário.
4468
+ * Chave da configuração legada do formulário.
4042
4469
  */
4043
4470
  "formLegacyConfigName"?: string;
4044
4471
  /**
@@ -4046,15 +4473,15 @@ declare namespace LocalJSX {
4046
4473
  */
4047
4474
  "messagesBuilder"?: SnkMessageBuilder;
4048
4475
  /**
4049
- * Emitido sempre que houver click de botão ou ação.
4476
+ * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
4050
4477
  */
4051
4478
  "onActionClick"?: (event: SnkFormCustomEvent<string>) => void;
4052
4479
  /**
4053
- * Emitido quando o botão de voltar é acionado.
4480
+ * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
4054
4481
  */
4055
4482
  "onExit"?: (event: SnkFormCustomEvent<void>) => void;
4056
4483
  /**
4057
- * Responsável por notificar quando ocorrer a renderização de itens do formulário.
4484
+ * Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view
4058
4485
  */
4059
4486
  "onFormItemsReady"?: (event: SnkFormCustomEvent<Array<HTMLElement>>) => void;
4060
4487
  /**
@@ -4183,40 +4610,43 @@ declare namespace LocalJSX {
4183
4610
  }
4184
4611
  interface SnkGrid {
4185
4612
  /**
4186
- * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
4613
+ * Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`.
4187
4614
  */
4188
4615
  "actionsList"?: Array<Action>;
4189
4616
  /**
4190
- * Define se a grid será focada ao ser carregada.
4617
+ * Define se a grade receberá o foco automaticamente ao ser carregada.
4191
4618
  */
4192
4619
  "autoFocus"?: boolean;
4193
4620
  /**
4194
- * Define se a carga dos dados será feita assim que o componente for carregado.
4621
+ * Define se os dados serão carregados automaticamente na inicialização do componente.
4195
4622
  */
4196
4623
  "autoLoad"?: boolean;
4197
4624
  /**
4198
- * Define se a edição está habilitada na grid.
4625
+ * Define se a edição de dados na grade está habilitada.
4199
4626
  */
4200
4627
  "canEdit"?: boolean;
4628
+ /**
4629
+ * Define o data source para o filtro de colunas.
4630
+ */
4201
4631
  "columnFilterDataSource"?: IMultiSelectionListDataSource;
4202
4632
  /**
4203
- * Define se a grade deve ser exibida em modo compacto
4633
+ * Define se a grade deve ser exibida em modo compacto.
4204
4634
  */
4205
4635
  "compact"?: boolean;
4206
4636
  /**
4207
- * Nome usado para salvar/recuperar a configuração.
4637
+ * Nome usado para salvar e recuperar a configuração da grade.
4208
4638
  */
4209
4639
  "configName"?: string;
4210
4640
  /**
4211
- * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados).
4641
+ * 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
4642
  */
4213
4643
  "disablePersonalizedFilter"?: boolean;
4214
4644
  /**
4215
- * Ativa inserção de registros no modo grade.
4645
+ * Habilita a inserção de registros diretamente na grade.
4216
4646
  */
4217
4647
  "enableGridInsert"?: boolean;
4218
4648
  /**
4219
- * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
4649
+ * Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
4220
4650
  */
4221
4651
  "enableLockManagerLoadingComp"?: boolean;
4222
4652
  /**
@@ -4224,23 +4654,34 @@ declare namespace LocalJSX {
4224
4654
  */
4225
4655
  "enableLockManagerTaskbarClick"?: boolean;
4226
4656
  /**
4227
- * Chave da configuração legado da barra de filtros.
4657
+ * Chave da configuração legada da barra de filtros.
4228
4658
  */
4229
4659
  "filterBarLegacyConfigName"?: string;
4230
4660
  /**
4231
- * Título que será apresentado na barra de filtros
4661
+ * Título que será apresentado na barra de filtros.
4232
4662
  */
4233
4663
  "filterBarTitle"?: string;
4234
4664
  /**
4235
- * Nome do slot de elementos customizados da Taskbar do cabeçalho da grade.
4665
+ * @description Configuração customizada dos filtros.
4666
+ * @param config - Lista de configurações de filtros.
4667
+ */
4668
+ "filterCustomConfig"?: Array<SnkFilterItemConfig>;
4669
+ /**
4670
+ * @description Intercepta a configuração dos filtros antes de serem aplicadas.
4671
+ * @param config - Lista de configurações de filtros.
4672
+ * @returns Retorna a lista de configurações de filtros.
4673
+ */
4674
+ "filterCustomConfigInterceptor"?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
4675
+ /**
4676
+ * Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade.
4236
4677
  */
4237
4678
  "gridHeaderCustomSlotId"?: string;
4238
4679
  /**
4239
- * Chave da configuração legado da grade.
4680
+ * Chave da configuração legada da grade.
4240
4681
  */
4241
4682
  "gridLegacyConfigName"?: string;
4242
4683
  /**
4243
- * Determina se a grade está vinculada a um detalhe.
4684
+ * Determina se a grade está vinculada a um detalhe de outra tela.
4244
4685
  */
4245
4686
  "isDetail"?: boolean;
4246
4687
  /**
@@ -4248,15 +4689,17 @@ declare namespace LocalJSX {
4248
4689
  */
4249
4690
  "messagesBuilder"?: SnkMessageBuilder;
4250
4691
  /**
4251
- * Habilita a edição de múltiplos registros simultâneos.
4692
+ * Habilita a edição de múltiplos registros simultaneamente.
4252
4693
  */
4253
4694
  "multipleEditionEnabled"?: boolean;
4254
4695
  /**
4255
- * Determina se pode haver mais de uma linha selecionada.
4696
+ * Determina se a seleção de múltiplas linhas é permitida.
4256
4697
  */
4257
4698
  "multipleSelection"?: boolean;
4258
4699
  /**
4259
- * Emitido sempre que houver click de botão ou ação.
4700
+ * Emitido ao clicar em um botão de ação ou item de menu.
4701
+ * @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.
4702
+ * @param detail - O identificador da ação clicada, que pode ser usado para determinar qual ação executar.
4260
4703
  */
4261
4704
  "onActionClick"?: (event: SnkGridCustomEvent<string>) => void;
4262
4705
  /**
@@ -4264,67 +4707,74 @@ declare namespace LocalJSX {
4264
4707
  */
4265
4708
  "onComponentReady"?: (event: SnkGridCustomEvent<void>) => void;
4266
4709
  /**
4267
- * Emitido sempre que houver duplo click na grade.
4710
+ * Emitido ao realizar um duplo clique em uma linha da grade.
4711
+ * @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.
4712
+ * @param detail - Detalhes do evento, contendo a linha clicada.
4268
4713
  */
4269
4714
  "onGridDoubleClick"?: (event: SnkGridCustomEvent<any>) => void;
4270
4715
  /**
4271
- * Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
4716
+ * 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
4717
  */
4273
4718
  "outlineMode"?: boolean;
4274
4719
  /**
4275
- * Define se a grid será focada ao ser carregada.
4720
+ * Define o modo de exibição do contador de paginação.
4276
4721
  */
4277
4722
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
4278
4723
  /**
4279
- * Altera o modo de apresentação dos botões do snk-taskbar.
4724
+ * Altera o modo de apresentação dos botões do `snk-taskbar`.
4280
4725
  */
4281
4726
  "presentationMode"?: PresentationMode1;
4282
4727
  /**
4283
- * Validador responsável por checar a integridade das informações do registro.
4728
+ * Validador responsável por verificar a integridade dos dados de um registro.
4284
4729
  */
4285
4730
  "recordsValidator"?: IRecordValidator;
4286
4731
  /**
4287
- * Identificador de recursos como configurações e acesso.
4732
+ * Identificador de recursos, como configurações e permissões de acesso.
4288
4733
  */
4289
4734
  "resourceID"?: string;
4290
4735
  /**
4291
- * Configuração da seleção de grade no toast.
4736
+ * Configuração do toast de seleção da grade.
4292
4737
  */
4293
4738
  "selectionToastConfig"?: ISelectionToastConfig;
4294
4739
  /**
4295
- * Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
4740
+ * Define a configuração de cores para a coluna de status.
4741
+ * @example ```json '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' ```
4296
4742
  */
4297
4743
  "statusResolver"?: IStatusResolver | StatusResolverFunction;
4298
4744
  /**
4299
- * Modo de exportação dos dados.
4745
+ * Define o modo de exportação dos dados.
4300
4746
  */
4301
4747
  "strategyExporter"?: IExporterStrategyMode;
4302
4748
  /**
4303
- * Informa se a coluna de chechbox deve ser suprimida
4749
+ * Informa se a coluna de checkbox deve ser suprimida.
4304
4750
  */
4305
4751
  "suppressCheckboxColumn"?: boolean;
4306
4752
  /**
4307
- * Define se a grade deve suprimir o scroll horizontal.
4753
+ * Informa se a grade deve suprimir o filtro de coluna.
4754
+ */
4755
+ "suppressFilterColumn"?: boolean;
4756
+ /**
4757
+ * Define se a grade deve suprimir a barra de rolagem horizontal.
4308
4758
  */
4309
4759
  "suppressHorizontalScroll"?: boolean;
4310
4760
  /**
4311
- * Define o identificador do container de elementos customizados da Taskbar.
4761
+ * Define o identificador do contêiner de elementos customizados da `Taskbar`.
4312
4762
  */
4313
4763
  "taskbarCustomContainerId"?: string;
4314
4764
  /**
4315
- * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
4765
+ * Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões.
4316
4766
  */
4317
4767
  "taskbarManager"?: TaskbarManager;
4318
4768
  /**
4319
- * Nome do slot de elementos customizados da Taskbar principal do componente.
4769
+ * Define o nome do slot para elementos customizados na `Taskbar` principal do componente.
4320
4770
  */
4321
4771
  "topTaskbarCustomSlotId"?: string;
4322
4772
  /**
4323
- * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
4773
+ * Quando `true`, a tecla ENTER navega entre as células como a tecla TAB.
4324
4774
  */
4325
4775
  "useEnterLikeTab"?: boolean;
4326
4776
  /**
4327
- * Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F
4777
+ * Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`.
4328
4778
  */
4329
4779
  "useSearchColumn"?: boolean;
4330
4780
  }
@@ -4453,30 +4903,49 @@ declare namespace LocalJSX {
4453
4903
  }
4454
4904
  interface SnkPersonalizedFilter {
4455
4905
  /**
4456
- * Nome da configuração. Serve para distinguir várias instâncias do componente.
4906
+ * Nome da configuração, utilizado para distinguir múltiplas instâncias do componente.
4907
+ * @property
4457
4908
  */
4458
4909
  "configName"?: string;
4459
4910
  /**
4460
- * Responsável por receber a URI da entidade.
4911
+ * URI da entidade utilizada para buscar os campos disponíveis para filtro.
4912
+ * @property
4461
4913
  */
4462
4914
  "entityUri"?: string;
4463
4915
  /**
4464
- * Id do filtro que será carregado.
4916
+ * Identificador do filtro a ser carregado.
4917
+ * @property
4465
4918
  */
4466
4919
  "filterId"?: string;
4467
4920
  /**
4468
- * Define se o filtro em questão é um filtro padrão.
4921
+ * Indica se o filtro é o filtro padrão do sistema.
4922
+ * @property
4923
+ * @default false
4469
4924
  */
4470
4925
  "isDefaultFilter"?: boolean;
4471
4926
  /**
4472
4927
  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4928
+ * @property
4473
4929
  */
4474
4930
  "messagesBuilder"?: SnkMessageBuilder;
4931
+ /**
4932
+ * Evento emitido após salvar as alterações do filtro personalizado.
4933
+ * @event
4934
+ */
4475
4935
  "onEzAfterSave"?: (event: SnkPersonalizedFilterCustomEvent<void>) => void;
4936
+ /**
4937
+ * Evento emitido ao cancelar a personalização do filtro.
4938
+ * @event
4939
+ */
4476
4940
  "onEzCancel"?: (event: SnkPersonalizedFilterCustomEvent<void>) => void;
4941
+ /**
4942
+ * Evento emitido ao salvar as alterações do filtro personalizado.
4943
+ * @event
4944
+ */
4477
4945
  "onEzSave"?: (event: SnkPersonalizedFilterCustomEvent<string>) => void;
4478
4946
  /**
4479
- * Nome da configuração. Serve para distinguir várias instâncias do componente.
4947
+ * Identificador do recurso utilizado para salvar e recuperar filtros.
4948
+ * @property
4480
4949
  */
4481
4950
  "resourceID"?: string;
4482
4951
  }
@@ -4507,31 +4976,53 @@ declare namespace LocalJSX {
4507
4976
  }
4508
4977
  interface SnkPesquisa {
4509
4978
  /**
4510
- * Define se permite seleção de items não analíticos
4979
+ * Define se permite a seleção de itens não analíticos.
4980
+ * @type {boolean}
4981
+ * @default false
4982
+ * @example allowsNonAnalytic={true}
4511
4983
  */
4512
4984
  "allowsNonAnalytic"?: boolean;
4513
4985
  /**
4514
- * Argumentos que serão usados ao chamar a função searchLoader.
4986
+ * Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente.
4987
+ * @type {string}
4988
+ * @mutable
4989
+ * @example argument="Texto para pesquisa"
4515
4990
  */
4516
4991
  "argument"?: string;
4517
4992
  /**
4518
- * Nome da entidade onde a pesquisa é aplicada.
4993
+ * Nome da entidade sobre a qual a pesquisa será realizada.
4994
+ * @type {string}
4995
+ * @example entityName="Produto"
4519
4996
  */
4520
4997
  "entityName"?: string;
4521
4998
  /**
4522
- * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
4999
+ * Define se a popup de pesquisa terá ou não modo hierárquico.
5000
+ * @type {boolean}
5001
+ * @default false
5002
+ * @example isHierarchyEntity={true}
4523
5003
  */
4524
5004
  "isHierarchyEntity"?: boolean;
4525
5005
  /**
4526
- * Função responsável em carregar os itens do componente snk-pesquisa.
5006
+ * Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados.
5007
+ * @type {(text: string) => Promise<any>}
5008
+ * @param text Texto utilizado como argumento de pesquisa.
5009
+ * @returns Promise com os dados da pesquisa.
5010
+ * @example searchLoader={(text) => fetchItems(text)}
4527
5011
  */
4528
5012
  "searchLoader"?: (text: string) => Promise<any>;
4529
5013
  /**
4530
- * Função disparada ao selecionar um item.
5014
+ * Função disparada ao selecionar um item da pesquisa.
5015
+ * @type {(option: IOption) => void}
5016
+ * @param option Item selecionado.
5017
+ * @returns void
5018
+ * @example selectItem={(option) => handleSelect(option)}
4531
5019
  */
4532
5020
  "selectItem"?: (option: IOption2) => void;
4533
5021
  /**
4534
- * Função responsável por carregar a árvore hierárquica do componente
5022
+ * Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível.
5023
+ * @type {(text: string) => Promise<any>}
5024
+ * @param text Texto utilizado como argumento de pesquisa para a árvore.
5025
+ * @returns Promise com os dados da árvore.
4535
5026
  */
4536
5027
  "treeLoader"?: (text: string) => Promise<any>;
4537
5028
  }
@@ -4553,11 +5044,11 @@ declare namespace LocalJSX {
4553
5044
  }
4554
5045
  interface SnkSimpleBar {
4555
5046
  /**
4556
- * Define os itens que serão apresentados pelo breadcrumb
5047
+ * Define os itens que serão apresentados no breadcrumb.
4557
5048
  */
4558
5049
  "breadcrumbItens"?: Array<IBreadcrumbItem>;
4559
5050
  /**
4560
- * Define o título do header
5051
+ * Define o título do header.
4561
5052
  */
4562
5053
  "label"?: string;
4563
5054
  /**
@@ -4565,136 +5056,157 @@ declare namespace LocalJSX {
4565
5056
  */
4566
5057
  "messagesBuilder"?: SnkMessageBuilder;
4567
5058
  /**
4568
- * Emitido quando algum item do breadcrumb é clicado
5059
+ * Emitido quando algum item do breadcrumb é clicado.
4569
5060
  */
4570
5061
  "onClickBreadcrumbItem"?: (event: SnkSimpleBarCustomEvent<IBreadcrumbItem>) => void;
4571
5062
  /**
4572
- * Emitido quando o botão voltar é acionado
5063
+ * Emitido quando o botão "voltar" é acionado.
4573
5064
  */
4574
5065
  "onExit"?: (event: SnkSimpleBarCustomEvent<void>) => void;
4575
5066
  }
4576
5067
  interface SnkSimpleCrud {
4577
5068
  /**
4578
- * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
5069
+ * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
4579
5070
  */
4580
5071
  "actionsList"?: Array<Action>;
4581
5072
  /**
4582
- * Define se a grid será focada ao ser carregada.
5073
+ * @description Define se a grade será focada ao ser carregada.
4583
5074
  */
4584
5075
  "autoFocus"?: boolean;
4585
5076
  /**
4586
- * Define se a carga dos dados será feita assim que o componente for carregado.
5077
+ * @description Define se a carga dos dados será feita assim que o componente for carregado.
4587
5078
  */
4588
5079
  "autoLoad"?: boolean;
4589
5080
  /**
4590
- * Usado para salvar as configurações dos blocos de construção.
5081
+ * @description Usado para salvar as configurações dos blocos de construção.
4591
5082
  */
4592
5083
  "configName"?: string;
5084
+ /**
5085
+ * @description Estado atual dos dados.
5086
+ */
4593
5087
  "dataState"?: DataState1;
5088
+ /**
5089
+ * @description Instância do DataUnit a ser utilizada pelo componente.
5090
+ */
4594
5091
  "dataUnit"?: DataUnit;
4595
5092
  /**
4596
- * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
5093
+ * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade).
4597
5094
  */
4598
5095
  "domainMessagesBuilder"?: string;
5096
+ /**
5097
+ * @description Habilita a inserção contínua de registros.
5098
+ */
4599
5099
  "enableContinuousInsert"?: boolean;
4600
5100
  /**
4601
- * Ativa inserção de registros no modo grade.
5101
+ * @description Ativa a inserção de registros no modo grade.
4602
5102
  */
4603
5103
  "enableGridInsert"?: boolean;
4604
5104
  /**
4605
- * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
5105
+ * @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
4606
5106
  */
4607
5107
  "enableLockManagerLoadingComp"?: boolean;
4608
5108
  /**
4609
- * Ativa o gerenciamento de locks na grade pela Taskbar.
5109
+ * @description Ativa o gerenciamento de locks na grade pela Taskbar.
4610
5110
  */
4611
5111
  "enableLockManagerTaskbarClick"?: boolean;
4612
5112
  /**
4613
- * Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD
5113
+ * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD.
4614
5114
  */
4615
5115
  "entityName"?: string;
5116
+ /**
5117
+ * @description Configuração do formulário.
5118
+ */
4616
5119
  "formConfig"?: IFormConfig;
4617
5120
  /**
4618
- * Chave da configuração legado do formulário.
5121
+ * @description Chave da configuração legada do formulário.
4619
5122
  */
4620
5123
  "formLegacyConfigName"?: string;
5124
+ /**
5125
+ * @description Configuração da grade.
5126
+ */
4621
5127
  "gridConfig"?: IGridConfig;
4622
5128
  /**
4623
- * Chave da configuração legado da grade.
5129
+ * @description Chave da configuração legada da grade.
4624
5130
  */
4625
5131
  "gridLegacyConfigName"?: string;
4626
5132
  /**
4627
- * Ignora os campos "somente leitura" no modo de inserção.
5133
+ * @description Ignora os campos "somente leitura" no modo de inserção.
4628
5134
  */
4629
5135
  "ignoreReadOnlyFormFields"?: boolean;
4630
5136
  /**
4631
- * Define se o LayoutFormConfig será exibido no configurador.
5137
+ * @description Define se o LayoutFormConfig será exibido no configurador.
4632
5138
  */
4633
5139
  "layoutFormConfig"?: boolean;
4634
5140
  /**
4635
- * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
5141
+ * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4636
5142
  */
4637
5143
  "messagesBuilder"?: SnkMessageBuilder;
5144
+ /**
5145
+ * @description Define o modo de operação do CRUD (servidor ou em memória).
5146
+ */
4638
5147
  "mode"?: SIMPLE_CRUD_MODE;
4639
5148
  /**
4640
- * Habilita a edição de múltiplos registros simultâneos.
5149
+ * @description Habilita a edição de múltiplos registros simultâneos.
4641
5150
  */
4642
5151
  "multipleEditionEnabled"?: boolean;
4643
5152
  /**
4644
- * Determina se pode haver mais de uma linha selecionada na grade.
5153
+ * @description Determina se pode haver mais de uma linha selecionada na grade.
4645
5154
  */
4646
5155
  "multipleSelection"?: boolean;
4647
5156
  /**
4648
- * Emitido sempre que houver click de botão ou ação.
5157
+ * @description Emitido sempre que houver clique de botão ou ação na barra de tarefas.
4649
5158
  */
4650
5159
  "onActionClick"?: (event: SnkSimpleCrudCustomEvent<string>) => void;
4651
5160
  /**
4652
- * Emitido quando cancela o salvamento da configuração no configurator do CRUD.
5161
+ * @description Emitido quando o salvamento da configuração no configurador do CRUD é cancelado.
4653
5162
  */
4654
5163
  "onConfiguratorCancel"?: (event: SnkSimpleCrudCustomEvent<any>) => void;
4655
5164
  /**
4656
- * Emitido quando salva a configuração no configurator do CRUD.
5165
+ * @description Emitido quando a configuração no configurador do CRUD é salva.
4657
5166
  */
4658
5167
  "onConfiguratorSave"?: (event: SnkSimpleCrudCustomEvent<any>) => void;
4659
5168
  /**
4660
- * Emitido quando há qualquer mudança de estado no DataUnit.
5169
+ * @description Emitido quando há qualquer mudança de estado no DataUnit.
4661
5170
  */
4662
5171
  "onDataStateChange"?: (event: SnkSimpleCrudCustomEvent<DataState1>) => void;
4663
5172
  /**
4664
- * Emitido quando o DataUnit está pronto.
5173
+ * @description Emitido quando o DataUnit está pronto.
4665
5174
  */
4666
5175
  "onDataUnitReady"?: (event: SnkSimpleCrudCustomEvent<DataUnit>) => void;
4667
5176
  /**
4668
- * Responsável por notificar quando ocorrer a renderização de itens do formulário.
5177
+ * @description Responsável por notificar quando ocorrer a renderização de itens do formulário.
4669
5178
  */
4670
5179
  "onFormItemsReady"?: (event: SnkSimpleCrudCustomEvent<Array<HTMLElement>>) => void;
4671
5180
  /**
4672
- * Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
5181
+ * @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).
4673
5182
  */
4674
5183
  "outlineMode"?: boolean;
4675
5184
  /**
4676
- * Determina quantas linhas são retornadas por página.
5185
+ * @description Determina quantas linhas são retornadas por página.
4677
5186
  */
4678
5187
  "pageSize"?: number;
4679
5188
  /**
4680
- * Define se a grid será focada ao ser carregada.
5189
+ * @description Define o modo de exibição do contador de paginação.
4681
5190
  */
4682
5191
  "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
4683
5192
  /**
4684
- * Identificador de recursos como configurações e acesso.
5193
+ * @description Identificador de recursos como configurações e acesso.
4685
5194
  */
4686
5195
  "resourceID"?: string;
4687
5196
  /**
4688
- * Usado para exibir os botões de ação do snk-configurator.
5197
+ * @description Usado para exibir os botões de ação do snk-configurator.
4689
5198
  */
4690
5199
  "showConfiguratorButtons"?: boolean;
4691
5200
  /**
4692
- * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
5201
+ * @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
4693
5202
  */
4694
5203
  "taskbarManager"?: TaskbarManager;
5204
+ /**
5205
+ * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
5206
+ */
4695
5207
  "useCancelConfirm"?: boolean;
4696
5208
  /**
4697
- * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
5209
+ * @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
4698
5210
  */
4699
5211
  "useEnterLikeTab"?: boolean;
4700
5212
  }
@@ -4715,75 +5227,79 @@ declare namespace LocalJSX {
4715
5227
  }
4716
5228
  interface SnkTaskbar {
4717
5229
  /**
4718
- * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
5230
+ * @description Lista de ações a serem exibidas no botão "Mais opções".
4719
5231
  */
4720
5232
  "actionsList"?: Array<Action>;
4721
5233
  /**
4722
- * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
5234
+ * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
4723
5235
  */
4724
5236
  "actionsSettingsList"?: Array<Action>;
4725
5237
  /**
4726
- * Usado para determinar O alinhamento dos items na taskbar.
5238
+ * @description Define o alinhamento dos itens da barra de tarefas à direita.
4727
5239
  */
4728
5240
  "alignRigth"?: boolean;
4729
5241
  /**
4730
- * Lista separada por virgula, contendo todos os elementos a serem criados.
5242
+ * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas.
4731
5243
  */
4732
5244
  "buttons"?: string;
4733
5245
  /**
4734
- * Usado para guardar ou recuperar as configurações do formulário.
5246
+ * @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.
4735
5247
  */
4736
5248
  "configName"?: string;
4737
5249
  /**
4738
- * Mapa com definição de botões personalizados. A chave do mapa deve ser passada na lista "buttons" no lugar onde o botão irá aparecer.
5250
+ * @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.
4739
5251
  */
4740
5252
  "customButtons"?: Map<string, CustomButton>;
4741
5253
  /**
4742
- * Usado para determinar o identificador do container na DOM que é responsavel por guardar os elementos personalizados que não podem ser passados por slot. Exemplo: Elementos customizados na Taskbar da aba de detalhes.
5254
+ * @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.
5255
+ * @example Elementos customizados na Taskbar da aba de detalhes.
4743
5256
  */
4744
5257
  "customContainerId"?: string;
4745
5258
  /**
4746
- * Usado para determinar o identificador do slot que recebe elementos personalizados.
5259
+ * @description Define o identificador do slot que recebe elementos personalizados.
4747
5260
  */
4748
5261
  "customSlotId"?: string;
4749
5262
  /**
4750
- * Instância do DataUnit.
5263
+ * @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).
4751
5264
  */
4752
5265
  "dataUnit"?: DataUnit;
4753
5266
  /**
4754
- * Array contendo todos os botões a serem desabilitados.
5267
+ * @description Array contendo os identificadores de todos os botões que devem ser desabilitados.
4755
5268
  */
4756
5269
  "disabledButtons"?: Array<string>;
4757
5270
  /**
4758
- * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
5271
+ * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
4759
5272
  */
4760
5273
  "messagesBuilder"?: SnkMessageBuilder;
4761
5274
  /**
4762
- * Emitido sempre que houver click de botão ou ação.
5275
+ * @description Emitido sempre que um botão ou uma ação da barra de tarefas é clicado.
5276
+ * @eventProperty
4763
5277
  */
4764
5278
  "onActionClick"?: (event: SnkTaskbarCustomEvent<string>) => void;
4765
5279
  /**
4766
- * Emitido sempre que um save é iniciado pela taskbar.
5280
+ * @description Emitido quando uma ação de salvar é iniciada pela barra de tarefas, indicando um estado de bloqueio para evitar ações concorrentes.
5281
+ * @eventProperty
4767
5282
  */
4768
5283
  "onTaskbarSaveLocker"?: (event: SnkTaskbarCustomEvent<void>) => void;
4769
5284
  /**
4770
- * Emitido sempre que o ocorre alguma action que libera o save.
5285
+ * @description Emitido quando a ação de salvar é concluída ou cancelada, liberando o estado de bloqueio.
5286
+ * @eventProperty
4771
5287
  */
4772
5288
  "onTaskbarSaveUnlocker"?: (event: SnkTaskbarCustomEvent<void>) => void;
4773
5289
  /**
4774
- * Define como será o comportamento da taskbar quando ocorrer overflow
5290
+ * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens.
4775
5291
  */
4776
5292
  "overflowStrategy"?: 'hiddenItems' | 'none';
4777
5293
  /**
4778
- * Altera o modo de apresentação dos botões do snk-taskbar.
5294
+ * @description Altera o modo de apresentação dos botões da barra de tarefas.
4779
5295
  */
4780
5296
  "presentationMode"?: PresentationMode1;
4781
5297
  /**
4782
- * Determina qual botão deve ter aparência primária.
5298
+ * @description Define qual botão deve ter a aparência de destaque (primário).
4783
5299
  */
4784
5300
  "primaryButton"?: string;
4785
5301
  /**
4786
- * Identificador de recursos como configurações e acesso.
5302
+ * @description Identificador de recursos, como configurações e permissões de acesso.
4787
5303
  */
4788
5304
  "resourceID"?: string;
4789
5305
  }