@bryntum/core-vue-3-thin 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 (206) hide show
  1. package/lib/chunks/-8Xai_9S.js.map +1 -1
  2. package/lib/chunks/47-V2ACd.js.map +1 -1
  3. package/lib/chunks/ASihDjXw.js.map +1 -1
  4. package/lib/chunks/B7KhcgPC.js.map +1 -1
  5. package/lib/chunks/B8KGPeHy.js.map +1 -1
  6. package/lib/chunks/BB8tOII_.js.map +1 -1
  7. package/lib/chunks/{S9XwH6IJ.js → BEX7SIci.js} +6 -4
  8. package/lib/chunks/BEX7SIci.js.map +1 -0
  9. package/lib/chunks/BFNWOtf2.js.map +1 -1
  10. package/lib/chunks/BG7E4-sX.js.map +1 -1
  11. package/lib/chunks/{BKLWvKPc.js → BH9WVqFa.js} +12 -10
  12. package/lib/chunks/BH9WVqFa.js.map +1 -0
  13. package/lib/chunks/{naTVDWnB.js → BOGE5pxL.js} +13 -11
  14. package/lib/chunks/BOGE5pxL.js.map +1 -0
  15. package/lib/chunks/{C14dvV95.js → BQikt_g7.js} +10 -8
  16. package/lib/chunks/BQikt_g7.js.map +1 -0
  17. package/lib/chunks/{C0-E5hnK.js → BWPcUxSk.js} +9 -7
  18. package/lib/chunks/BWPcUxSk.js.map +1 -0
  19. package/lib/chunks/{D7CJcnRV.js → BmrPNTUZ.js} +9 -7
  20. package/lib/chunks/BmrPNTUZ.js.map +1 -0
  21. package/lib/chunks/{DRz-V3LT.js → Bpq-_L_J.js} +11 -9
  22. package/lib/chunks/Bpq-_L_J.js.map +1 -0
  23. package/lib/chunks/Brp0NyFN.js.map +1 -1
  24. package/lib/chunks/{qkwwWpWo.js → BuQqXOvY.js} +6 -4
  25. package/lib/chunks/BuQqXOvY.js.map +1 -0
  26. package/lib/chunks/{BPANMXC6.js → ByuztLAT.js} +11 -9
  27. package/lib/chunks/ByuztLAT.js.map +1 -0
  28. package/lib/chunks/C0JI13dO.js.map +1 -1
  29. package/lib/chunks/C8pe1IyH.js.map +1 -1
  30. package/lib/chunks/C987g-kK.js.map +1 -1
  31. package/lib/chunks/CLqf-0PN.js.map +1 -1
  32. package/lib/chunks/CQwgnD9q.js.map +1 -1
  33. package/lib/chunks/{HOklxqtO.js → CXEKQ18L.js} +9 -7
  34. package/lib/chunks/CXEKQ18L.js.map +1 -0
  35. package/lib/chunks/Cd9NJP1W.js.map +1 -1
  36. package/lib/chunks/{BrRBMti3.js → CfCbZPht.js} +9 -7
  37. package/lib/chunks/CfCbZPht.js.map +1 -0
  38. package/lib/chunks/{ChAWW3Iy.js → CpVLgWPj.js} +9 -7
  39. package/lib/chunks/CpVLgWPj.js.map +1 -0
  40. package/lib/chunks/Csirfhz_.js.map +1 -1
  41. package/lib/chunks/Cz2JtuJX.js.map +1 -1
  42. package/lib/chunks/D6JcA9Zt.js.map +1 -1
  43. package/lib/chunks/{CUFZWGAX.js → DCcctqdo.js} +5 -3
  44. package/lib/chunks/DCcctqdo.js.map +1 -0
  45. package/lib/chunks/{ToClygqb.js → DNScKbAm.js} +9 -7
  46. package/lib/chunks/DNScKbAm.js.map +1 -0
  47. package/lib/chunks/DNTQukmL.js.map +1 -1
  48. package/lib/chunks/{BeXQ7RhD.js → DOp4_ZR2.js} +7 -5
  49. package/lib/chunks/DOp4_ZR2.js.map +1 -0
  50. package/lib/chunks/DQLfwhka.js.map +1 -1
  51. package/lib/chunks/DR_RL3ms.js.map +1 -1
  52. package/lib/chunks/Dg7wbkjL.js.map +1 -1
  53. package/lib/chunks/{DuiOZGf5.js → DgXr7-Gj.js} +9 -7
  54. package/lib/chunks/DgXr7-Gj.js.map +1 -0
  55. package/lib/chunks/DhOHvb1Z.js.map +1 -1
  56. package/lib/chunks/Hu7IhLgO.js.map +1 -1
  57. package/lib/chunks/WGJj3T9m.js.map +1 -1
  58. package/lib/chunks/Wh7gYeFQ.js.map +1 -1
  59. package/lib/chunks/YAeyT4qi.js.map +1 -1
  60. package/lib/chunks/boSXkG-m.js.map +1 -1
  61. package/lib/chunks/{DAfGAAbO.js → lQtECawa.js} +10 -8
  62. package/lib/chunks/lQtECawa.js.map +1 -0
  63. package/lib/chunks/{B_aqRSp2.js → vcFE80xr.js} +14 -12
  64. package/lib/chunks/vcFE80xr.js.map +1 -0
  65. package/lib/chunks/{IjqHT_Qc.js → xYFGvsOR.js} +9 -7
  66. package/lib/chunks/xYFGvsOR.js.map +1 -0
  67. package/lib/chunks/zIlWjejC.js.map +1 -1
  68. package/lib/chunks/ztxFXigG.js.map +1 -1
  69. package/lib/components/BryntumBooleanCombo.js +1 -1
  70. package/lib/components/BryntumCheckbox.js +1 -1
  71. package/lib/components/BryntumColorField.js +1 -1
  72. package/lib/components/BryntumCombo.js +1 -1
  73. package/lib/components/BryntumDateField.js +1 -1
  74. package/lib/components/BryntumDateRangeField.js +1 -1
  75. package/lib/components/BryntumDateTimeField.js +1 -1
  76. package/lib/components/BryntumDisplayField.js +1 -1
  77. package/lib/components/BryntumDurationField.js +1 -1
  78. package/lib/components/BryntumFileField.js +1 -1
  79. package/lib/components/BryntumFilterField.js +1 -1
  80. package/lib/components/BryntumNumberField.js +1 -1
  81. package/lib/components/BryntumPasswordField.js +1 -1
  82. package/lib/components/BryntumRadio.js +1 -1
  83. package/lib/components/BryntumSlideToggle.js +1 -1
  84. package/lib/components/BryntumTextAreaField.js +1 -1
  85. package/lib/components/BryntumTextAreaPickerField.js +1 -1
  86. package/lib/components/BryntumTextField.js +1 -1
  87. package/lib/components/BryntumTimeField.js +1 -1
  88. package/lib/index.js +19 -19
  89. package/package.json +1 -1
  90. package/src/components/BryntumBooleanCombo.vue +17 -1
  91. package/src/components/BryntumBooleanComboProps.ts +15 -0
  92. package/src/components/BryntumButton.vue +9 -3
  93. package/src/components/BryntumButtonGroup.vue +7 -1
  94. package/src/components/BryntumButtonGroupProps.ts +6 -0
  95. package/src/components/BryntumButtonProps.ts +6 -0
  96. package/src/components/BryntumChatPanel.vue +9 -3
  97. package/src/components/BryntumChatPanelProps.ts +6 -0
  98. package/src/components/BryntumCheckbox.vue +18 -2
  99. package/src/components/BryntumCheckboxGroup.vue +9 -3
  100. package/src/components/BryntumCheckboxGroupProps.ts +6 -0
  101. package/src/components/BryntumCheckboxProps.ts +15 -0
  102. package/src/components/BryntumChipView.vue +11 -3
  103. package/src/components/BryntumChipViewProps.ts +9 -1
  104. package/src/components/BryntumCodeEditor.vue +9 -3
  105. package/src/components/BryntumCodeEditorProps.ts +6 -0
  106. package/src/components/BryntumColorField.vue +17 -1
  107. package/src/components/BryntumColorFieldProps.ts +15 -0
  108. package/src/components/BryntumCombo.vue +17 -1
  109. package/src/components/BryntumComboProps.ts +15 -0
  110. package/src/components/BryntumContainer.vue +7 -1
  111. package/src/components/BryntumContainerProps.ts +6 -0
  112. package/src/components/BryntumDateField.vue +17 -1
  113. package/src/components/BryntumDateFieldProps.ts +15 -0
  114. package/src/components/BryntumDatePicker.vue +9 -3
  115. package/src/components/BryntumDatePickerProps.ts +6 -0
  116. package/src/components/BryntumDateRangeField.vue +17 -1
  117. package/src/components/BryntumDateRangeFieldProps.ts +15 -0
  118. package/src/components/BryntumDateTimeField.vue +17 -1
  119. package/src/components/BryntumDateTimeFieldProps.ts +15 -0
  120. package/src/components/BryntumDemoCodeEditor.vue +9 -3
  121. package/src/components/BryntumDemoCodeEditorProps.ts +6 -0
  122. package/src/components/BryntumDisplayField.vue +17 -1
  123. package/src/components/BryntumDisplayFieldProps.ts +15 -0
  124. package/src/components/BryntumDurationField.vue +17 -1
  125. package/src/components/BryntumDurationFieldProps.ts +15 -0
  126. package/src/components/BryntumEditor.vue +11 -5
  127. package/src/components/BryntumEditorProps.ts +6 -0
  128. package/src/components/BryntumFieldFilterPicker.vue +7 -1
  129. package/src/components/BryntumFieldFilterPickerGroup.vue +8 -2
  130. package/src/components/BryntumFieldFilterPickerGroupProps.ts +6 -0
  131. package/src/components/BryntumFieldFilterPickerProps.ts +6 -0
  132. package/src/components/BryntumFieldSet.vue +9 -3
  133. package/src/components/BryntumFieldSetProps.ts +6 -0
  134. package/src/components/BryntumFileField.vue +17 -1
  135. package/src/components/BryntumFileFieldProps.ts +15 -0
  136. package/src/components/BryntumFilePicker.vue +7 -1
  137. package/src/components/BryntumFilePickerProps.ts +6 -0
  138. package/src/components/BryntumFilterField.vue +17 -1
  139. package/src/components/BryntumFilterFieldProps.ts +15 -0
  140. package/src/components/BryntumHint.vue +9 -3
  141. package/src/components/BryntumHintProps.ts +6 -0
  142. package/src/components/BryntumLabel.vue +7 -1
  143. package/src/components/BryntumLabelProps.ts +6 -0
  144. package/src/components/BryntumList.vue +8 -2
  145. package/src/components/BryntumListProps.ts +6 -0
  146. package/src/components/BryntumMenu.vue +9 -3
  147. package/src/components/BryntumMenuProps.ts +6 -0
  148. package/src/components/BryntumMonthPicker.vue +9 -3
  149. package/src/components/BryntumMonthPickerProps.ts +6 -0
  150. package/src/components/BryntumNumberField.vue +17 -1
  151. package/src/components/BryntumNumberFieldProps.ts +15 -0
  152. package/src/components/BryntumPagingToolbar.vue +8 -2
  153. package/src/components/BryntumPagingToolbarProps.ts +6 -0
  154. package/src/components/BryntumPanel.vue +9 -3
  155. package/src/components/BryntumPanelProps.ts +6 -0
  156. package/src/components/BryntumPasswordField.vue +17 -1
  157. package/src/components/BryntumPasswordFieldProps.ts +15 -0
  158. package/src/components/BryntumProgressBar.vue +7 -1
  159. package/src/components/BryntumProgressBarProps.ts +6 -0
  160. package/src/components/BryntumRadio.vue +18 -2
  161. package/src/components/BryntumRadioGroup.vue +9 -3
  162. package/src/components/BryntumRadioGroupProps.ts +6 -0
  163. package/src/components/BryntumRadioProps.ts +15 -0
  164. package/src/components/BryntumSlideToggle.vue +18 -2
  165. package/src/components/BryntumSlideToggleProps.ts +15 -0
  166. package/src/components/BryntumSlider.vue +7 -1
  167. package/src/components/BryntumSliderProps.ts +6 -0
  168. package/src/components/BryntumSplitter.vue +7 -1
  169. package/src/components/BryntumSplitterProps.ts +6 -0
  170. package/src/components/BryntumTabPanel.vue +10 -4
  171. package/src/components/BryntumTabPanelProps.ts +6 -0
  172. package/src/components/BryntumTextAreaField.vue +17 -1
  173. package/src/components/BryntumTextAreaFieldProps.ts +15 -0
  174. package/src/components/BryntumTextAreaPickerField.vue +17 -1
  175. package/src/components/BryntumTextAreaPickerFieldProps.ts +15 -0
  176. package/src/components/BryntumTextField.vue +17 -1
  177. package/src/components/BryntumTextFieldProps.ts +15 -0
  178. package/src/components/BryntumTimeField.vue +17 -1
  179. package/src/components/BryntumTimeFieldProps.ts +15 -0
  180. package/src/components/BryntumTimePicker.vue +7 -1
  181. package/src/components/BryntumTimePickerProps.ts +6 -0
  182. package/src/components/BryntumToolbar.vue +8 -2
  183. package/src/components/BryntumToolbarProps.ts +6 -0
  184. package/src/components/BryntumWidget.vue +7 -1
  185. package/src/components/BryntumWidgetProps.ts +6 -0
  186. package/src/components/BryntumYearPicker.vue +9 -3
  187. package/src/components/BryntumYearPickerProps.ts +6 -0
  188. package/lib/chunks/BKLWvKPc.js.map +0 -1
  189. package/lib/chunks/BPANMXC6.js.map +0 -1
  190. package/lib/chunks/B_aqRSp2.js.map +0 -1
  191. package/lib/chunks/BeXQ7RhD.js.map +0 -1
  192. package/lib/chunks/BrRBMti3.js.map +0 -1
  193. package/lib/chunks/C0-E5hnK.js.map +0 -1
  194. package/lib/chunks/C14dvV95.js.map +0 -1
  195. package/lib/chunks/CUFZWGAX.js.map +0 -1
  196. package/lib/chunks/ChAWW3Iy.js.map +0 -1
  197. package/lib/chunks/D7CJcnRV.js.map +0 -1
  198. package/lib/chunks/DAfGAAbO.js.map +0 -1
  199. package/lib/chunks/DRz-V3LT.js.map +0 -1
  200. package/lib/chunks/DuiOZGf5.js.map +0 -1
  201. package/lib/chunks/HOklxqtO.js.map +0 -1
  202. package/lib/chunks/IjqHT_Qc.js.map +0 -1
  203. package/lib/chunks/S9XwH6IJ.js.map +0 -1
  204. package/lib/chunks/ToClygqb.js.map +0 -1
  205. package/lib/chunks/naTVDWnB.js.map +0 -1
  206. package/lib/chunks/qkwwWpWo.js.map +0 -1
