@bryntum/grid-vue-3 7.3.0 → 7.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (245) hide show
  1. package/lib/chunks/{CDlTquLg.js → 0G3BOxn8.js} +9 -7
  2. package/lib/chunks/0G3BOxn8.js.map +1 -0
  3. package/lib/chunks/0gtq8Dk3.js.map +1 -1
  4. package/lib/chunks/1RZB5Yja.js.map +1 -1
  5. package/lib/chunks/2JP2ap14.js.map +1 -1
  6. package/lib/chunks/B9Ym-jRB.js.map +1 -1
  7. package/lib/chunks/B9qIhgk1.js.map +1 -1
  8. package/lib/chunks/{DiZmRX6M.js → BAaaUhdy.js} +6 -4
  9. package/lib/chunks/BAaaUhdy.js.map +1 -0
  10. package/lib/chunks/{D6pNVhVB.js → BArALprx.js} +11 -9
  11. package/lib/chunks/BArALprx.js.map +1 -0
  12. package/lib/chunks/BC_xvNJq.js.map +1 -1
  13. package/lib/chunks/{B-xu7l3m.js → BFLoNIuF.js} +10 -8
  14. package/lib/chunks/BFLoNIuF.js.map +1 -0
  15. package/lib/chunks/BK5CVUgh.js.map +1 -1
  16. package/lib/chunks/BQUiHybJ.js.map +1 -1
  17. package/lib/chunks/BWIgghsj.js.map +1 -1
  18. package/lib/chunks/{BF1rPMcu.js → BWT4Mdsw.js} +10 -8
  19. package/lib/chunks/BWT4Mdsw.js.map +1 -0
  20. package/lib/chunks/{DTUe-lyS.js → BX4HI-q4.js} +12 -10
  21. package/lib/chunks/BX4HI-q4.js.map +1 -0
  22. package/lib/chunks/BZdz0l_5.js.map +1 -1
  23. package/lib/chunks/{BpR2lUkV.js → B_2BdFBO.js} +9 -7
  24. package/lib/chunks/B_2BdFBO.js.map +1 -0
  25. package/lib/chunks/Bfj8ZUAm.js.map +1 -1
  26. package/lib/chunks/{bLebs42H.js → BhfZhJQ4.js} +5 -3
  27. package/lib/chunks/BhfZhJQ4.js.map +1 -0
  28. package/lib/chunks/BoUkRqVY.js.map +1 -1
  29. package/lib/chunks/{NkF4pTV7.js → C-KNXud_.js} +9 -7
  30. package/lib/chunks/C-KNXud_.js.map +1 -0
  31. package/lib/chunks/C2x-tjJx.js.map +1 -1
  32. package/lib/chunks/{D94FCXrL.js → C3q04kPS.js} +9 -7
  33. package/lib/chunks/C3q04kPS.js.map +1 -0
  34. package/lib/chunks/C9YGIUax.js.map +1 -1
  35. package/lib/chunks/CC_mnQeM.js.map +1 -1
  36. package/lib/chunks/CKihfOVz.js.map +1 -1
  37. package/lib/chunks/{BMTMMdaC.js → CLRX9ie2.js} +11 -9
  38. package/lib/chunks/CLRX9ie2.js.map +1 -0
  39. package/lib/chunks/COI8HIJL.js.map +1 -1
  40. package/lib/chunks/COs57ih1.js.map +1 -1
  41. package/lib/chunks/CQUmcVHy.js.map +1 -1
  42. package/lib/chunks/CeJ19ncI.js.map +1 -1
  43. package/lib/chunks/CnUfgMxC.js.map +1 -1
  44. package/lib/chunks/{Cex7HFh5.js → CnvevsBu.js} +9 -7
  45. package/lib/chunks/CnvevsBu.js.map +1 -0
  46. package/lib/chunks/{Byhp0Mwy.js → CoXntcPO.js} +7 -5
  47. package/lib/chunks/CoXntcPO.js.map +1 -0
  48. package/lib/chunks/{xIdoI0po.js → Cs5IYq5I.js} +9 -7
  49. package/lib/chunks/Cs5IYq5I.js.map +1 -0
  50. package/lib/chunks/D2GsXOvn.js.map +1 -1
  51. package/lib/chunks/D4Cy-qFk.js.map +1 -1
  52. package/lib/chunks/{Ccul2l2v.js → D7f0nsko.js} +6 -4
  53. package/lib/chunks/D7f0nsko.js.map +1 -0
  54. package/lib/chunks/DCg2fWiq.js.map +1 -1
  55. package/lib/chunks/{CBRW321y.js → DE5aChZi.js} +14 -12
  56. package/lib/chunks/DE5aChZi.js.map +1 -0
  57. package/lib/chunks/DRVjD9iN.js.map +1 -1
  58. package/lib/chunks/{DayQ7Rlb.js → DSedBrt_.js} +13 -11
  59. package/lib/chunks/DSedBrt_.js.map +1 -0
  60. package/lib/chunks/D_rLSr8Y.js.map +1 -1
  61. package/lib/chunks/{BwuvAbW5.js → DbEgVOs1.js} +7 -5
  62. package/lib/chunks/DbEgVOs1.js.map +1 -0
  63. package/lib/chunks/{DTH08WC2.js → DhhewFEv.js} +9 -7
  64. package/lib/chunks/DhhewFEv.js.map +1 -0
  65. package/lib/chunks/Dm-Ds5Fs.js.map +1 -1
  66. package/lib/chunks/Dm8ipdVr.js.map +1 -1
  67. package/lib/chunks/DskRZNvv.js.map +1 -1
  68. package/lib/chunks/PT41l8zv.js.map +1 -1
  69. package/lib/chunks/{D61dAL1b.js → TMpK4xg3.js} +12 -10
  70. package/lib/chunks/TMpK4xg3.js.map +1 -0
  71. package/lib/chunks/UkUlfQx6.js.map +1 -1
  72. package/lib/chunks/cmj1-s1q.js.map +1 -1
  73. package/lib/chunks/gboR1LQ7.js.map +1 -1
  74. package/lib/chunks/jla7jldm.js.map +1 -1
  75. package/lib/chunks/{B711lzqw.js → n-bko5m2.js} +11 -9
  76. package/lib/chunks/n-bko5m2.js.map +1 -0
  77. package/lib/chunks/n4K19P1t.js.map +1 -1
  78. package/lib/chunks/{BkSzOi0v.js → oOR_enaE.js} +9 -7
  79. package/lib/chunks/oOR_enaE.js.map +1 -0
  80. package/lib/chunks/pP8iMzIE.js.map +1 -1
  81. package/lib/chunks/s-g3r5g2.js.map +1 -1
  82. package/lib/components/BryntumAIFilterField.js +1 -1
  83. package/lib/components/BryntumBooleanCombo.js +1 -1
  84. package/lib/components/BryntumCheckbox.js +1 -1
  85. package/lib/components/BryntumChecklistFilterCombo.js +1 -1
  86. package/lib/components/BryntumColorField.js +1 -1
  87. package/lib/components/BryntumCombo.js +1 -1
  88. package/lib/components/BryntumDateField.js +1 -1
  89. package/lib/components/BryntumDateRangeField.js +1 -1
  90. package/lib/components/BryntumDateTimeField.js +1 -1
  91. package/lib/components/BryntumDisplayField.js +1 -1
  92. package/lib/components/BryntumDurationField.js +1 -1
  93. package/lib/components/BryntumFileField.js +1 -1
  94. package/lib/components/BryntumFilterField.js +1 -1
  95. package/lib/components/BryntumNumberField.js +1 -1
  96. package/lib/components/BryntumPasswordField.js +1 -1
  97. package/lib/components/BryntumRadio.js +1 -1
  98. package/lib/components/BryntumSlideToggle.js +1 -1
  99. package/lib/components/BryntumTextAreaField.js +1 -1
  100. package/lib/components/BryntumTextAreaPickerField.js +1 -1
  101. package/lib/components/BryntumTextField.js +1 -1
  102. package/lib/components/BryntumTimeField.js +1 -1
  103. package/lib/components/BryntumTreeCombo.js +1 -1
  104. package/lib/index.js +22 -22
  105. package/package.json +1 -1
  106. package/src/components/BryntumAIFilterField.vue +17 -1
  107. package/src/components/BryntumAIFilterFieldProps.ts +15 -0
  108. package/src/components/BryntumBooleanCombo.vue +17 -1
  109. package/src/components/BryntumBooleanComboProps.ts +15 -0
  110. package/src/components/BryntumButton.vue +9 -3
  111. package/src/components/BryntumButtonGroup.vue +7 -1
  112. package/src/components/BryntumButtonGroupProps.ts +6 -0
  113. package/src/components/BryntumButtonProps.ts +6 -0
  114. package/src/components/BryntumChatPanel.vue +9 -3
  115. package/src/components/BryntumChatPanelProps.ts +6 -0
  116. package/src/components/BryntumCheckbox.vue +18 -2
  117. package/src/components/BryntumCheckboxGroup.vue +9 -3
  118. package/src/components/BryntumCheckboxGroupProps.ts +6 -0
  119. package/src/components/BryntumCheckboxProps.ts +15 -0
  120. package/src/components/BryntumChecklistFilterCombo.vue +17 -1
  121. package/src/components/BryntumChecklistFilterComboProps.ts +15 -0
  122. package/src/components/BryntumChipView.vue +11 -3
  123. package/src/components/BryntumChipViewProps.ts +9 -1
  124. package/src/components/BryntumCodeEditor.vue +9 -3
  125. package/src/components/BryntumCodeEditorProps.ts +6 -0
  126. package/src/components/BryntumColorField.vue +17 -1
  127. package/src/components/BryntumColorFieldProps.ts +15 -0
  128. package/src/components/BryntumCombo.vue +17 -1
  129. package/src/components/BryntumComboProps.ts +15 -0
  130. package/src/components/BryntumContainer.vue +7 -1
  131. package/src/components/BryntumContainerProps.ts +6 -0
  132. package/src/components/BryntumDateField.vue +17 -1
  133. package/src/components/BryntumDateFieldProps.ts +15 -0
  134. package/src/components/BryntumDatePicker.vue +9 -3
  135. package/src/components/BryntumDatePickerProps.ts +6 -0
  136. package/src/components/BryntumDateRangeField.vue +17 -1
  137. package/src/components/BryntumDateRangeFieldProps.ts +15 -0
  138. package/src/components/BryntumDateTimeField.vue +17 -1
  139. package/src/components/BryntumDateTimeFieldProps.ts +15 -0
  140. package/src/components/BryntumDemoCodeEditor.vue +9 -3
  141. package/src/components/BryntumDemoCodeEditorProps.ts +6 -0
  142. package/src/components/BryntumDisplayField.vue +17 -1
  143. package/src/components/BryntumDisplayFieldProps.ts +15 -0
  144. package/src/components/BryntumDurationField.vue +17 -1
  145. package/src/components/BryntumDurationFieldProps.ts +15 -0
  146. package/src/components/BryntumEditor.vue +11 -5
  147. package/src/components/BryntumEditorProps.ts +6 -0
  148. package/src/components/BryntumFieldFilterPicker.vue +7 -1
  149. package/src/components/BryntumFieldFilterPickerGroup.vue +8 -2
  150. package/src/components/BryntumFieldFilterPickerGroupProps.ts +6 -0
  151. package/src/components/BryntumFieldFilterPickerProps.ts +6 -0
  152. package/src/components/BryntumFieldSet.vue +9 -3
  153. package/src/components/BryntumFieldSetProps.ts +6 -0
  154. package/src/components/BryntumFileField.vue +17 -1
  155. package/src/components/BryntumFileFieldProps.ts +15 -0
  156. package/src/components/BryntumFilePicker.vue +7 -1
  157. package/src/components/BryntumFilePickerProps.ts +6 -0
  158. package/src/components/BryntumFilterField.vue +17 -1
  159. package/src/components/BryntumFilterFieldProps.ts +15 -0
  160. package/src/components/BryntumGrid.vue +31 -25
  161. package/src/components/BryntumGridBase.vue +31 -25
  162. package/src/components/BryntumGridBaseProps.ts +6 -0
  163. package/src/components/BryntumGridChartDesigner.vue +7 -1
  164. package/src/components/BryntumGridChartDesignerProps.ts +6 -0
  165. package/src/components/BryntumGridFieldFilterPicker.vue +7 -1
  166. package/src/components/BryntumGridFieldFilterPickerGroup.vue +8 -2
  167. package/src/components/BryntumGridFieldFilterPickerGroupProps.ts +6 -0
  168. package/src/components/BryntumGridFieldFilterPickerProps.ts +6 -0
  169. package/src/components/BryntumGridProps.ts +6 -0
  170. package/src/components/BryntumGroupBar.vue +11 -3
  171. package/src/components/BryntumGroupBarProps.ts +9 -1
  172. package/src/components/BryntumHint.vue +9 -3
  173. package/src/components/BryntumHintProps.ts +6 -0
  174. package/src/components/BryntumLabel.vue +7 -1
  175. package/src/components/BryntumLabelProps.ts +6 -0
  176. package/src/components/BryntumList.vue +8 -2
  177. package/src/components/BryntumListProps.ts +6 -0
  178. package/src/components/BryntumMenu.vue +9 -3
  179. package/src/components/BryntumMenuProps.ts +6 -0
  180. package/src/components/BryntumMonthPicker.vue +9 -3
  181. package/src/components/BryntumMonthPickerProps.ts +6 -0
  182. package/src/components/BryntumNumberField.vue +17 -1
  183. package/src/components/BryntumNumberFieldProps.ts +15 -0
  184. package/src/components/BryntumPagingToolbar.vue +8 -2
  185. package/src/components/BryntumPagingToolbarProps.ts +6 -0
  186. package/src/components/BryntumPanel.vue +9 -3
  187. package/src/components/BryntumPanelProps.ts +6 -0
  188. package/src/components/BryntumPasswordField.vue +17 -1
  189. package/src/components/BryntumPasswordFieldProps.ts +15 -0
  190. package/src/components/BryntumProgressBar.vue +7 -1
  191. package/src/components/BryntumProgressBarProps.ts +6 -0
  192. package/src/components/BryntumRadio.vue +18 -2
  193. package/src/components/BryntumRadioGroup.vue +9 -3
  194. package/src/components/BryntumRadioGroupProps.ts +6 -0
  195. package/src/components/BryntumRadioProps.ts +15 -0
  196. package/src/components/BryntumSlideToggle.vue +18 -2
  197. package/src/components/BryntumSlideToggleProps.ts +15 -0
  198. package/src/components/BryntumSlider.vue +7 -1
  199. package/src/components/BryntumSliderProps.ts +6 -0
  200. package/src/components/BryntumSplitter.vue +7 -1
  201. package/src/components/BryntumSplitterProps.ts +6 -0
  202. package/src/components/BryntumTabPanel.vue +10 -4
  203. package/src/components/BryntumTabPanelProps.ts +6 -0
  204. package/src/components/BryntumTextAreaField.vue +17 -1
  205. package/src/components/BryntumTextAreaFieldProps.ts +15 -0
  206. package/src/components/BryntumTextAreaPickerField.vue +17 -1
  207. package/src/components/BryntumTextAreaPickerFieldProps.ts +15 -0
  208. package/src/components/BryntumTextField.vue +17 -1
  209. package/src/components/BryntumTextFieldProps.ts +15 -0
  210. package/src/components/BryntumTimeField.vue +17 -1
  211. package/src/components/BryntumTimeFieldProps.ts +15 -0
  212. package/src/components/BryntumTimePicker.vue +7 -1
  213. package/src/components/BryntumTimePickerProps.ts +6 -0
  214. package/src/components/BryntumToolbar.vue +8 -2
  215. package/src/components/BryntumToolbarProps.ts +6 -0
  216. package/src/components/BryntumTreeCombo.vue +17 -1
  217. package/src/components/BryntumTreeComboProps.ts +15 -0
  218. package/src/components/BryntumTreeGrid.vue +31 -25
  219. package/src/components/BryntumTreeGridProps.ts +6 -0
  220. package/src/components/BryntumWidget.vue +7 -1
  221. package/src/components/BryntumWidgetProps.ts +6 -0
  222. package/src/components/BryntumYearPicker.vue +9 -3
  223. package/src/components/BryntumYearPickerProps.ts +6 -0
  224. package/lib/chunks/B-xu7l3m.js.map +0 -1
  225. package/lib/chunks/B711lzqw.js.map +0 -1
  226. package/lib/chunks/BF1rPMcu.js.map +0 -1
  227. package/lib/chunks/BMTMMdaC.js.map +0 -1
  228. package/lib/chunks/BkSzOi0v.js.map +0 -1
  229. package/lib/chunks/BpR2lUkV.js.map +0 -1
  230. package/lib/chunks/BwuvAbW5.js.map +0 -1
  231. package/lib/chunks/Byhp0Mwy.js.map +0 -1
  232. package/lib/chunks/CBRW321y.js.map +0 -1
  233. package/lib/chunks/CDlTquLg.js.map +0 -1
  234. package/lib/chunks/Ccul2l2v.js.map +0 -1
  235. package/lib/chunks/Cex7HFh5.js.map +0 -1
  236. package/lib/chunks/D61dAL1b.js.map +0 -1
  237. package/lib/chunks/D6pNVhVB.js.map +0 -1
  238. package/lib/chunks/D94FCXrL.js.map +0 -1
  239. package/lib/chunks/DTH08WC2.js.map +0 -1
  240. package/lib/chunks/DTUe-lyS.js.map +0 -1
  241. package/lib/chunks/DayQ7Rlb.js.map +0 -1
  242. package/lib/chunks/DiZmRX6M.js.map +0 -1
  243. package/lib/chunks/NkF4pTV7.js.map +0 -1
  244. package/lib/chunks/bLebs42H.js.map +0 -1
  245. package/lib/chunks/xIdoI0po.js.map +0 -1
