@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.
- package/lib/chunks/{CDlTquLg.js → 0G3BOxn8.js} +9 -7
- package/lib/chunks/0G3BOxn8.js.map +1 -0
- package/lib/chunks/0gtq8Dk3.js.map +1 -1
- package/lib/chunks/1RZB5Yja.js.map +1 -1
- package/lib/chunks/2JP2ap14.js.map +1 -1
- package/lib/chunks/B9Ym-jRB.js.map +1 -1
- package/lib/chunks/B9qIhgk1.js.map +1 -1
- package/lib/chunks/{DiZmRX6M.js → BAaaUhdy.js} +6 -4
- package/lib/chunks/BAaaUhdy.js.map +1 -0
- package/lib/chunks/{D6pNVhVB.js → BArALprx.js} +11 -9
- package/lib/chunks/BArALprx.js.map +1 -0
- package/lib/chunks/BC_xvNJq.js.map +1 -1
- package/lib/chunks/{B-xu7l3m.js → BFLoNIuF.js} +10 -8
- package/lib/chunks/BFLoNIuF.js.map +1 -0
- package/lib/chunks/BK5CVUgh.js.map +1 -1
- package/lib/chunks/BQUiHybJ.js.map +1 -1
- package/lib/chunks/BWIgghsj.js.map +1 -1
- package/lib/chunks/{BF1rPMcu.js → BWT4Mdsw.js} +10 -8
- package/lib/chunks/BWT4Mdsw.js.map +1 -0
- package/lib/chunks/{DTUe-lyS.js → BX4HI-q4.js} +12 -10
- package/lib/chunks/BX4HI-q4.js.map +1 -0
- package/lib/chunks/BZdz0l_5.js.map +1 -1
- package/lib/chunks/{BpR2lUkV.js → B_2BdFBO.js} +9 -7
- package/lib/chunks/B_2BdFBO.js.map +1 -0
- package/lib/chunks/Bfj8ZUAm.js.map +1 -1
- package/lib/chunks/{bLebs42H.js → BhfZhJQ4.js} +5 -3
- package/lib/chunks/BhfZhJQ4.js.map +1 -0
- package/lib/chunks/BoUkRqVY.js.map +1 -1
- package/lib/chunks/{NkF4pTV7.js → C-KNXud_.js} +9 -7
- package/lib/chunks/C-KNXud_.js.map +1 -0
- package/lib/chunks/C2x-tjJx.js.map +1 -1
- package/lib/chunks/{D94FCXrL.js → C3q04kPS.js} +9 -7
- package/lib/chunks/C3q04kPS.js.map +1 -0
- package/lib/chunks/C9YGIUax.js.map +1 -1
- package/lib/chunks/CC_mnQeM.js.map +1 -1
- package/lib/chunks/CKihfOVz.js.map +1 -1
- package/lib/chunks/{BMTMMdaC.js → CLRX9ie2.js} +11 -9
- package/lib/chunks/CLRX9ie2.js.map +1 -0
- package/lib/chunks/COI8HIJL.js.map +1 -1
- package/lib/chunks/COs57ih1.js.map +1 -1
- package/lib/chunks/CQUmcVHy.js.map +1 -1
- package/lib/chunks/CeJ19ncI.js.map +1 -1
- package/lib/chunks/CnUfgMxC.js.map +1 -1
- package/lib/chunks/{Cex7HFh5.js → CnvevsBu.js} +9 -7
- package/lib/chunks/CnvevsBu.js.map +1 -0
- package/lib/chunks/{Byhp0Mwy.js → CoXntcPO.js} +7 -5
- package/lib/chunks/CoXntcPO.js.map +1 -0
- package/lib/chunks/{xIdoI0po.js → Cs5IYq5I.js} +9 -7
- package/lib/chunks/Cs5IYq5I.js.map +1 -0
- package/lib/chunks/D2GsXOvn.js.map +1 -1
- package/lib/chunks/D4Cy-qFk.js.map +1 -1
- package/lib/chunks/{Ccul2l2v.js → D7f0nsko.js} +6 -4
- package/lib/chunks/D7f0nsko.js.map +1 -0
- package/lib/chunks/DCg2fWiq.js.map +1 -1
- package/lib/chunks/{CBRW321y.js → DE5aChZi.js} +14 -12
- package/lib/chunks/DE5aChZi.js.map +1 -0
- package/lib/chunks/DRVjD9iN.js.map +1 -1
- package/lib/chunks/{DayQ7Rlb.js → DSedBrt_.js} +13 -11
- package/lib/chunks/DSedBrt_.js.map +1 -0
- package/lib/chunks/D_rLSr8Y.js.map +1 -1
- package/lib/chunks/{BwuvAbW5.js → DbEgVOs1.js} +7 -5
- package/lib/chunks/DbEgVOs1.js.map +1 -0
- package/lib/chunks/{DTH08WC2.js → DhhewFEv.js} +9 -7
- package/lib/chunks/DhhewFEv.js.map +1 -0
- package/lib/chunks/Dm-Ds5Fs.js.map +1 -1
- package/lib/chunks/Dm8ipdVr.js.map +1 -1
- package/lib/chunks/DskRZNvv.js.map +1 -1
- package/lib/chunks/PT41l8zv.js.map +1 -1
- package/lib/chunks/{D61dAL1b.js → TMpK4xg3.js} +12 -10
- package/lib/chunks/TMpK4xg3.js.map +1 -0
- package/lib/chunks/UkUlfQx6.js.map +1 -1
- package/lib/chunks/cmj1-s1q.js.map +1 -1
- package/lib/chunks/gboR1LQ7.js.map +1 -1
- package/lib/chunks/jla7jldm.js.map +1 -1
- package/lib/chunks/{B711lzqw.js → n-bko5m2.js} +11 -9
- package/lib/chunks/n-bko5m2.js.map +1 -0
- package/lib/chunks/n4K19P1t.js.map +1 -1
- package/lib/chunks/{BkSzOi0v.js → oOR_enaE.js} +9 -7
- package/lib/chunks/oOR_enaE.js.map +1 -0
- package/lib/chunks/pP8iMzIE.js.map +1 -1
- package/lib/chunks/s-g3r5g2.js.map +1 -1
- package/lib/components/BryntumAIFilterField.js +1 -1
- package/lib/components/BryntumBooleanCombo.js +1 -1
- package/lib/components/BryntumCheckbox.js +1 -1
- package/lib/components/BryntumChecklistFilterCombo.js +1 -1
- package/lib/components/BryntumColorField.js +1 -1
- package/lib/components/BryntumCombo.js +1 -1
- package/lib/components/BryntumDateField.js +1 -1
- package/lib/components/BryntumDateRangeField.js +1 -1
- package/lib/components/BryntumDateTimeField.js +1 -1
- package/lib/components/BryntumDisplayField.js +1 -1
- package/lib/components/BryntumDurationField.js +1 -1
- package/lib/components/BryntumFileField.js +1 -1
- package/lib/components/BryntumFilterField.js +1 -1
- package/lib/components/BryntumNumberField.js +1 -1
- package/lib/components/BryntumPasswordField.js +1 -1
- package/lib/components/BryntumRadio.js +1 -1
- package/lib/components/BryntumSlideToggle.js +1 -1
- package/lib/components/BryntumTextAreaField.js +1 -1
- package/lib/components/BryntumTextAreaPickerField.js +1 -1
- package/lib/components/BryntumTextField.js +1 -1
- package/lib/components/BryntumTimeField.js +1 -1
- package/lib/components/BryntumTreeCombo.js +1 -1
- package/lib/index.js +22 -22
- package/package.json +1 -1
- package/src/components/BryntumAIFilterField.vue +17 -1
- package/src/components/BryntumAIFilterFieldProps.ts +15 -0
- package/src/components/BryntumBooleanCombo.vue +17 -1
- package/src/components/BryntumBooleanComboProps.ts +15 -0
- package/src/components/BryntumButton.vue +9 -3
- package/src/components/BryntumButtonGroup.vue +7 -1
- package/src/components/BryntumButtonGroupProps.ts +6 -0
- package/src/components/BryntumButtonProps.ts +6 -0
- package/src/components/BryntumChatPanel.vue +9 -3
- package/src/components/BryntumChatPanelProps.ts +6 -0
- package/src/components/BryntumCheckbox.vue +18 -2
- package/src/components/BryntumCheckboxGroup.vue +9 -3
- package/src/components/BryntumCheckboxGroupProps.ts +6 -0
- package/src/components/BryntumCheckboxProps.ts +15 -0
- package/src/components/BryntumChecklistFilterCombo.vue +17 -1
- package/src/components/BryntumChecklistFilterComboProps.ts +15 -0
- package/src/components/BryntumChipView.vue +11 -3
- package/src/components/BryntumChipViewProps.ts +9 -1
- package/src/components/BryntumCodeEditor.vue +9 -3
- package/src/components/BryntumCodeEditorProps.ts +6 -0
- package/src/components/BryntumColorField.vue +17 -1
- package/src/components/BryntumColorFieldProps.ts +15 -0
- package/src/components/BryntumCombo.vue +17 -1
- package/src/components/BryntumComboProps.ts +15 -0
- package/src/components/BryntumContainer.vue +7 -1
- package/src/components/BryntumContainerProps.ts +6 -0
- package/src/components/BryntumDateField.vue +17 -1
- package/src/components/BryntumDateFieldProps.ts +15 -0
- package/src/components/BryntumDatePicker.vue +9 -3
- package/src/components/BryntumDatePickerProps.ts +6 -0
- package/src/components/BryntumDateRangeField.vue +17 -1
- package/src/components/BryntumDateRangeFieldProps.ts +15 -0
- package/src/components/BryntumDateTimeField.vue +17 -1
- package/src/components/BryntumDateTimeFieldProps.ts +15 -0
- package/src/components/BryntumDemoCodeEditor.vue +9 -3
- package/src/components/BryntumDemoCodeEditorProps.ts +6 -0
- package/src/components/BryntumDisplayField.vue +17 -1
- package/src/components/BryntumDisplayFieldProps.ts +15 -0
- package/src/components/BryntumDurationField.vue +17 -1
- package/src/components/BryntumDurationFieldProps.ts +15 -0
- package/src/components/BryntumEditor.vue +11 -5
- package/src/components/BryntumEditorProps.ts +6 -0
- package/src/components/BryntumFieldFilterPicker.vue +7 -1
- package/src/components/BryntumFieldFilterPickerGroup.vue +8 -2
- package/src/components/BryntumFieldFilterPickerGroupProps.ts +6 -0
- package/src/components/BryntumFieldFilterPickerProps.ts +6 -0
- package/src/components/BryntumFieldSet.vue +9 -3
- package/src/components/BryntumFieldSetProps.ts +6 -0
- package/src/components/BryntumFileField.vue +17 -1
- package/src/components/BryntumFileFieldProps.ts +15 -0
- package/src/components/BryntumFilePicker.vue +7 -1
- package/src/components/BryntumFilePickerProps.ts +6 -0
- package/src/components/BryntumFilterField.vue +17 -1
- package/src/components/BryntumFilterFieldProps.ts +15 -0
- package/src/components/BryntumGrid.vue +31 -25
- package/src/components/BryntumGridBase.vue +31 -25
- package/src/components/BryntumGridBaseProps.ts +6 -0
- package/src/components/BryntumGridChartDesigner.vue +7 -1
- package/src/components/BryntumGridChartDesignerProps.ts +6 -0
- package/src/components/BryntumGridFieldFilterPicker.vue +7 -1
- package/src/components/BryntumGridFieldFilterPickerGroup.vue +8 -2
- package/src/components/BryntumGridFieldFilterPickerGroupProps.ts +6 -0
- package/src/components/BryntumGridFieldFilterPickerProps.ts +6 -0
- package/src/components/BryntumGridProps.ts +6 -0
- package/src/components/BryntumGroupBar.vue +11 -3
- package/src/components/BryntumGroupBarProps.ts +9 -1
- package/src/components/BryntumHint.vue +9 -3
- package/src/components/BryntumHintProps.ts +6 -0
- package/src/components/BryntumLabel.vue +7 -1
- package/src/components/BryntumLabelProps.ts +6 -0
- package/src/components/BryntumList.vue +8 -2
- package/src/components/BryntumListProps.ts +6 -0
- package/src/components/BryntumMenu.vue +9 -3
- package/src/components/BryntumMenuProps.ts +6 -0
- package/src/components/BryntumMonthPicker.vue +9 -3
- package/src/components/BryntumMonthPickerProps.ts +6 -0
- package/src/components/BryntumNumberField.vue +17 -1
- package/src/components/BryntumNumberFieldProps.ts +15 -0
- package/src/components/BryntumPagingToolbar.vue +8 -2
- package/src/components/BryntumPagingToolbarProps.ts +6 -0
- package/src/components/BryntumPanel.vue +9 -3
- package/src/components/BryntumPanelProps.ts +6 -0
- package/src/components/BryntumPasswordField.vue +17 -1
- package/src/components/BryntumPasswordFieldProps.ts +15 -0
- package/src/components/BryntumProgressBar.vue +7 -1
- package/src/components/BryntumProgressBarProps.ts +6 -0
- package/src/components/BryntumRadio.vue +18 -2
- package/src/components/BryntumRadioGroup.vue +9 -3
- package/src/components/BryntumRadioGroupProps.ts +6 -0
- package/src/components/BryntumRadioProps.ts +15 -0
- package/src/components/BryntumSlideToggle.vue +18 -2
- package/src/components/BryntumSlideToggleProps.ts +15 -0
- package/src/components/BryntumSlider.vue +7 -1
- package/src/components/BryntumSliderProps.ts +6 -0
- package/src/components/BryntumSplitter.vue +7 -1
- package/src/components/BryntumSplitterProps.ts +6 -0
- package/src/components/BryntumTabPanel.vue +10 -4
- package/src/components/BryntumTabPanelProps.ts +6 -0
- package/src/components/BryntumTextAreaField.vue +17 -1
- package/src/components/BryntumTextAreaFieldProps.ts +15 -0
- package/src/components/BryntumTextAreaPickerField.vue +17 -1
- package/src/components/BryntumTextAreaPickerFieldProps.ts +15 -0
- package/src/components/BryntumTextField.vue +17 -1
- package/src/components/BryntumTextFieldProps.ts +15 -0
- package/src/components/BryntumTimeField.vue +17 -1
- package/src/components/BryntumTimeFieldProps.ts +15 -0
- package/src/components/BryntumTimePicker.vue +7 -1
- package/src/components/BryntumTimePickerProps.ts +6 -0
- package/src/components/BryntumToolbar.vue +8 -2
- package/src/components/BryntumToolbarProps.ts +6 -0
- package/src/components/BryntumTreeCombo.vue +17 -1
- package/src/components/BryntumTreeComboProps.ts +15 -0
- package/src/components/BryntumTreeGrid.vue +31 -25
- package/src/components/BryntumTreeGridProps.ts +6 -0
- package/src/components/BryntumWidget.vue +7 -1
- package/src/components/BryntumWidgetProps.ts +6 -0
- package/src/components/BryntumYearPicker.vue +9 -3
- package/src/components/BryntumYearPickerProps.ts +6 -0
- package/lib/chunks/B-xu7l3m.js.map +0 -1
- package/lib/chunks/B711lzqw.js.map +0 -1
- package/lib/chunks/BF1rPMcu.js.map +0 -1
- package/lib/chunks/BMTMMdaC.js.map +0 -1
- package/lib/chunks/BkSzOi0v.js.map +0 -1
- package/lib/chunks/BpR2lUkV.js.map +0 -1
- package/lib/chunks/BwuvAbW5.js.map +0 -1
- package/lib/chunks/Byhp0Mwy.js.map +0 -1
- package/lib/chunks/CBRW321y.js.map +0 -1
- package/lib/chunks/CDlTquLg.js.map +0 -1
- package/lib/chunks/Ccul2l2v.js.map +0 -1
- package/lib/chunks/Cex7HFh5.js.map +0 -1
- package/lib/chunks/D61dAL1b.js.map +0 -1
- package/lib/chunks/D6pNVhVB.js.map +0 -1
- package/lib/chunks/D94FCXrL.js.map +0 -1
- package/lib/chunks/DTH08WC2.js.map +0 -1
- package/lib/chunks/DTUe-lyS.js.map +0 -1
- package/lib/chunks/DayQ7Rlb.js.map +0 -1
- package/lib/chunks/DiZmRX6M.js.map +0 -1
- package/lib/chunks/NkF4pTV7.js.map +0 -1
- package/lib/chunks/bLebs42H.js.map +0 -1
- package/lib/chunks/xIdoI0po.js.map +0 -1
|
@@ -37,6 +37,8 @@ export declare type BryntumDurationFieldProps = {
|
|
|
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/grid/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/DurationField#config-appendTo)
|
|
40
42
|
*/
|
|
41
43
|
appendTo ? : HTMLElement|string
|
|
42
44
|
/**
|
|
@@ -86,6 +88,15 @@ export declare type BryntumDurationFieldProps = {
|
|
|
86
88
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
87
89
|
*/
|
|
88
90
|
centered ? : Boolean
|
|
91
|
+
/**
|
|
92
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
93
|
+
* 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)
|
|
94
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
95
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DurationField#config-checkValidity)
|
|
96
|
+
* @param {Core.widget.Field} field The field being validated
|
|
97
|
+
* @returns {void}
|
|
98
|
+
*/
|
|
99
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
89
100
|
/**
|
|
90
101
|
* 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
|
|
91
102
|
* 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
|
|
@@ -293,10 +304,14 @@ export declare type BryntumDurationFieldProps = {
|
|
|
293
304
|
inputWidth ? : string|number
|
|
294
305
|
/**
|
|
295
306
|
* 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.
|
|
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/DurationField#config-insertBefore)
|
|
296
309
|
*/
|
|
297
310
|
insertBefore ? : HTMLElement|string
|
|
298
311
|
/**
|
|
299
312
|
* 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.
|
|
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/DurationField#config-insertFirst)
|
|
300
315
|
*/
|
|
301
316
|
insertFirst ? : HTMLElement|string
|
|
302
317
|
/**
|
|
@@ -41,6 +41,8 @@ defineProps<{
|
|
|
41
41
|
/**
|
|
42
42
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
43
43
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
44
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
45
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-appendTo)
|
|
44
46
|
*/
|
|
45
47
|
appendTo ? : HTMLElement|string
|
|
46
48
|
/**
|
|
@@ -284,10 +286,14 @@ defineProps<{
|
|
|
284
286
|
inputFieldAlign ? : 'start'|'end'
|
|
285
287
|
/**
|
|
286
288
|
* 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.
|
|
289
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
290
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-insertBefore)
|
|
287
291
|
*/
|
|
288
292
|
insertBefore ? : HTMLElement|string
|
|
289
293
|
/**
|
|
290
294
|
* 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.
|
|
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/Editor#config-insertFirst)
|
|
291
297
|
*/
|
|
292
298
|
insertFirst ? : HTMLElement|string
|
|
293
299
|
/**
|
|
@@ -607,7 +613,7 @@ const emit = defineEmits<{
|
|
|
607
613
|
* @param {Event} params.event.event Included if the cancellation was triggered by a DOM event
|
|
608
614
|
* @param {Core.widget.Editor} params.event.source The Editor that triggered the event.
|
|
609
615
|
*/
|
|
610
|
-
(e: 'beforeCancel', params: ((event: { oldValue: object, value: object, event: Event, source: Editor }) =>
|
|
616
|
+
(e: 'beforeCancel', params: ((event: { oldValue: object, value: object, event: Event, source: Editor }) => boolean|void)|string): boolean|void
|
|
611
617
|
/**
|
|
612
618
|
* Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
|
|
613
619
|
* The completion may be vetoed, in which case, focus is moved back into the editor.
|
|
@@ -620,7 +626,7 @@ const emit = defineEmits<{
|
|
|
620
626
|
* @param {Function} [params.event.finalize] An async function may be injected into this property which performs asynchronous finalization tasks such as complex validation of confirmation. The value `true` or `false` must be returned.
|
|
621
627
|
* @param {object} [params.event.finalize.context] An object describing the editing context upon requested completion of the edit.
|
|
622
628
|
*/
|
|
623
|
-
(e: 'beforeComplete', params: ((event: { oldValue: object, value: object, source: Editor, finalize: { context?: object } }) =>
|
|
629
|
+
(e: 'beforeComplete', params: ((event: { oldValue: object, value: object, source: Editor, finalize: { context?: object } }) => boolean|void)|string): boolean|void
|
|
624
630
|
/**
|
|
625
631
|
* Fires before an object is destroyed.
|
|
626
632
|
* @param {string} e Event name
|
|
@@ -636,7 +642,7 @@ const emit = defineEmits<{
|
|
|
636
642
|
* @param {object} params.event Event object
|
|
637
643
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
638
644
|
*/
|
|
639
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
645
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
640
646
|
/**
|
|
641
647
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
642
648
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -660,7 +666,7 @@ const emit = defineEmits<{
|
|
|
660
666
|
* @param {string} e Event name
|
|
661
667
|
* @param {object} params Event parameters
|
|
662
668
|
* @param {object} params.event Event object
|
|
663
|
-
* @param {
|
|
669
|
+
* @param {Element} params.event.target The element which the Editor is to overlay to edit its content.
|
|
664
670
|
* @param {Core.data.Model} [params.event.record] The record being edited.
|
|
665
671
|
* @param {string} [params.event.field] The name of the field if a record is being edited.
|
|
666
672
|
* @param {object} params.event.value The value to be edited.
|
|
@@ -672,7 +678,7 @@ const emit = defineEmits<{
|
|
|
672
678
|
* @param {boolean} params.event.matchFont Whether to match the target's font. See [matchFont](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-matchFont)
|
|
673
679
|
* @param {boolean} params.event.focus Whether to focus the editor's field.
|
|
674
680
|
*/
|
|
675
|
-
(e: 'beforeStart', params: ((event: { target:
|
|
681
|
+
(e: 'beforeStart', params: ((event: { target: Element, record?: Model, field?: string, value: object, align: string|AlignSpec, hideTarget: boolean, matchSize: { width: boolean, height: boolean }, matchFont: boolean, focus: boolean }) => boolean|void)|string): boolean|void
|
|
676
682
|
/**
|
|
677
683
|
* Edit has been canceled without updating the associated record or element.
|
|
678
684
|
* @param {string} e Event name
|
|
@@ -27,6 +27,8 @@ export declare type BryntumEditorProps = {
|
|
|
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/grid/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/Editor#config-appendTo)
|
|
30
32
|
*/
|
|
31
33
|
appendTo ? : HTMLElement|string
|
|
32
34
|
/**
|
|
@@ -270,10 +272,14 @@ export declare type BryntumEditorProps = {
|
|
|
270
272
|
inputFieldAlign ? : 'start'|'end'
|
|
271
273
|
/**
|
|
272
274
|
* 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.
|
|
275
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
276
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-insertBefore)
|
|
273
277
|
*/
|
|
274
278
|
insertBefore ? : HTMLElement|string
|
|
275
279
|
/**
|
|
276
280
|
* 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.
|
|
281
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
282
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-insertFirst)
|
|
277
283
|
*/
|
|
278
284
|
insertFirst ? : HTMLElement|string
|
|
279
285
|
/**
|
|
@@ -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/FieldFilterPicker#config-appendTo)
|
|
45
47
|
*/
|
|
46
48
|
appendTo ? : HTMLElement|string
|
|
47
49
|
/**
|
|
@@ -270,10 +272,14 @@ defineProps<{
|
|
|
270
272
|
inputFieldAlign ? : 'start'|'end'
|
|
271
273
|
/**
|
|
272
274
|
* 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.
|
|
275
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
276
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker#config-insertBefore)
|
|
273
277
|
*/
|
|
274
278
|
insertBefore ? : HTMLElement|string
|
|
275
279
|
/**
|
|
276
280
|
* 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.
|
|
281
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
282
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker#config-insertFirst)
|
|
277
283
|
*/
|
|
278
284
|
insertFirst ? : HTMLElement|string
|
|
279
285
|
/**
|
|
@@ -606,7 +612,7 @@ const emit = defineEmits<{
|
|
|
606
612
|
* @param {object} params.event Event object
|
|
607
613
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
608
614
|
*/
|
|
609
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
615
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
610
616
|
/**
|
|
611
617
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
612
618
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -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/grid/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/FieldFilterPickerGroup#config-appendTo)
|
|
55
57
|
*/
|
|
56
58
|
appendTo ? : HTMLElement|string
|
|
57
59
|
/**
|
|
@@ -298,10 +300,14 @@ defineProps<{
|
|
|
298
300
|
inputFieldAlign ? : 'start'|'end'
|
|
299
301
|
/**
|
|
300
302
|
* 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.
|
|
303
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
304
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPickerGroup#config-insertBefore)
|
|
301
305
|
*/
|
|
302
306
|
insertBefore ? : HTMLElement|string
|
|
303
307
|
/**
|
|
304
308
|
* 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.
|
|
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/FieldFilterPickerGroup#config-insertFirst)
|
|
305
311
|
*/
|
|
306
312
|
insertFirst ? : HTMLElement|string
|
|
307
313
|
/**
|
|
@@ -620,7 +626,7 @@ const emit = defineEmits<{
|
|
|
620
626
|
* @param {Core.widget.FieldFilterPicker} params.event.source The FieldFilterPicker instance that fired the event.
|
|
621
627
|
* @param {CollectionFilterConfig} params.event.filter The [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker).
|
|
622
628
|
*/
|
|
623
|
-
(e: 'beforeAddFilter', params: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
629
|
+
(e: 'beforeAddFilter', params: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string): boolean|void
|
|
624
630
|
/**
|
|
625
631
|
* Fires before an object is destroyed.
|
|
626
632
|
* @param {string} e Event name
|
|
@@ -636,7 +642,7 @@ const emit = defineEmits<{
|
|
|
636
642
|
* @param {object} params.event Event object
|
|
637
643
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
638
644
|
*/
|
|
639
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
645
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
640
646
|
/**
|
|
641
647
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
642
648
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -38,6 +38,8 @@ export declare type BryntumFieldFilterPickerGroupProps = {
|
|
|
38
38
|
/**
|
|
39
39
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
40
40
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
41
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
42
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPickerGroup#config-appendTo)
|
|
41
43
|
*/
|
|
42
44
|
appendTo ? : HTMLElement|string
|
|
43
45
|
/**
|
|
@@ -284,10 +286,14 @@ export declare type BryntumFieldFilterPickerGroupProps = {
|
|
|
284
286
|
inputFieldAlign ? : 'start'|'end'
|
|
285
287
|
/**
|
|
286
288
|
* 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.
|
|
289
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
290
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPickerGroup#config-insertBefore)
|
|
287
291
|
*/
|
|
288
292
|
insertBefore ? : HTMLElement|string
|
|
289
293
|
/**
|
|
290
294
|
* 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.
|
|
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/FieldFilterPickerGroup#config-insertFirst)
|
|
291
297
|
*/
|
|
292
298
|
insertFirst ? : HTMLElement|string
|
|
293
299
|
/**
|
|
@@ -28,6 +28,8 @@ export declare type BryntumFieldFilterPickerProps = {
|
|
|
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/FieldFilterPicker#config-appendTo)
|
|
31
33
|
*/
|
|
32
34
|
appendTo ? : HTMLElement|string
|
|
33
35
|
/**
|
|
@@ -256,10 +258,14 @@ export declare type BryntumFieldFilterPickerProps = {
|
|
|
256
258
|
inputFieldAlign ? : 'start'|'end'
|
|
257
259
|
/**
|
|
258
260
|
* 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.
|
|
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/FieldFilterPicker#config-insertBefore)
|
|
259
263
|
*/
|
|
260
264
|
insertBefore ? : HTMLElement|string
|
|
261
265
|
/**
|
|
262
266
|
* 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.
|
|
267
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
268
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker#config-insertFirst)
|
|
263
269
|
*/
|
|
264
270
|
insertFirst ? : HTMLElement|string
|
|
265
271
|
/**
|
|
@@ -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/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/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/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/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/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 }) =>
|
|
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 }) =>
|
|
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 }) =>
|
|
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)
|
|
@@ -28,6 +28,8 @@ export declare type BryntumFieldSetProps = {
|
|
|
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/FieldSet#config-appendTo)
|
|
31
33
|
*/
|
|
32
34
|
appendTo ? : HTMLElement|string
|
|
33
35
|
/**
|
|
@@ -291,10 +293,14 @@ export declare type BryntumFieldSetProps = {
|
|
|
291
293
|
inputFieldAlign ? : 'start'|'end'
|
|
292
294
|
/**
|
|
293
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/FieldSet#config-insertBefore)
|
|
294
298
|
*/
|
|
295
299
|
insertBefore ? : HTMLElement|string
|
|
296
300
|
/**
|
|
297
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/FieldSet#config-insertFirst)
|
|
298
304
|
*/
|
|
299
305
|
insertFirst ? : HTMLElement|string
|
|
300
306
|
/**
|
|
@@ -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/grid/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/grid/docs/api/Core/widget/Field#property-isValid)
|
|
104
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/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/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
101
112
|
* 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
|
|
@@ -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/grid/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/grid/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 }) =>
|
|
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',
|
|
@@ -33,6 +33,8 @@ export declare type BryntumFileFieldProps = {
|
|
|
33
33
|
/**
|
|
34
34
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
35
35
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
36
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
37
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-appendTo)
|
|
36
38
|
*/
|
|
37
39
|
appendTo ? : HTMLElement|string
|
|
38
40
|
/**
|
|
@@ -82,6 +84,15 @@ export declare type BryntumFileFieldProps = {
|
|
|
82
84
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
83
85
|
*/
|
|
84
86
|
centered ? : Boolean
|
|
87
|
+
/**
|
|
88
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
89
|
+
* 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)
|
|
90
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
91
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-checkValidity)
|
|
92
|
+
* @param {Core.widget.Field} field The field being validated
|
|
93
|
+
* @returns {void}
|
|
94
|
+
*/
|
|
95
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
85
96
|
/**
|
|
86
97
|
* 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
|
|
87
98
|
* 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
|
|
@@ -285,10 +296,14 @@ export declare type BryntumFileFieldProps = {
|
|
|
285
296
|
inputWidth ? : string|number
|
|
286
297
|
/**
|
|
287
298
|
* 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.
|
|
299
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
300
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-insertBefore)
|
|
288
301
|
*/
|
|
289
302
|
insertBefore ? : HTMLElement|string
|
|
290
303
|
/**
|
|
291
304
|
* 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.
|
|
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/FileField#config-insertFirst)
|
|
292
307
|
*/
|
|
293
308
|
insertFirst ? : HTMLElement|string
|
|
294
309
|
/**
|
|
@@ -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/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/grid/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/grid/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 }) =>
|
|
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)
|
|
@@ -28,6 +28,8 @@ export declare type BryntumFilePickerProps = {
|
|
|
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/FilePicker#config-appendTo)
|
|
31
33
|
*/
|
|
32
34
|
appendTo ? : HTMLElement|string
|
|
33
35
|
/**
|
|
@@ -240,10 +242,14 @@ export declare type BryntumFilePickerProps = {
|
|
|
240
242
|
inputFieldAlign ? : 'start'|'end'
|
|
241
243
|
/**
|
|
242
244
|
* 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.
|
|
245
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
246
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilePicker#config-insertBefore)
|
|
243
247
|
*/
|
|
244
248
|
insertBefore ? : HTMLElement|string
|
|
245
249
|
/**
|
|
246
250
|
* 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.
|
|
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/FilePicker#config-insertFirst)
|
|
247
253
|
*/
|
|
248
254
|
insertFirst ? : HTMLElement|string
|
|
249
255
|
/**
|
|
@@ -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/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/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/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/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
|
|
@@ -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/grid/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/grid/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 }) =>
|
|
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',
|
|
@@ -28,6 +28,8 @@ export declare type BryntumFilterFieldProps = {
|
|
|
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/FilterField#config-appendTo)
|
|
31
33
|
*/
|
|
32
34
|
appendTo ? : HTMLElement|string
|
|
33
35
|
/**
|
|
@@ -77,6 +79,15 @@ export declare type BryntumFilterFieldProps = {
|
|
|
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/FilterField#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
|
|
@@ -299,10 +310,14 @@ export declare type BryntumFilterFieldProps = {
|
|
|
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/grid/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/FilterField#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/grid/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/FilterField#config-insertFirst)
|
|
306
321
|
*/
|
|
307
322
|
insertFirst ? : HTMLElement|string
|
|
308
323
|
/**
|