@@ -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/core/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/FieldSet#config-appendTo)
45
47
  */
46
48
  appendTo ? : HTMLElement|string
47
49
  /**
@@ -305,10 +307,14 @@ defineProps<{
305
307
  inputFieldAlign ? : 'start'|'end'
306
308
  /**
307
309
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/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/FieldSet#config-insertBefore)
308
312
  */
309
313
  insertBefore ? : HTMLElement|string
310
314
  /**
311
315
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/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/FieldSet#config-insertFirst)
312
318
  */
313
319
  insertFirst ? : HTMLElement|string
314
320
  /**
@@ -667,7 +673,7 @@ const emit = defineEmits<{
667
673
  * @param {object} params.event Event object
668
674
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
669
675
  */
670
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
676
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
671
677
  /**
672
678
  * Fired before this container will load record values into its child fields. This is useful if you
673
679
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -693,7 +699,7 @@ const emit = defineEmits<{
693
699
  * @param {object} params.event Event object
694
700
  * @param {any} params.event.state State object config
695
701
  */
696
- (e: 'beforeStateApply', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
702
+ (e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
697
703
  /**
698
704
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
699
705
  * @param {string} e Event name
@@ -701,7 +707,7 @@ const emit = defineEmits<{
701
707
  * @param {object} params.event Event object
702
708
  * @param {any} params.event.state State object config
703
709
  */
704
- (e: 'beforeStateSave', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
710
+ (e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
705
711
  /**
706
712
  * Fires when any other event is fired from the object.
707
713
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldSet#event-catchAll)
@@ -27,6 +27,8 @@ export declare type BryntumFieldSetProps = {
27
27
  /**
28
28
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
29
29
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
30
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
31
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldSet#config-appendTo)
30
32
  */
31
33
  appendTo ? : HTMLElement|string
32
34
  /**
@@ -290,10 +292,14 @@ export declare type BryntumFieldSetProps = {
290
292
  inputFieldAlign ? : 'start'|'end'
291
293
  /**
292
294
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
295
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
296
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldSet#config-insertBefore)
293
297
  */
294
298
  insertBefore ? : HTMLElement|string
295
299
  /**
296
300
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/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/FieldSet#config-insertFirst)
297
303
  */
298
304
  insertFirst ? : HTMLElement|string
299
305
  /**
@@ -47,6 +47,8 @@ defineProps<{
47
47
  /**
48
48
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
49
49
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
50
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
51
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-appendTo)
50
52
  */
51
53
  appendTo ? : HTMLElement|string
52
54
  /**
@@ -96,6 +98,15 @@ defineProps<{
96
98
  * Set to `true` to centre the Widget in browser viewport space.
97
99
  */
98
100
  centered ? : Boolean
101
+ /**
102
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
103
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
104
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
105
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-checkValidity)
106
+ * @param {Core.widget.Field} field The field being validated
107
+ * @returns {void}
108
+ */
109
+ checkValidity ? : ((field: Field) => void)|string
99
110
  /**
100
111
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
101
112
  * in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -299,10 +310,14 @@ defineProps<{
299
310
  inputWidth ? : string|number
300
311
  /**
301
312
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
313
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
314
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-insertBefore)
302
315
  */
303
316
  insertBefore ? : HTMLElement|string
304
317
  /**
305
318
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
319
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
320
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-insertFirst)
306
321
  */
307
322
  insertFirst ? : HTMLElement|string
308
323
  /**
@@ -631,7 +646,7 @@ const emit = defineEmits<{
631
646
  * @param {object} params.event Event object
632
647
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
633
648
  */
634
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
649
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
635
650
  /**
636
651
  * Triggered before a widget is shown. Return `false` to prevent the action.
637
652
  * @param {string} e Event name
@@ -805,6 +820,7 @@ const widgetData = {
805
820
  'autoSelect',
806
821
  'bubbleEvents',
807
822
  'centered',
823
+ 'checkValidity',
808
824
  'clearable',
809
825
  'color',
810
826
  'config',
@@ -32,6 +32,8 @@ export declare type BryntumFileFieldProps = {
32
32
  /**
33
33
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
34
34
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
35
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
36
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-appendTo)
35
37
  */
36
38
  appendTo ? : HTMLElement|string
37
39
  /**
@@ -81,6 +83,15 @@ export declare type BryntumFileFieldProps = {
81
83
  * Set to `true` to centre the Widget in browser viewport space.
82
84
  */
83
85
  centered ? : Boolean
86
+ /**
87
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
88
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
89
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
90
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-checkValidity)
91
+ * @param {Core.widget.Field} field The field being validated
92
+ * @returns {void}
93
+ */
94
+ checkValidity ? : ((field: Field) => void)|string
84
95
  /**
85
96
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
86
97
  * in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -284,10 +295,14 @@ export declare type BryntumFileFieldProps = {
284
295
  inputWidth ? : string|number
285
296
  /**
286
297
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
298
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
299
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-insertBefore)
287
300
  */
288
301
  insertBefore ? : HTMLElement|string
289
302
  /**
290
303
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/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/FileField#config-insertFirst)
291
306
  */
292
307
  insertFirst ? : HTMLElement|string
293
308
  /**
@@ -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/core/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/FilePicker#config-appendTo)
45
47
  */
46
48
  appendTo ? : HTMLElement|string
47
49
  /**
@@ -254,10 +256,14 @@ defineProps<{
254
256
  inputFieldAlign ? : 'start'|'end'
255
257
  /**
256
258
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
259
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
260
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilePicker#config-insertBefore)
257
261
  */
258
262
  insertBefore ? : HTMLElement|string
259
263
  /**
260
264
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
265
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
266
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilePicker#config-insertFirst)
261
267
  */
262
268
  insertFirst ? : HTMLElement|string
263
269
  /**
@@ -559,7 +565,7 @@ const emit = defineEmits<{
559
565
  * @param {object} params.event Event object
560
566
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
561
567
  */
562
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
568
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
563
569
  /**
564
570
  * Fired before this container will load record values into its child fields. This is useful if you
565
571
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -27,6 +27,8 @@ export declare type BryntumFilePickerProps = {
27
27
  /**
28
28
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
29
29
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
30
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
31
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilePicker#config-appendTo)
30
32
  */
31
33
  appendTo ? : HTMLElement|string
32
34
  /**
@@ -239,10 +241,14 @@ export declare type BryntumFilePickerProps = {
239
241
  inputFieldAlign ? : 'start'|'end'
240
242
  /**
241
243
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
244
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
245
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilePicker#config-insertBefore)
242
246
  */
243
247
  insertBefore ? : HTMLElement|string
244
248
  /**
245
249
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
250
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
251
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilePicker#config-insertFirst)
246
252
  */
247
253
  insertFirst ? : HTMLElement|string
248
254
  /**
@@ -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/core/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/FilterField#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/core/docs/api/Core/widget/Field#property-isValid)
99
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
100
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#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/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
96
107
  * in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -313,10 +324,14 @@ defineProps<{
313
324
  inputWidth ? : string|number
314
325
  /**
315
326
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
327
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
328
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-insertBefore)
316
329
  */
317
330
  insertBefore ? : HTMLElement|string
318
331
  /**
319
332
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
333
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
334
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-insertFirst)
320
335
  */
321
336
  insertFirst ? : HTMLElement|string
322
337
  /**
@@ -662,7 +677,7 @@ const emit = defineEmits<{
662
677
  * @param {object} params.event Event object
663
678
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
664
679
  */
665
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
680
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
666
681
  /**
667
682
  * Triggered before a widget is shown. Return `false` to prevent the action.
668
683
  * @param {string} e Event name
@@ -835,6 +850,7 @@ const widgetData = {
835
850
  'autoSelect',
836
851
  'bubbleEvents',
837
852
  'centered',
853
+ 'checkValidity',
838
854
  'clearable',
839
855
  'color',
840
856
  'config',
@@ -27,6 +27,8 @@ export declare type BryntumFilterFieldProps = {
27
27
  /**
28
28
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
29
29
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
30
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
31
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-appendTo)
30
32
  */
31
33
  appendTo ? : HTMLElement|string
32
34
  /**
@@ -76,6 +78,15 @@ export declare type BryntumFilterFieldProps = {
76
78
  * Set to `true` to centre the Widget in browser viewport space.
77
79
  */
78
80
  centered ? : Boolean
81
+ /**
82
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
83
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
84
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
85
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-checkValidity)
86
+ * @param {Core.widget.Field} field The field being validated
87
+ * @returns {void}
88
+ */
89
+ checkValidity ? : ((field: Field) => void)|string
79
90
  /**
80
91
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
81
92
  * in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -298,10 +309,14 @@ export declare type BryntumFilterFieldProps = {
298
309
  inputWidth ? : string|number
299
310
  /**
300
311
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
312
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
313
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-insertBefore)
301
314
  */
302
315
  insertBefore ? : HTMLElement|string
303
316
  /**
304
317
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
318
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
319
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-insertFirst)
305
320
  */
306
321
  insertFirst ? : HTMLElement|string
307
322
  /**
@@ -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/core/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/Hint#config-appendTo)
45
47
  */
46
48
  appendTo ? : HTMLElement|string
47
49
  /**
@@ -315,10 +317,14 @@ defineProps<{
315
317
  inputFieldAlign ? : 'start'|'end'
316
318
  /**
317
319
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
320
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
321
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-insertBefore)
318
322
  */
319
323
  insertBefore ? : HTMLElement|string
320
324
  /**
321
325
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
326
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
327
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-insertFirst)
322
328
  */
323
329
  insertFirst ? : HTMLElement|string
324
330
  /**
@@ -735,7 +741,7 @@ const emit = defineEmits<{
735
741
  * @param {object} params.event Event object
736
742
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
737
743
  */
738
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
744
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
739
745
  /**
740
746
  * Fired before this container will load record values into its child fields. This is useful if you
741
747
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -761,7 +767,7 @@ const emit = defineEmits<{
761
767
  * @param {object} params.event Event object
762
768
  * @param {any} params.event.state State object config
763
769
  */
764
- (e: 'beforeStateApply', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
770
+ (e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
765
771
  /**
766
772
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
767
773
  * @param {string} e Event name
@@ -769,7 +775,7 @@ const emit = defineEmits<{
769
775
  * @param {object} params.event Event object
770
776
  * @param {any} params.event.state State object config
771
777
  */
772
- (e: 'beforeStateSave', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
778
+ (e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
773
779
  /**
774
780
  * Fires when any other event is fired from the object.
775
781
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#event-catchAll)
@@ -27,6 +27,8 @@ export declare type BryntumHintProps = {
27
27
  /**
28
28
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
29
29
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
30
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
31
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-appendTo)
30
32
  */
31
33
  appendTo ? : HTMLElement|string
32
34
  /**
@@ -300,10 +302,14 @@ export declare type BryntumHintProps = {
300
302
  inputFieldAlign ? : 'start'|'end'
301
303
  /**
302
304
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
305
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
306
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-insertBefore)
303
307
  */
304
308
  insertBefore ? : HTMLElement|string
305
309
  /**
306
310
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
311
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
312
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-insertFirst)
307
313
  */
308
314
  insertFirst ? : HTMLElement|string
309
315
  /**
@@ -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/core/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/Label#config-appendTo)
45
47
  */
46
48
  appendTo ? : HTMLElement|string
47
49
  /**
@@ -213,10 +215,14 @@ defineProps<{
213
215
  ignoreParentReadOnly ? : Boolean
214
216
  /**
215
217
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
218
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
219
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Label#config-insertBefore)
216
220
  */
217
221
  insertBefore ? : HTMLElement|string
218
222
  /**
219
223
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
224
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
225
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Label#config-insertFirst)
220
226
  */
221
227
  insertFirst ? : HTMLElement|string
222
228
  /**
@@ -447,7 +453,7 @@ const emit = defineEmits<{
447
453
  * @param {object} params.event Event object
448
454
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
449
455
  */
450
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
456
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
451
457
  /**
452
458
  * Triggered before a widget is shown. Return `false` to prevent the action.
453
459
  * @param {string} e Event name
@@ -27,6 +27,8 @@ export declare type BryntumLabelProps = {
27
27
  /**
28
28
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
29
29
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
30
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
31
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Label#config-appendTo)
30
32
  */
31
33
  appendTo ? : HTMLElement|string
32
34
  /**
@@ -198,10 +200,14 @@ export declare type BryntumLabelProps = {
198
200
  ignoreParentReadOnly ? : Boolean
199
201
  /**
200
202
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
203
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
204
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Label#config-insertBefore)
201
205
  */
202
206
  insertBefore ? : HTMLElement|string
203
207
  /**
204
208
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
209
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
210
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Label#config-insertFirst)
205
211
  */
206
212
  insertFirst ? : HTMLElement|string
207
213
  /**
@@ -52,6 +52,8 @@ defineProps<{
52
52
  /**
53
53
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
54
54
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
55
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
56
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/List#config-appendTo)
55
57
  */
56
58
  appendTo ? : HTMLElement|string
57
59
  /**
@@ -261,10 +263,14 @@ defineProps<{
261
263
  ignoreParentReadOnly ? : Boolean
262
264
  /**
263
265
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
266
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
267
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/List#config-insertBefore)
264
268
  */
265
269
  insertBefore ? : HTMLElement|string
266
270
  /**
267
271
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
272
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
273
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/List#config-insertFirst)
268
274
  */
269
275
  insertFirst ? : HTMLElement|string
270
276
  /**
@@ -548,7 +554,7 @@ const emit = defineEmits<{
548
554
  * @param {object} params.event Event object
549
555
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
550
556
  */
551
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
557
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
552
558
  /**
553
559
  * User going to activate an item in the list either by pointer or keyboard.
554
560
  * The active record, list item index, and the triggering event are passed.
@@ -562,7 +568,7 @@ const emit = defineEmits<{
562
568
  * @param {number} params.event.index List item index
563
569
  * @param {Event} params.event.event Triggering event
564
570
  */
565
- (e: 'beforeItem', params: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
571
+ (e: 'beforeItem', params: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string): boolean|void
566
572
  /**
567
573
  * Triggered before a widget is shown. Return `false` to prevent the action.
568
574
  * @param {string} e Event name
@@ -37,6 +37,8 @@ export declare type BryntumListProps = {
37
37
  /**
38
38
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
39
39
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
40
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
41
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/List#config-appendTo)
40
42
  */
41
43
  appendTo ? : HTMLElement|string
42
44
  /**
@@ -246,10 +248,14 @@ export declare type BryntumListProps = {
246
248
  ignoreParentReadOnly ? : Boolean
247
249
  /**
248
250
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
251
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
252
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/List#config-insertBefore)
249
253
  */
250
254
  insertBefore ? : HTMLElement|string
251
255
  /**
252
256
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
257
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
258
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/List#config-insertFirst)
253
259
  */
254
260
  insertFirst ? : HTMLElement|string
255
261
  /**
@@ -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/core/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/Menu#config-appendTo)
45
47
  */
46
48
  appendTo ? : HTMLElement|string
47
49
  /**
@@ -337,10 +339,14 @@ defineProps<{
337
339
  inputFieldAlign ? : 'start'|'end'
338
340
  /**
339
341
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
342
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
343
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-insertBefore)
340
344
  */
341
345
  insertBefore ? : HTMLElement|string
342
346
  /**
343
347
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
348
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
349
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-insertFirst)
344
350
  */
345
351
  insertFirst ? : HTMLElement|string
346
352
  /**
@@ -731,7 +737,7 @@ const emit = defineEmits<{
731
737
  * @param {object} params.event Event object
732
738
  * @param {Core.widget.Widget} params.event.source The widget being hidden.
733
739
  */
734
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
740
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
735
741
  /**
736
742
  * Fired before this container will load record values into its child fields. This is useful if you
737
743
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -757,7 +763,7 @@ const emit = defineEmits<{
757
763
  * @param {object} params.event Event object
758
764
  * @param {any} params.event.state State object config
759
765
  */
760
- (e: 'beforeStateApply', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
766
+ (e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
761
767
  /**
762
768
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
763
769
  * @param {string} e Event name
@@ -765,7 +771,7 @@ const emit = defineEmits<{
765
771
  * @param {object} params.event Event object
766
772
  * @param {any} params.event.state State object config
767
773
  */
768
- (e: 'beforeStateSave', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
774
+ (e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
769
775
  /**
770
776
  * Fires when any other event is fired from the object.
771
777
  * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#event-catchAll)
@@ -27,6 +27,8 @@ export declare type BryntumMenuProps = {
27
27
  /**
28
28
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
29
29
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
30
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
31
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-appendTo)
30
32
  */
31
33
  appendTo ? : HTMLElement|string
32
34
  /**
@@ -322,10 +324,14 @@ export declare type BryntumMenuProps = {
322
324
  inputFieldAlign ? : 'start'|'end'
323
325
  /**
324
326
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
327
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
328
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-insertBefore)
325
329
  */
326
330
  insertBefore ? : HTMLElement|string
327
331
  /**
328
332
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
333
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
334
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-insertFirst)
329
335
  */
330
336
  insertFirst ? : HTMLElement|string
331
337
  /**