@bryntum/grid-vue-3 7.3.0 → 7.3.1
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 +11 -1
- package/src/components/BryntumAIFilterFieldProps.ts +9 -0
- package/src/components/BryntumBooleanCombo.vue +11 -1
- package/src/components/BryntumBooleanComboProps.ts +9 -0
- package/src/components/BryntumButton.vue +3 -3
- package/src/components/BryntumButtonGroup.vue +1 -1
- package/src/components/BryntumChatPanel.vue +3 -3
- package/src/components/BryntumCheckbox.vue +12 -2
- package/src/components/BryntumCheckboxGroup.vue +3 -3
- package/src/components/BryntumCheckboxProps.ts +9 -0
- package/src/components/BryntumChecklistFilterCombo.vue +11 -1
- package/src/components/BryntumChecklistFilterComboProps.ts +9 -0
- package/src/components/BryntumChipView.vue +2 -2
- package/src/components/BryntumCodeEditor.vue +3 -3
- package/src/components/BryntumColorField.vue +11 -1
- package/src/components/BryntumColorFieldProps.ts +9 -0
- package/src/components/BryntumCombo.vue +11 -1
- package/src/components/BryntumComboProps.ts +9 -0
- package/src/components/BryntumContainer.vue +1 -1
- package/src/components/BryntumDateField.vue +11 -1
- package/src/components/BryntumDateFieldProps.ts +9 -0
- package/src/components/BryntumDatePicker.vue +3 -3
- package/src/components/BryntumDateRangeField.vue +11 -1
- package/src/components/BryntumDateRangeFieldProps.ts +9 -0
- package/src/components/BryntumDateTimeField.vue +11 -1
- package/src/components/BryntumDateTimeFieldProps.ts +9 -0
- package/src/components/BryntumDemoCodeEditor.vue +3 -3
- package/src/components/BryntumDisplayField.vue +11 -1
- package/src/components/BryntumDisplayFieldProps.ts +9 -0
- package/src/components/BryntumDurationField.vue +11 -1
- package/src/components/BryntumDurationFieldProps.ts +9 -0
- package/src/components/BryntumEditor.vue +5 -5
- package/src/components/BryntumFieldFilterPicker.vue +1 -1
- package/src/components/BryntumFieldFilterPickerGroup.vue +2 -2
- package/src/components/BryntumFieldSet.vue +3 -3
- package/src/components/BryntumFileField.vue +11 -1
- package/src/components/BryntumFileFieldProps.ts +9 -0
- package/src/components/BryntumFilePicker.vue +1 -1
- package/src/components/BryntumFilterField.vue +11 -1
- package/src/components/BryntumFilterFieldProps.ts +9 -0
- package/src/components/BryntumGrid.vue +25 -25
- package/src/components/BryntumGridBase.vue +25 -25
- package/src/components/BryntumGridChartDesigner.vue +1 -1
- package/src/components/BryntumGridFieldFilterPicker.vue +1 -1
- package/src/components/BryntumGridFieldFilterPickerGroup.vue +2 -2
- package/src/components/BryntumGroupBar.vue +2 -2
- package/src/components/BryntumHint.vue +3 -3
- package/src/components/BryntumLabel.vue +1 -1
- package/src/components/BryntumList.vue +2 -2
- package/src/components/BryntumMenu.vue +3 -3
- package/src/components/BryntumMonthPicker.vue +3 -3
- package/src/components/BryntumNumberField.vue +11 -1
- package/src/components/BryntumNumberFieldProps.ts +9 -0
- package/src/components/BryntumPagingToolbar.vue +2 -2
- package/src/components/BryntumPanel.vue +3 -3
- package/src/components/BryntumPasswordField.vue +11 -1
- package/src/components/BryntumPasswordFieldProps.ts +9 -0
- package/src/components/BryntumProgressBar.vue +1 -1
- package/src/components/BryntumRadio.vue +12 -2
- package/src/components/BryntumRadioGroup.vue +3 -3
- package/src/components/BryntumRadioProps.ts +9 -0
- package/src/components/BryntumSlideToggle.vue +12 -2
- package/src/components/BryntumSlideToggleProps.ts +9 -0
- package/src/components/BryntumSlider.vue +1 -1
- package/src/components/BryntumSplitter.vue +1 -1
- package/src/components/BryntumTabPanel.vue +4 -4
- package/src/components/BryntumTextAreaField.vue +11 -1
- package/src/components/BryntumTextAreaFieldProps.ts +9 -0
- package/src/components/BryntumTextAreaPickerField.vue +11 -1
- package/src/components/BryntumTextAreaPickerFieldProps.ts +9 -0
- package/src/components/BryntumTextField.vue +11 -1
- package/src/components/BryntumTextFieldProps.ts +9 -0
- package/src/components/BryntumTimeField.vue +11 -1
- package/src/components/BryntumTimeFieldProps.ts +9 -0
- package/src/components/BryntumTimePicker.vue +1 -1
- package/src/components/BryntumToolbar.vue +2 -2
- package/src/components/BryntumTreeCombo.vue +11 -1
- package/src/components/BryntumTreeComboProps.ts +9 -0
- package/src/components/BryntumTreeGrid.vue +25 -25
- package/src/components/BryntumWidget.vue +1 -1
- package/src/components/BryntumYearPicker.vue +3 -3
- 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
|
@@ -97,6 +97,15 @@ defineProps<{
|
|
|
97
97
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-changeOnSpin)
|
|
98
98
|
*/
|
|
99
99
|
changeOnSpin ? : Boolean|number
|
|
100
|
+
/**
|
|
101
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
102
|
+
* 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)
|
|
103
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
104
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-checkValidity)
|
|
105
|
+
* @param {Core.widget.Field} field The field being validated
|
|
106
|
+
* @returns {void}
|
|
107
|
+
*/
|
|
108
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
100
109
|
/**
|
|
101
110
|
* 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
|
|
102
111
|
* 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
|
|
@@ -668,7 +677,7 @@ const emit = defineEmits<{
|
|
|
668
677
|
* @param {object} params.event Event object
|
|
669
678
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
670
679
|
*/
|
|
671
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
680
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
672
681
|
/**
|
|
673
682
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
674
683
|
* @param {string} e Event name
|
|
@@ -842,6 +851,7 @@ const widgetData = {
|
|
|
842
851
|
'bubbleEvents',
|
|
843
852
|
'centered',
|
|
844
853
|
'changeOnSpin',
|
|
854
|
+
'checkValidity',
|
|
845
855
|
'clearable',
|
|
846
856
|
'color',
|
|
847
857
|
'config',
|
|
@@ -83,6 +83,15 @@ export declare type BryntumNumberFieldProps = {
|
|
|
83
83
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-changeOnSpin)
|
|
84
84
|
*/
|
|
85
85
|
changeOnSpin ? : Boolean|number
|
|
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/grid/docs/api/Core/widget/Field#property-isValid)
|
|
89
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
90
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-checkValidity)
|
|
91
|
+
* @param {Core.widget.Field} field The field being validated
|
|
92
|
+
* @returns {void}
|
|
93
|
+
*/
|
|
94
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
86
95
|
/**
|
|
87
96
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
88
97
|
* 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
|
|
@@ -575,7 +575,7 @@ const emit = defineEmits<{
|
|
|
575
575
|
* @param {object} params.event Event object
|
|
576
576
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
577
577
|
*/
|
|
578
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
578
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
579
579
|
/**
|
|
580
580
|
* This event is fired on the owning Toolbar prior to starting a drag gesture. The drag is canceled if
|
|
581
581
|
* a listener returns `false`.
|
|
@@ -586,7 +586,7 @@ const emit = defineEmits<{
|
|
|
586
586
|
* @param {Core.widget.Widget} params.event.item The dragged item.
|
|
587
587
|
* @param {Event} params.event.domEvent The browser event.
|
|
588
588
|
*/
|
|
589
|
-
(e: 'beforeItemDragStart', params: ((event: { source: Toolbar, item: Widget, domEvent: Event }) =>
|
|
589
|
+
(e: 'beforeItemDragStart', params: ((event: { source: Toolbar, item: Widget, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
590
590
|
/**
|
|
591
591
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
592
592
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -653,7 +653,7 @@ const emit = defineEmits<{
|
|
|
653
653
|
* @param {object} params.event Event object
|
|
654
654
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
655
655
|
*/
|
|
656
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
656
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
657
657
|
/**
|
|
658
658
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
659
659
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -679,7 +679,7 @@ const emit = defineEmits<{
|
|
|
679
679
|
* @param {object} params.event Event object
|
|
680
680
|
* @param {any} params.event.state State object config
|
|
681
681
|
*/
|
|
682
|
-
(e: 'beforeStateApply', params: ((event: { state: any }) =>
|
|
682
|
+
(e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
683
683
|
/**
|
|
684
684
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
685
685
|
* @param {string} e Event name
|
|
@@ -687,7 +687,7 @@ const emit = defineEmits<{
|
|
|
687
687
|
* @param {object} params.event Event object
|
|
688
688
|
* @param {any} params.event.state State object config
|
|
689
689
|
*/
|
|
690
|
-
(e: 'beforeStateSave', params: ((event: { state: any }) =>
|
|
690
|
+
(e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
691
691
|
/**
|
|
692
692
|
* Fires when any other event is fired from the object.
|
|
693
693
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#event-catchAll)
|
|
@@ -91,6 +91,15 @@ defineProps<{
|
|
|
91
91
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
92
92
|
*/
|
|
93
93
|
centered ? : Boolean
|
|
94
|
+
/**
|
|
95
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
96
|
+
* 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)
|
|
97
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
98
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-checkValidity)
|
|
99
|
+
* @param {Core.widget.Field} field The field being validated
|
|
100
|
+
* @returns {void}
|
|
101
|
+
*/
|
|
102
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
94
103
|
/**
|
|
95
104
|
* 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
105
|
* 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
|
|
@@ -620,7 +629,7 @@ const emit = defineEmits<{
|
|
|
620
629
|
* @param {object} params.event Event object
|
|
621
630
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
622
631
|
*/
|
|
623
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
632
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
624
633
|
/**
|
|
625
634
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
626
635
|
* @param {string} e Event name
|
|
@@ -793,6 +802,7 @@ const widgetData = {
|
|
|
793
802
|
'autoSelect',
|
|
794
803
|
'bubbleEvents',
|
|
795
804
|
'centered',
|
|
805
|
+
'checkValidity',
|
|
796
806
|
'clearable',
|
|
797
807
|
'color',
|
|
798
808
|
'config',
|
|
@@ -77,6 +77,15 @@ export declare type BryntumPasswordFieldProps = {
|
|
|
77
77
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
78
78
|
*/
|
|
79
79
|
centered ? : Boolean
|
|
80
|
+
/**
|
|
81
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
82
|
+
* 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)
|
|
83
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
84
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-checkValidity)
|
|
85
|
+
* @param {Core.widget.Field} field The field being validated
|
|
86
|
+
* @returns {void}
|
|
87
|
+
*/
|
|
88
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
80
89
|
/**
|
|
81
90
|
* 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
91
|
* 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
|
|
@@ -466,7 +466,7 @@ const emit = defineEmits<{
|
|
|
466
466
|
* @param {object} params.event Event object
|
|
467
467
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
468
468
|
*/
|
|
469
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
469
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
470
470
|
/**
|
|
471
471
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
472
472
|
* @param {string} e Event name
|
|
@@ -108,6 +108,15 @@ defineProps<{
|
|
|
108
108
|
* A value of `undefined` will cause this widget not to include its value when checked.
|
|
109
109
|
*/
|
|
110
110
|
checkedValue ? : any
|
|
111
|
+
/**
|
|
112
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
113
|
+
* 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)
|
|
114
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
115
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-checkValidity)
|
|
116
|
+
* @param {Core.widget.Field} field The field being validated
|
|
117
|
+
* @returns {void}
|
|
118
|
+
*/
|
|
119
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
111
120
|
/**
|
|
112
121
|
* Custom CSS classes to add to element.
|
|
113
122
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -624,7 +633,7 @@ const emit = defineEmits<{
|
|
|
624
633
|
* @param {boolean} params.event.valid True if this field is in a valid state.
|
|
625
634
|
* @param {Event} params.event.event The triggering DOM event if any
|
|
626
635
|
*/
|
|
627
|
-
(e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) =>
|
|
636
|
+
(e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => boolean|void)|string): boolean|void
|
|
628
637
|
/**
|
|
629
638
|
* Fires before an object is destroyed.
|
|
630
639
|
* @param {string} e Event name
|
|
@@ -640,7 +649,7 @@ const emit = defineEmits<{
|
|
|
640
649
|
* @param {object} params.event Event object
|
|
641
650
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
642
651
|
*/
|
|
643
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
652
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
644
653
|
/**
|
|
645
654
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
646
655
|
* @param {string} e Event name
|
|
@@ -824,6 +833,7 @@ const widgetData = {
|
|
|
824
833
|
'bubbleEvents',
|
|
825
834
|
'centered',
|
|
826
835
|
'checkedValue',
|
|
836
|
+
'checkValidity',
|
|
827
837
|
'color',
|
|
828
838
|
'config',
|
|
829
839
|
'constrainTo',
|
|
@@ -691,7 +691,7 @@ const emit = defineEmits<{
|
|
|
691
691
|
* @param {object} params.event Event object
|
|
692
692
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
693
693
|
*/
|
|
694
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
694
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
695
695
|
/**
|
|
696
696
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
697
697
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -717,7 +717,7 @@ const emit = defineEmits<{
|
|
|
717
717
|
* @param {object} params.event Event object
|
|
718
718
|
* @param {any} params.event.state State object config
|
|
719
719
|
*/
|
|
720
|
-
(e: 'beforeStateApply', params: ((event: { state: any }) =>
|
|
720
|
+
(e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
721
721
|
/**
|
|
722
722
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
723
723
|
* @param {string} e Event name
|
|
@@ -725,7 +725,7 @@ const emit = defineEmits<{
|
|
|
725
725
|
* @param {object} params.event Event object
|
|
726
726
|
* @param {any} params.event.state State object config
|
|
727
727
|
*/
|
|
728
|
-
(e: 'beforeStateSave', params: ((event: { state: any }) =>
|
|
728
|
+
(e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
729
729
|
/**
|
|
730
730
|
* Fires when any other event is fired from the object.
|
|
731
731
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#event-catchAll)
|
|
@@ -94,6 +94,15 @@ export declare type BryntumRadioProps = {
|
|
|
94
94
|
* A value of `undefined` will cause this widget not to include its value when checked.
|
|
95
95
|
*/
|
|
96
96
|
checkedValue ? : any
|
|
97
|
+
/**
|
|
98
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
99
|
+
* 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)
|
|
100
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
101
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-checkValidity)
|
|
102
|
+
* @param {Core.widget.Field} field The field being validated
|
|
103
|
+
* @returns {void}
|
|
104
|
+
*/
|
|
105
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
97
106
|
/**
|
|
98
107
|
* Custom CSS classes to add to element.
|
|
99
108
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -108,6 +108,15 @@ defineProps<{
|
|
|
108
108
|
* A value of `undefined` will cause this widget not to include its value when checked.
|
|
109
109
|
*/
|
|
110
110
|
checkedValue ? : any
|
|
111
|
+
/**
|
|
112
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
113
|
+
* 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)
|
|
114
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
115
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-checkValidity)
|
|
116
|
+
* @param {Core.widget.Field} field The field being validated
|
|
117
|
+
* @returns {void}
|
|
118
|
+
*/
|
|
119
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
111
120
|
/**
|
|
112
121
|
* Custom CSS classes to add to element.
|
|
113
122
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -624,7 +633,7 @@ const emit = defineEmits<{
|
|
|
624
633
|
* @param {boolean} params.event.valid True if this field is in a valid state.
|
|
625
634
|
* @param {Event} params.event.event The triggering DOM event if any
|
|
626
635
|
*/
|
|
627
|
-
(e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) =>
|
|
636
|
+
(e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => boolean|void)|string): boolean|void
|
|
628
637
|
/**
|
|
629
638
|
* Fires before an object is destroyed.
|
|
630
639
|
* @param {string} e Event name
|
|
@@ -640,7 +649,7 @@ const emit = defineEmits<{
|
|
|
640
649
|
* @param {object} params.event Event object
|
|
641
650
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
642
651
|
*/
|
|
643
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
652
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
644
653
|
/**
|
|
645
654
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
646
655
|
* @param {string} e Event name
|
|
@@ -824,6 +833,7 @@ const widgetData = {
|
|
|
824
833
|
'bubbleEvents',
|
|
825
834
|
'centered',
|
|
826
835
|
'checkedValue',
|
|
836
|
+
'checkValidity',
|
|
827
837
|
'color',
|
|
828
838
|
'config',
|
|
829
839
|
'constrainTo',
|
|
@@ -94,6 +94,15 @@ export declare type BryntumSlideToggleProps = {
|
|
|
94
94
|
* A value of `undefined` will cause this widget not to include its value when checked.
|
|
95
95
|
*/
|
|
96
96
|
checkedValue ? : any
|
|
97
|
+
/**
|
|
98
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
99
|
+
* 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)
|
|
100
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
101
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-checkValidity)
|
|
102
|
+
* @param {Core.widget.Field} field The field being validated
|
|
103
|
+
* @returns {void}
|
|
104
|
+
*/
|
|
105
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
97
106
|
/**
|
|
98
107
|
* Custom CSS classes to add to element.
|
|
99
108
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -512,7 +512,7 @@ const emit = defineEmits<{
|
|
|
512
512
|
* @param {object} params.event Event object
|
|
513
513
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
514
514
|
*/
|
|
515
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
515
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
516
516
|
/**
|
|
517
517
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
518
518
|
* @param {string} e Event name
|
|
@@ -454,7 +454,7 @@ const emit = defineEmits<{
|
|
|
454
454
|
* @param {object} params.event Event object
|
|
455
455
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
456
456
|
*/
|
|
457
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
457
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
458
458
|
/**
|
|
459
459
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
460
460
|
* @param {string} e Event name
|
|
@@ -678,7 +678,7 @@ const emit = defineEmits<{
|
|
|
678
678
|
* @param {object} params.event Event object
|
|
679
679
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
680
680
|
*/
|
|
681
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
681
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
682
682
|
/**
|
|
683
683
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
684
684
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -704,7 +704,7 @@ const emit = defineEmits<{
|
|
|
704
704
|
* @param {object} params.event Event object
|
|
705
705
|
* @param {any} params.event.state State object config
|
|
706
706
|
*/
|
|
707
|
-
(e: 'beforeStateApply', params: ((event: { state: any }) =>
|
|
707
|
+
(e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
708
708
|
/**
|
|
709
709
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
710
710
|
* @param {string} e Event name
|
|
@@ -712,7 +712,7 @@ const emit = defineEmits<{
|
|
|
712
712
|
* @param {object} params.event Event object
|
|
713
713
|
* @param {any} params.event.state State object config
|
|
714
714
|
*/
|
|
715
|
-
(e: 'beforeStateSave', params: ((event: { state: any }) =>
|
|
715
|
+
(e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
716
716
|
/**
|
|
717
717
|
* The active tab is about to be changed. Return `false` to prevent this.
|
|
718
718
|
* @param {string} e Event name
|
|
@@ -723,7 +723,7 @@ const emit = defineEmits<{
|
|
|
723
723
|
* @param {number} params.event.prevActiveIndex The previous active index.
|
|
724
724
|
* @param {Core.widget.Widget} params.event.prevActiveItem The previous active child widget.
|
|
725
725
|
*/
|
|
726
|
-
(e: 'beforeTabChange', params: ((event: { activeIndex: number, activeItem: Widget, prevActiveIndex: number, prevActiveItem: Widget }) =>
|
|
726
|
+
(e: 'beforeTabChange', params: ((event: { activeIndex: number, activeItem: Widget, prevActiveIndex: number, prevActiveItem: Widget }) => boolean|void)|string): boolean|void
|
|
727
727
|
/**
|
|
728
728
|
* Fires when any other event is fired from the object.
|
|
729
729
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel#event-catchAll)
|
|
@@ -97,6 +97,15 @@ defineProps<{
|
|
|
97
97
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
98
98
|
*/
|
|
99
99
|
centered ? : Boolean
|
|
100
|
+
/**
|
|
101
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
102
|
+
* 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)
|
|
103
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
104
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-checkValidity)
|
|
105
|
+
* @param {Core.widget.Field} field The field being validated
|
|
106
|
+
* @returns {void}
|
|
107
|
+
*/
|
|
108
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
100
109
|
/**
|
|
101
110
|
* 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
|
|
102
111
|
* 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
|
|
@@ -635,7 +644,7 @@ const emit = defineEmits<{
|
|
|
635
644
|
* @param {object} params.event Event object
|
|
636
645
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
637
646
|
*/
|
|
638
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
647
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
639
648
|
/**
|
|
640
649
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
641
650
|
* @param {string} e Event name
|
|
@@ -809,6 +818,7 @@ const widgetData = {
|
|
|
809
818
|
'autoSelect',
|
|
810
819
|
'bubbleEvents',
|
|
811
820
|
'centered',
|
|
821
|
+
'checkValidity',
|
|
812
822
|
'clearable',
|
|
813
823
|
'color',
|
|
814
824
|
'config',
|
|
@@ -83,6 +83,15 @@ export declare type BryntumTextAreaFieldProps = {
|
|
|
83
83
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
84
84
|
*/
|
|
85
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/grid/docs/api/Core/widget/Field#property-isValid)
|
|
89
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
90
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-checkValidity)
|
|
91
|
+
* @param {Core.widget.Field} field The field being validated
|
|
92
|
+
* @returns {void}
|
|
93
|
+
*/
|
|
94
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
86
95
|
/**
|
|
87
96
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
88
97
|
* 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
|
|
@@ -95,6 +95,15 @@ defineProps<{
|
|
|
95
95
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
96
96
|
*/
|
|
97
97
|
centered ? : Boolean
|
|
98
|
+
/**
|
|
99
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
100
|
+
* 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)
|
|
101
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
102
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaPickerField#config-checkValidity)
|
|
103
|
+
* @param {Core.widget.Field} field The field being validated
|
|
104
|
+
* @returns {void}
|
|
105
|
+
*/
|
|
106
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
98
107
|
/**
|
|
99
108
|
* 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
|
|
100
109
|
* 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
|
|
@@ -644,7 +653,7 @@ const emit = defineEmits<{
|
|
|
644
653
|
* @param {object} params.event Event object
|
|
645
654
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
646
655
|
*/
|
|
647
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
656
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
648
657
|
/**
|
|
649
658
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
650
659
|
* @param {string} e Event name
|
|
@@ -818,6 +827,7 @@ const widgetData = {
|
|
|
818
827
|
'autoSelect',
|
|
819
828
|
'bubbleEvents',
|
|
820
829
|
'centered',
|
|
830
|
+
'checkValidity',
|
|
821
831
|
'clearable',
|
|
822
832
|
'color',
|
|
823
833
|
'config',
|
|
@@ -81,6 +81,15 @@ export declare type BryntumTextAreaPickerFieldProps = {
|
|
|
81
81
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
82
82
|
*/
|
|
83
83
|
centered ? : Boolean
|
|
84
|
+
/**
|
|
85
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
86
|
+
* 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)
|
|
87
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
88
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaPickerField#config-checkValidity)
|
|
89
|
+
* @param {Core.widget.Field} field The field being validated
|
|
90
|
+
* @returns {void}
|
|
91
|
+
*/
|
|
92
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
84
93
|
/**
|
|
85
94
|
* 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
|
|
86
95
|
* 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
|
|
@@ -91,6 +91,15 @@ defineProps<{
|
|
|
91
91
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
92
92
|
*/
|
|
93
93
|
centered ? : Boolean
|
|
94
|
+
/**
|
|
95
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
96
|
+
* 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)
|
|
97
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
98
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-checkValidity)
|
|
99
|
+
* @param {Core.widget.Field} field The field being validated
|
|
100
|
+
* @returns {void}
|
|
101
|
+
*/
|
|
102
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
94
103
|
/**
|
|
95
104
|
* 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
105
|
* 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
|
|
@@ -633,7 +642,7 @@ const emit = defineEmits<{
|
|
|
633
642
|
* @param {object} params.event Event object
|
|
634
643
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
635
644
|
*/
|
|
636
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
645
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
637
646
|
/**
|
|
638
647
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
639
648
|
* @param {string} e Event name
|
|
@@ -806,6 +815,7 @@ const widgetData = {
|
|
|
806
815
|
'autoSelect',
|
|
807
816
|
'bubbleEvents',
|
|
808
817
|
'centered',
|
|
818
|
+
'checkValidity',
|
|
809
819
|
'clearable',
|
|
810
820
|
'color',
|
|
811
821
|
'config',
|
|
@@ -77,6 +77,15 @@ export declare type BryntumTextFieldProps = {
|
|
|
77
77
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
78
78
|
*/
|
|
79
79
|
centered ? : Boolean
|
|
80
|
+
/**
|
|
81
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
82
|
+
* 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)
|
|
83
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
84
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-checkValidity)
|
|
85
|
+
* @param {Core.widget.Field} field The field being validated
|
|
86
|
+
* @returns {void}
|
|
87
|
+
*/
|
|
88
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
80
89
|
/**
|
|
81
90
|
* 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
91
|
* 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
|
|
@@ -95,6 +95,15 @@ defineProps<{
|
|
|
95
95
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
96
96
|
*/
|
|
97
97
|
centered ? : Boolean
|
|
98
|
+
/**
|
|
99
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
100
|
+
* 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)
|
|
101
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
102
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-checkValidity)
|
|
103
|
+
* @param {Core.widget.Field} field The field being validated
|
|
104
|
+
* @returns {void}
|
|
105
|
+
*/
|
|
106
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
98
107
|
/**
|
|
99
108
|
* 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
|
|
100
109
|
* 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
|
|
@@ -685,7 +694,7 @@ const emit = defineEmits<{
|
|
|
685
694
|
* @param {object} params.event Event object
|
|
686
695
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
687
696
|
*/
|
|
688
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
697
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
689
698
|
/**
|
|
690
699
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
691
700
|
* @param {string} e Event name
|
|
@@ -859,6 +868,7 @@ const widgetData = {
|
|
|
859
868
|
'autoSelect',
|
|
860
869
|
'bubbleEvents',
|
|
861
870
|
'centered',
|
|
871
|
+
'checkValidity',
|
|
862
872
|
'clearable',
|
|
863
873
|
'color',
|
|
864
874
|
'config',
|
|
@@ -81,6 +81,15 @@ export declare type BryntumTimeFieldProps = {
|
|
|
81
81
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
82
82
|
*/
|
|
83
83
|
centered ? : Boolean
|
|
84
|
+
/**
|
|
85
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
86
|
+
* 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)
|
|
87
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
88
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-checkValidity)
|
|
89
|
+
* @param {Core.widget.Field} field The field being validated
|
|
90
|
+
* @returns {void}
|
|
91
|
+
*/
|
|
92
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
84
93
|
/**
|
|
85
94
|
* 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
|
|
86
95
|
* 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
|
|
@@ -567,7 +567,7 @@ const emit = defineEmits<{
|
|
|
567
567
|
* @param {object} params.event Event object
|
|
568
568
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
569
569
|
*/
|
|
570
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
570
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
571
571
|
/**
|
|
572
572
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
573
573
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -569,7 +569,7 @@ const emit = defineEmits<{
|
|
|
569
569
|
* @param {object} params.event Event object
|
|
570
570
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
571
571
|
*/
|
|
572
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
572
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
573
573
|
/**
|
|
574
574
|
* This event is fired on the owning Toolbar prior to starting a drag gesture. The drag is canceled if
|
|
575
575
|
* a listener returns `false`.
|
|
@@ -580,7 +580,7 @@ const emit = defineEmits<{
|
|
|
580
580
|
* @param {Core.widget.Widget} params.event.item The dragged item.
|
|
581
581
|
* @param {Event} params.event.domEvent The browser event.
|
|
582
582
|
*/
|
|
583
|
-
(e: 'beforeItemDragStart', params: ((event: { source: Toolbar, item: Widget, domEvent: Event }) =>
|
|
583
|
+
(e: 'beforeItemDragStart', params: ((event: { source: Toolbar, item: Widget, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
584
584
|
/**
|
|
585
585
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
586
586
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|