@@ -28,6 +28,8 @@ export declare type BryntumNumberFieldProps = {
28
28
  /**
29
29
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
30
30
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
31
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
32
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-appendTo)
31
33
  */
32
34
  appendTo ? : HTMLElement|string
33
35
  /**
@@ -83,6 +85,15 @@ export declare type BryntumNumberFieldProps = {
83
85
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-changeOnSpin)
84
86
  */
85
87
  changeOnSpin ? : Boolean|number
88
+ /**
89
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
90
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
91
+ * evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
92
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-checkValidity)
93
+ * @param {Core.widget.Field} field The field being validated
94
+ * @returns {void}
95
+ */
96
+ checkValidity ? : ((field: Field) => void)|string
86
97
  /**
87
98
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
88
99
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -295,10 +306,14 @@ export declare type BryntumNumberFieldProps = {
295
306
  inputWidth ? : string|number
296
307
  /**
297
308
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
309
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
310
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-insertBefore)
298
311
  */
299
312
  insertBefore ? : HTMLElement|string
300
313
  /**
301
314
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
315
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
316
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-insertFirst)
302
317
  */
303
318
  insertFirst ? : HTMLElement|string
304
319
  /**
@@ -42,6 +42,8 @@ defineProps<{
42
42
  /**
43
43
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
44
44
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
45
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
46
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-appendTo)
45
47
  */
46
48
  appendTo ? : HTMLElement|string
47
49
  /**
@@ -250,10 +252,14 @@ defineProps<{
250
252
  inputFieldAlign ? : 'start'|'end'
251
253
  /**
252
254
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
255
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
256
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-insertBefore)
253
257
  */
254
258
  insertBefore ? : HTMLElement|string
255
259
  /**
256
260
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
261
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
262
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-insertFirst)
257
263
  */
258
264
  insertFirst ? : HTMLElement|string
259
265
  /**
@@ -575,7 +581,7 @@ const emit = defineEmits<{
575
581
  * @param {object} params.event Event object
576
582
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
577
583
  */
578
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
584
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
579
585
  /**
580
586
  * This event is fired on the owning Toolbar prior to starting a drag gesture. The drag is canceled if
581
587
  * a listener returns `false`.
@@ -586,7 +592,7 @@ const emit = defineEmits<{
586
592
  * @param {Core.widget.Widget} params.event.item The dragged item.
587
593
  * @param {Event} params.event.domEvent The browser event.
588
594
  */
589
- (e: 'beforeItemDragStart', params: ((event: { source: Toolbar, item: Widget, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
595
+ (e: 'beforeItemDragStart', params: ((event: { source: Toolbar, item: Widget, domEvent: Event }) => boolean|void)|string): boolean|void
590
596
  /**
591
597
  * Fired before this container will load record values into its child fields. This is useful if you
592
598
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -28,6 +28,8 @@ export declare type BryntumPagingToolbarProps = {
28
28
  /**
29
29
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
30
30
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
31
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
32
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-appendTo)
31
33
  */
32
34
  appendTo ? : HTMLElement|string
33
35
  /**
@@ -236,10 +238,14 @@ export declare type BryntumPagingToolbarProps = {
236
238
  inputFieldAlign ? : 'start'|'end'
237
239
  /**
238
240
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
241
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
242
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-insertBefore)
239
243
  */
240
244
  insertBefore ? : HTMLElement|string
241
245
  /**
242
246
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
247
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
248
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-insertFirst)
243
249
  */
244
250
  insertFirst ? : HTMLElement|string
245
251
  /**
@@ -42,6 +42,8 @@ defineProps<{
42
42
  /**
43
43
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
44
44
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
45
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
46
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-appendTo)
45
47
  */
46
48
  appendTo ? : HTMLElement|string
47
49
  /**
@@ -299,10 +301,14 @@ defineProps<{
299
301
  inputFieldAlign ? : 'start'|'end'
300
302
  /**
301
303
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
304
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
305
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-insertBefore)
302
306
  */
303
307
  insertBefore ? : HTMLElement|string
304
308
  /**
305
309
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
310
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
311
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-insertFirst)
306
312
  */
307
313
  insertFirst ? : HTMLElement|string
308
314
  /**
@@ -653,7 +659,7 @@ const emit = defineEmits<{
653
659
  * @param {object} params.event Event object
654
660
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
655
661
  */
656
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
662
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
657
663
  /**
658
664
  * Fired before this container will load record values into its child fields. This is useful if you
659
665
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -679,7 +685,7 @@ const emit = defineEmits<{
679
685
  * @param {object} params.event Event object
680
686
  * @param {any} params.event.state State object config
681
687
  */
682
- (e: 'beforeStateApply', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
688
+ (e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
683
689
  /**
684
690
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
685
691
  * @param {string} e Event name
@@ -687,7 +693,7 @@ const emit = defineEmits<{
687
693
  * @param {object} params.event Event object
688
694
  * @param {any} params.event.state State object config
689
695
  */
690
- (e: 'beforeStateSave', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
696
+ (e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
691
697
  /**
692
698
  * Fires when any other event is fired from the object.
693
699
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#event-catchAll)
@@ -28,6 +28,8 @@ export declare type BryntumPanelProps = {
28
28
  /**
29
29
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
30
30
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
31
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
32
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-appendTo)
31
33
  */
32
34
  appendTo ? : HTMLElement|string
33
35
  /**
@@ -285,10 +287,14 @@ export declare type BryntumPanelProps = {
285
287
  inputFieldAlign ? : 'start'|'end'
286
288
  /**
287
289
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
290
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
291
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-insertBefore)
288
292
  */
289
293
  insertBefore ? : HTMLElement|string
290
294
  /**
291
295
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
296
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
297
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-insertFirst)
292
298
  */
293
299
  insertFirst ? : HTMLElement|string
294
300
  /**
@@ -42,6 +42,8 @@ defineProps<{
42
42
  /**
43
43
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
44
44
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
45
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
46
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-appendTo)
45
47
  */
46
48
  appendTo ? : HTMLElement|string
47
49
  /**
@@ -91,6 +93,15 @@ defineProps<{
91
93
  * Set to `true` to centre the Widget in browser viewport space.
92
94
  */
93
95
  centered ? : Boolean
96
+ /**
97
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
98
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
99
+ * evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
100
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-checkValidity)
101
+ * @param {Core.widget.Field} field The field being validated
102
+ * @returns {void}
103
+ */
104
+ checkValidity ? : ((field: Field) => void)|string
94
105
  /**
95
106
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
96
107
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -294,10 +305,14 @@ defineProps<{
294
305
  inputWidth ? : string|number
295
306
  /**
296
307
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
308
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
309
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-insertBefore)
297
310
  */
298
311
  insertBefore ? : HTMLElement|string
299
312
  /**
300
313
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
314
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
315
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-insertFirst)
301
316
  */
302
317
  insertFirst ? : HTMLElement|string
303
318
  /**
@@ -620,7 +635,7 @@ const emit = defineEmits<{
620
635
  * @param {object} params.event Event object
621
636
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
622
637
  */
623
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
638
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
624
639
  /**
625
640
  * Triggered before a widget is shown. Return `false` to prevent the action.
626
641
  * @param {string} e Event name
@@ -793,6 +808,7 @@ const widgetData = {
793
808
  'autoSelect',
794
809
  'bubbleEvents',
795
810
  'centered',
811
+ 'checkValidity',
796
812
  'clearable',
797
813
  'color',
798
814
  'config',
@@ -28,6 +28,8 @@ export declare type BryntumPasswordFieldProps = {
28
28
  /**
29
29
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
30
30
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
31
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
32
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-appendTo)
31
33
  */
32
34
  appendTo ? : HTMLElement|string
33
35
  /**
@@ -77,6 +79,15 @@ export declare type BryntumPasswordFieldProps = {
77
79
  * Set to `true` to centre the Widget in browser viewport space.
78
80
  */
79
81
  centered ? : Boolean
82
+ /**
83
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
84
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
85
+ * evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
86
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-checkValidity)
87
+ * @param {Core.widget.Field} field The field being validated
88
+ * @returns {void}
89
+ */
90
+ checkValidity ? : ((field: Field) => void)|string
80
91
  /**
81
92
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
82
93
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -280,10 +291,14 @@ export declare type BryntumPasswordFieldProps = {
280
291
  inputWidth ? : string|number
281
292
  /**
282
293
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
294
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
295
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-insertBefore)
283
296
  */
284
297
  insertBefore ? : HTMLElement|string
285
298
  /**
286
299
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
300
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
301
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-insertFirst)
287
302
  */
288
303
  insertFirst ? : HTMLElement|string
289
304
  /**
@@ -42,6 +42,8 @@ defineProps<{
42
42
  /**
43
43
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
44
44
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
45
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
46
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ProgressBar#config-appendTo)
45
47
  */
46
48
  appendTo ? : HTMLElement|string
47
49
  /**
@@ -211,10 +213,14 @@ defineProps<{
211
213
  ignoreParentReadOnly ? : Boolean
212
214
  /**
213
215
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
216
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
217
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ProgressBar#config-insertBefore)
214
218
  */
215
219
  insertBefore ? : HTMLElement|string
216
220
  /**
217
221
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
222
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
223
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ProgressBar#config-insertFirst)
218
224
  */
219
225
  insertFirst ? : HTMLElement|string
220
226
  /**
@@ -466,7 +472,7 @@ const emit = defineEmits<{
466
472
  * @param {object} params.event Event object
467
473
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
468
474
  */
469
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
475
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
470
476
  /**
471
477
  * Triggered before a widget is shown. Return `false` to prevent the action.
472
478
  * @param {string} e Event name
@@ -28,6 +28,8 @@ export declare type BryntumProgressBarProps = {
28
28
  /**
29
29
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
30
30
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
31
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
32
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ProgressBar#config-appendTo)
31
33
  */
32
34
  appendTo ? : HTMLElement|string
33
35
  /**
@@ -197,10 +199,14 @@ export declare type BryntumProgressBarProps = {
197
199
  ignoreParentReadOnly ? : Boolean
198
200
  /**
199
201
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
202
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
203
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ProgressBar#config-insertBefore)
200
204
  */
201
205
  insertBefore ? : HTMLElement|string
202
206
  /**
203
207
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
208
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
209
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ProgressBar#config-insertFirst)
204
210
  */
205
211
  insertFirst ? : HTMLElement|string
206
212
  /**
@@ -42,6 +42,8 @@ defineProps<{
42
42
  /**
43
43
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
44
44
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
45
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
46
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-appendTo)
45
47
  */
46
48
  appendTo ? : HTMLElement|string
47
49
  /**
@@ -108,6 +110,15 @@ defineProps<{
108
110
  * A value of `undefined` will cause this widget not to include its value when checked.
109
111
  */
110
112
  checkedValue ? : any
113
+ /**
114
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
115
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
116
+ * evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
117
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-checkValidity)
118
+ * @param {Core.widget.Field} field The field being validated
119
+ * @returns {void}
120
+ */
121
+ checkValidity ? : ((field: Field) => void)|string
111
122
  /**
112
123
  * Custom CSS classes to add to element.
113
124
  * May be specified as a space separated string, or as an object in which property names
@@ -296,10 +307,14 @@ defineProps<{
296
307
  inputWidth ? : string|number
297
308
  /**
298
309
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
310
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
311
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-insertBefore)
299
312
  */
300
313
  insertBefore ? : HTMLElement|string
301
314
  /**
302
315
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
316
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
317
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-insertFirst)
303
318
  */
304
319
  insertFirst ? : HTMLElement|string
305
320
  /**
@@ -624,7 +639,7 @@ const emit = defineEmits<{
624
639
  * @param {boolean} params.event.valid True if this field is in a valid state.
625
640
  * @param {Event} params.event.event The triggering DOM event if any
626
641
  */
627
- (e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
642
+ (e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => boolean|void)|string): boolean|void
628
643
  /**
629
644
  * Fires before an object is destroyed.
630
645
  * @param {string} e Event name
@@ -640,7 +655,7 @@ const emit = defineEmits<{
640
655
  * @param {object} params.event Event object
641
656
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
642
657
  */
643
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
658
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
644
659
  /**
645
660
  * Triggered before a widget is shown. Return `false` to prevent the action.
646
661
  * @param {string} e Event name
@@ -824,6 +839,7 @@ const widgetData = {
824
839
  'bubbleEvents',
825
840
  'centered',
826
841
  'checkedValue',
842
+ 'checkValidity',
827
843
  'color',
828
844
  'config',
829
845
  'constrainTo',
@@ -42,6 +42,8 @@ defineProps<{
42
42
  /**
43
43
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
44
44
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
45
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
46
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#config-appendTo)
45
47
  */
46
48
  appendTo ? : HTMLElement|string
47
49
  /**
@@ -310,10 +312,14 @@ defineProps<{
310
312
  inputFieldAlign ? : 'start'|'end'
311
313
  /**
312
314
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
315
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
316
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#config-insertBefore)
313
317
  */
314
318
  insertBefore ? : HTMLElement|string
315
319
  /**
316
320
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
321
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
322
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#config-insertFirst)
317
323
  */
318
324
  insertFirst ? : HTMLElement|string
319
325
  /**
@@ -691,7 +697,7 @@ const emit = defineEmits<{
691
697
  * @param {object} params.event Event object
692
698
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
693
699
  */
694
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
700
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
695
701
  /**
696
702
  * Fired before this container will load record values into its child fields. This is useful if you
697
703
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -717,7 +723,7 @@ const emit = defineEmits<{
717
723
  * @param {object} params.event Event object
718
724
  * @param {any} params.event.state State object config
719
725
  */
720
- (e: 'beforeStateApply', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
726
+ (e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
721
727
  /**
722
728
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
723
729
  * @param {string} e Event name
@@ -725,7 +731,7 @@ const emit = defineEmits<{
725
731
  * @param {object} params.event Event object
726
732
  * @param {any} params.event.state State object config
727
733
  */
728
- (e: 'beforeStateSave', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
734
+ (e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
729
735
  /**
730
736
  * Fires when any other event is fired from the object.
731
737
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#event-catchAll)
@@ -28,6 +28,8 @@ export declare type BryntumRadioGroupProps = {
28
28
  /**
29
29
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
30
30
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
31
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
32
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#config-appendTo)
31
33
  */
32
34
  appendTo ? : HTMLElement|string
33
35
  /**
@@ -296,10 +298,14 @@ export declare type BryntumRadioGroupProps = {
296
298
  inputFieldAlign ? : 'start'|'end'
297
299
  /**
298
300
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
301
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
302
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#config-insertBefore)
299
303
  */
300
304
  insertBefore ? : HTMLElement|string
301
305
  /**
302
306
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
307
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
308
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#config-insertFirst)
303
309
  */
304
310
  insertFirst ? : HTMLElement|string
305
311
  /**
@@ -28,6 +28,8 @@ export declare type BryntumRadioProps = {
28
28
  /**
29
29
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
30
30
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
31
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
32
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-appendTo)
31
33
  */
32
34
  appendTo ? : HTMLElement|string
33
35
  /**
@@ -94,6 +96,15 @@ export declare type BryntumRadioProps = {
94
96
  * A value of `undefined` will cause this widget not to include its value when checked.
95
97
  */
96
98
  checkedValue ? : any
99
+ /**
100
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
101
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
102
+ * evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
103
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-checkValidity)
104
+ * @param {Core.widget.Field} field The field being validated
105
+ * @returns {void}
106
+ */
107
+ checkValidity ? : ((field: Field) => void)|string
97
108
  /**
98
109
  * Custom CSS classes to add to element.
99
110
  * May be specified as a space separated string, or as an object in which property names
@@ -282,10 +293,14 @@ export declare type BryntumRadioProps = {
282
293
  inputWidth ? : string|number
283
294
  /**
284
295
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
296
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
297
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-insertBefore)
285
298
  */
286
299
  insertBefore ? : HTMLElement|string
287
300
  /**
288
301
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
302
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
303
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-insertFirst)
289
304
  */
290
305
  insertFirst ? : HTMLElement|string
291
306
  /**
@@ -42,6 +42,8 @@ defineProps<{
42
42
  /**
43
43
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
44
44
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
45
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
46
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-appendTo)
45
47
  */
46
48
  appendTo ? : HTMLElement|string
47
49
  /**
@@ -108,6 +110,15 @@ defineProps<{
108
110
  * A value of `undefined` will cause this widget not to include its value when checked.
109
111
  */
110
112
  checkedValue ? : any
113
+ /**
114
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
115
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
116
+ * evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
117
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-checkValidity)
118
+ * @param {Core.widget.Field} field The field being validated
119
+ * @returns {void}
120
+ */
121
+ checkValidity ? : ((field: Field) => void)|string
111
122
  /**
112
123
  * Custom CSS classes to add to element.
113
124
  * May be specified as a space separated string, or as an object in which property names
@@ -296,10 +307,14 @@ defineProps<{
296
307
  inputWidth ? : string|number
297
308
  /**
298
309
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
310
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
311
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-insertBefore)
299
312
  */
300
313
  insertBefore ? : HTMLElement|string
301
314
  /**
302
315
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
316
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
317
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-insertFirst)
303
318
  */
304
319
  insertFirst ? : HTMLElement|string
305
320
  /**
@@ -624,7 +639,7 @@ const emit = defineEmits<{
624
639
  * @param {boolean} params.event.valid True if this field is in a valid state.
625
640
  * @param {Event} params.event.event The triggering DOM event if any
626
641
  */
627
- (e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
642
+ (e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => boolean|void)|string): boolean|void
628
643
  /**
629
644
  * Fires before an object is destroyed.
630
645
  * @param {string} e Event name
@@ -640,7 +655,7 @@ const emit = defineEmits<{
640
655
  * @param {object} params.event Event object
641
656
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
642
657
  */
643
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
658
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
644
659
  /**
645
660
  * Triggered before a widget is shown. Return `false` to prevent the action.
646
661
  * @param {string} e Event name
@@ -824,6 +839,7 @@ const widgetData = {
824
839
  'bubbleEvents',
825
840
  'centered',
826
841
  'checkedValue',
842
+ 'checkValidity',
827
843
  'color',
828
844
  'config',
829
845
  'constrainTo',
@@ -28,6 +28,8 @@ export declare type BryntumSlideToggleProps = {
28
28
  /**
29
29
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
30
30
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
31
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
32
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-appendTo)
31
33
  */
32
34
  appendTo ? : HTMLElement|string
33
35
  /**
@@ -94,6 +96,15 @@ export declare type BryntumSlideToggleProps = {
94
96
  * A value of `undefined` will cause this widget not to include its value when checked.
95
97
  */
96
98
  checkedValue ? : any
99
+ /**
100
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
101
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
102
+ * evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
103
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-checkValidity)
104
+ * @param {Core.widget.Field} field The field being validated
105
+ * @returns {void}
106
+ */
107
+ checkValidity ? : ((field: Field) => void)|string
97
108
  /**
98
109
  * Custom CSS classes to add to element.
99
110
  * May be specified as a space separated string, or as an object in which property names
@@ -282,10 +293,14 @@ export declare type BryntumSlideToggleProps = {
282
293
  inputWidth ? : string|number
283
294
  /**
284
295
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
296
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
297
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-insertBefore)
285
298
  */
286
299
  insertBefore ? : HTMLElement|string
287
300
  /**
288
301
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
302
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
303
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-insertFirst)
289
304
  */
290
305
  insertFirst ? : HTMLElement|string
291
306
  /**