@bryntum/core-vue-3-thin 7.3.0 → 7.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/chunks/-8Xai_9S.js.map +1 -1
- package/lib/chunks/47-V2ACd.js.map +1 -1
- package/lib/chunks/ASihDjXw.js.map +1 -1
- package/lib/chunks/B7KhcgPC.js.map +1 -1
- package/lib/chunks/B8KGPeHy.js.map +1 -1
- package/lib/chunks/BB8tOII_.js.map +1 -1
- package/lib/chunks/{S9XwH6IJ.js → BEX7SIci.js} +6 -4
- package/lib/chunks/BEX7SIci.js.map +1 -0
- package/lib/chunks/BFNWOtf2.js.map +1 -1
- package/lib/chunks/BG7E4-sX.js.map +1 -1
- package/lib/chunks/{BKLWvKPc.js → BH9WVqFa.js} +12 -10
- package/lib/chunks/BH9WVqFa.js.map +1 -0
- package/lib/chunks/{naTVDWnB.js → BOGE5pxL.js} +13 -11
- package/lib/chunks/BOGE5pxL.js.map +1 -0
- package/lib/chunks/{C14dvV95.js → BQikt_g7.js} +10 -8
- package/lib/chunks/BQikt_g7.js.map +1 -0
- package/lib/chunks/{C0-E5hnK.js → BWPcUxSk.js} +9 -7
- package/lib/chunks/BWPcUxSk.js.map +1 -0
- package/lib/chunks/{D7CJcnRV.js → BmrPNTUZ.js} +9 -7
- package/lib/chunks/BmrPNTUZ.js.map +1 -0
- package/lib/chunks/{DRz-V3LT.js → Bpq-_L_J.js} +11 -9
- package/lib/chunks/Bpq-_L_J.js.map +1 -0
- package/lib/chunks/Brp0NyFN.js.map +1 -1
- package/lib/chunks/{qkwwWpWo.js → BuQqXOvY.js} +6 -4
- package/lib/chunks/BuQqXOvY.js.map +1 -0
- package/lib/chunks/{BPANMXC6.js → ByuztLAT.js} +11 -9
- package/lib/chunks/ByuztLAT.js.map +1 -0
- package/lib/chunks/C0JI13dO.js.map +1 -1
- package/lib/chunks/C8pe1IyH.js.map +1 -1
- package/lib/chunks/C987g-kK.js.map +1 -1
- package/lib/chunks/CLqf-0PN.js.map +1 -1
- package/lib/chunks/CQwgnD9q.js.map +1 -1
- package/lib/chunks/{HOklxqtO.js → CXEKQ18L.js} +9 -7
- package/lib/chunks/CXEKQ18L.js.map +1 -0
- package/lib/chunks/Cd9NJP1W.js.map +1 -1
- package/lib/chunks/{BrRBMti3.js → CfCbZPht.js} +9 -7
- package/lib/chunks/CfCbZPht.js.map +1 -0
- package/lib/chunks/{ChAWW3Iy.js → CpVLgWPj.js} +9 -7
- package/lib/chunks/CpVLgWPj.js.map +1 -0
- package/lib/chunks/Csirfhz_.js.map +1 -1
- package/lib/chunks/Cz2JtuJX.js.map +1 -1
- package/lib/chunks/D6JcA9Zt.js.map +1 -1
- package/lib/chunks/{CUFZWGAX.js → DCcctqdo.js} +5 -3
- package/lib/chunks/DCcctqdo.js.map +1 -0
- package/lib/chunks/{ToClygqb.js → DNScKbAm.js} +9 -7
- package/lib/chunks/DNScKbAm.js.map +1 -0
- package/lib/chunks/DNTQukmL.js.map +1 -1
- package/lib/chunks/{BeXQ7RhD.js → DOp4_ZR2.js} +7 -5
- package/lib/chunks/DOp4_ZR2.js.map +1 -0
- package/lib/chunks/DQLfwhka.js.map +1 -1
- package/lib/chunks/DR_RL3ms.js.map +1 -1
- package/lib/chunks/Dg7wbkjL.js.map +1 -1
- package/lib/chunks/{DuiOZGf5.js → DgXr7-Gj.js} +9 -7
- package/lib/chunks/DgXr7-Gj.js.map +1 -0
- package/lib/chunks/DhOHvb1Z.js.map +1 -1
- package/lib/chunks/Hu7IhLgO.js.map +1 -1
- package/lib/chunks/WGJj3T9m.js.map +1 -1
- package/lib/chunks/Wh7gYeFQ.js.map +1 -1
- package/lib/chunks/YAeyT4qi.js.map +1 -1
- package/lib/chunks/boSXkG-m.js.map +1 -1
- package/lib/chunks/{DAfGAAbO.js → lQtECawa.js} +10 -8
- package/lib/chunks/lQtECawa.js.map +1 -0
- package/lib/chunks/{B_aqRSp2.js → vcFE80xr.js} +14 -12
- package/lib/chunks/vcFE80xr.js.map +1 -0
- package/lib/chunks/{IjqHT_Qc.js → xYFGvsOR.js} +9 -7
- package/lib/chunks/xYFGvsOR.js.map +1 -0
- package/lib/chunks/zIlWjejC.js.map +1 -1
- package/lib/chunks/ztxFXigG.js.map +1 -1
- package/lib/components/BryntumBooleanCombo.js +1 -1
- package/lib/components/BryntumCheckbox.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/index.js +19 -19
- package/package.json +1 -1
- 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/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/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/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/BKLWvKPc.js.map +0 -1
- package/lib/chunks/BPANMXC6.js.map +0 -1
- package/lib/chunks/B_aqRSp2.js.map +0 -1
- package/lib/chunks/BeXQ7RhD.js.map +0 -1
- package/lib/chunks/BrRBMti3.js.map +0 -1
- package/lib/chunks/C0-E5hnK.js.map +0 -1
- package/lib/chunks/C14dvV95.js.map +0 -1
- package/lib/chunks/CUFZWGAX.js.map +0 -1
- package/lib/chunks/ChAWW3Iy.js.map +0 -1
- package/lib/chunks/D7CJcnRV.js.map +0 -1
- package/lib/chunks/DAfGAAbO.js.map +0 -1
- package/lib/chunks/DRz-V3LT.js.map +0 -1
- package/lib/chunks/DuiOZGf5.js.map +0 -1
- package/lib/chunks/HOklxqtO.js.map +0 -1
- package/lib/chunks/IjqHT_Qc.js.map +0 -1
- package/lib/chunks/S9XwH6IJ.js.map +0 -1
- package/lib/chunks/ToClygqb.js.map +0 -1
- package/lib/chunks/naTVDWnB.js.map +0 -1
- package/lib/chunks/qkwwWpWo.js.map +0 -1
|
@@ -42,6 +42,8 @@ defineProps<{
|
|
|
42
42
|
/**
|
|
43
43
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
44
44
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
45
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-appendTo)
|
|
45
47
|
*/
|
|
46
48
|
appendTo ? : HTMLElement|string
|
|
47
49
|
/**
|
|
@@ -104,6 +106,15 @@ defineProps<{
|
|
|
104
106
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
105
107
|
*/
|
|
106
108
|
centered ? : Boolean
|
|
109
|
+
/**
|
|
110
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
111
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
|
|
112
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
113
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-checkValidity)
|
|
114
|
+
* @param {Core.widget.Field} field The field being validated
|
|
115
|
+
* @returns {void}
|
|
116
|
+
*/
|
|
117
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
107
118
|
/**
|
|
108
119
|
* A config object to configure the [ChipView](https://bryntum.com/products/core/docs/api/Core/widget/ChipView) to display the
|
|
109
120
|
* selected value set when [multiSelect](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -397,10 +408,14 @@ defineProps<{
|
|
|
397
408
|
inputWidth ? : string|number
|
|
398
409
|
/**
|
|
399
410
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
411
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
412
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-insertBefore)
|
|
400
413
|
*/
|
|
401
414
|
insertBefore ? : HTMLElement|string
|
|
402
415
|
/**
|
|
403
416
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
417
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
418
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-insertFirst)
|
|
404
419
|
*/
|
|
405
420
|
insertFirst ? : HTMLElement|string
|
|
406
421
|
/**
|
|
@@ -830,7 +845,7 @@ const emit = defineEmits<{
|
|
|
830
845
|
* @param {object} params.event Event object
|
|
831
846
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
832
847
|
*/
|
|
833
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
848
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
834
849
|
/**
|
|
835
850
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
836
851
|
* @param {string} e Event name
|
|
@@ -1018,6 +1033,7 @@ const widgetData = {
|
|
|
1018
1033
|
'cacheLastResult',
|
|
1019
1034
|
'caseSensitive',
|
|
1020
1035
|
'centered',
|
|
1036
|
+
'checkValidity',
|
|
1021
1037
|
'chipView',
|
|
1022
1038
|
'clearable',
|
|
1023
1039
|
'clearTextOnPickerHide',
|
|
@@ -27,6 +27,8 @@ export declare type BryntumBooleanComboProps = {
|
|
|
27
27
|
/**
|
|
28
28
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
29
29
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
30
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
31
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-appendTo)
|
|
30
32
|
*/
|
|
31
33
|
appendTo ? : HTMLElement|string
|
|
32
34
|
/**
|
|
@@ -89,6 +91,15 @@ export declare type BryntumBooleanComboProps = {
|
|
|
89
91
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
90
92
|
*/
|
|
91
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/core/docs/api/Core/widget/Field#property-isValid)
|
|
97
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
98
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-checkValidity)
|
|
99
|
+
* @param {Core.widget.Field} field The field being validated
|
|
100
|
+
* @returns {void}
|
|
101
|
+
*/
|
|
102
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
92
103
|
/**
|
|
93
104
|
* A config object to configure the [ChipView](https://bryntum.com/products/core/docs/api/Core/widget/ChipView) to display the
|
|
94
105
|
* selected value set when [multiSelect](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -382,10 +393,14 @@ export declare type BryntumBooleanComboProps = {
|
|
|
382
393
|
inputWidth ? : string|number
|
|
383
394
|
/**
|
|
384
395
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
396
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
397
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-insertBefore)
|
|
385
398
|
*/
|
|
386
399
|
insertBefore ? : HTMLElement|string
|
|
387
400
|
/**
|
|
388
401
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
402
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
403
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-insertFirst)
|
|
389
404
|
*/
|
|
390
405
|
insertFirst ? : HTMLElement|string
|
|
391
406
|
/**
|
|
@@ -42,6 +42,8 @@ defineProps<{
|
|
|
42
42
|
/**
|
|
43
43
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
44
44
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
45
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-appendTo)
|
|
45
47
|
*/
|
|
46
48
|
appendTo ? : HTMLElement|string
|
|
47
49
|
/**
|
|
@@ -235,10 +237,14 @@ defineProps<{
|
|
|
235
237
|
ignoreParentReadOnly ? : Boolean
|
|
236
238
|
/**
|
|
237
239
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
240
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
241
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-insertBefore)
|
|
238
242
|
*/
|
|
239
243
|
insertBefore ? : HTMLElement|string
|
|
240
244
|
/**
|
|
241
245
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
246
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
247
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-insertFirst)
|
|
242
248
|
*/
|
|
243
249
|
insertFirst ? : HTMLElement|string
|
|
244
250
|
/**
|
|
@@ -544,7 +550,7 @@ const emit = defineEmits<{
|
|
|
544
550
|
* @param {object} params.event Event object
|
|
545
551
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
546
552
|
*/
|
|
547
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
553
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
548
554
|
/**
|
|
549
555
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
550
556
|
* @param {string} e Event name
|
|
@@ -563,7 +569,7 @@ const emit = defineEmits<{
|
|
|
563
569
|
* @param {boolean} params.event.userAction `true` if the toggle was triggered by a user action (click), `false` if it was triggered programmatically.
|
|
564
570
|
* @param {Event} params.event.domEvent The original DOM event that triggered the action, if any. Using the `pointerType` property of this event can help determine if it was a mouse, touch or pen action.
|
|
565
571
|
*/
|
|
566
|
-
(e: 'beforeShowMenu', params: ((event: { source: Button, menu: Menu, userAction: boolean, domEvent: Event }) =>
|
|
572
|
+
(e: 'beforeShowMenu', params: ((event: { source: Button, menu: Menu, userAction: boolean, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
567
573
|
/**
|
|
568
574
|
* Fires before the button is toggled (the [pressed](https://bryntum.com/products/core/docs/api/Core/widget/Button#property-pressed) state is changed). If the button is part of
|
|
569
575
|
* a [toggleGroup](https://bryntum.com/products/core/docs/api/Core/widget/Button#config-toggleGroup) and you need to process the pressed button only, consider using
|
|
@@ -577,7 +583,7 @@ const emit = defineEmits<{
|
|
|
577
583
|
* @param {boolean} params.event.userAction `true` if the toggle was triggered by a user action (click), `false` if it was triggered programmatically.
|
|
578
584
|
* @param {Event} params.event.domEvent The original DOM event that triggered the action, if any. Using the `pointerType` property of this event can help determine if it was a mouse, touch or pen action.
|
|
579
585
|
*/
|
|
580
|
-
(e: 'beforeToggle', params: ((event: { source: Button, pressed: boolean, userAction: boolean, domEvent: Event }) =>
|
|
586
|
+
(e: 'beforeToggle', params: ((event: { source: Button, pressed: boolean, userAction: boolean, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
581
587
|
/**
|
|
582
588
|
* Fires when any other event is fired from the object.
|
|
583
589
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#event-catchAll)
|
|
@@ -42,6 +42,8 @@ defineProps<{
|
|
|
42
42
|
/**
|
|
43
43
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
44
44
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
45
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ButtonGroup#config-appendTo)
|
|
45
47
|
*/
|
|
46
48
|
appendTo ? : HTMLElement|string
|
|
47
49
|
/**
|
|
@@ -243,10 +245,14 @@ defineProps<{
|
|
|
243
245
|
inputFieldAlign ? : 'start'|'end'
|
|
244
246
|
/**
|
|
245
247
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
248
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
249
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ButtonGroup#config-insertBefore)
|
|
246
250
|
*/
|
|
247
251
|
insertBefore ? : HTMLElement|string
|
|
248
252
|
/**
|
|
249
253
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
254
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
255
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ButtonGroup#config-insertFirst)
|
|
250
256
|
*/
|
|
251
257
|
insertFirst ? : HTMLElement|string
|
|
252
258
|
/**
|
|
@@ -569,7 +575,7 @@ const emit = defineEmits<{
|
|
|
569
575
|
* @param {object} params.event Event object
|
|
570
576
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
571
577
|
*/
|
|
572
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
578
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
573
579
|
/**
|
|
574
580
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
575
581
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -27,6 +27,8 @@ export declare type BryntumButtonGroupProps = {
|
|
|
27
27
|
/**
|
|
28
28
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
29
29
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
30
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
31
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ButtonGroup#config-appendTo)
|
|
30
32
|
*/
|
|
31
33
|
appendTo ? : HTMLElement|string
|
|
32
34
|
/**
|
|
@@ -228,10 +230,14 @@ export declare type BryntumButtonGroupProps = {
|
|
|
228
230
|
inputFieldAlign ? : 'start'|'end'
|
|
229
231
|
/**
|
|
230
232
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
233
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
234
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ButtonGroup#config-insertBefore)
|
|
231
235
|
*/
|
|
232
236
|
insertBefore ? : HTMLElement|string
|
|
233
237
|
/**
|
|
234
238
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
239
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
240
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ButtonGroup#config-insertFirst)
|
|
235
241
|
*/
|
|
236
242
|
insertFirst ? : HTMLElement|string
|
|
237
243
|
/**
|
|
@@ -27,6 +27,8 @@ export declare type BryntumButtonProps = {
|
|
|
27
27
|
/**
|
|
28
28
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
29
29
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
30
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
31
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-appendTo)
|
|
30
32
|
*/
|
|
31
33
|
appendTo ? : HTMLElement|string
|
|
32
34
|
/**
|
|
@@ -220,10 +222,14 @@ export declare type BryntumButtonProps = {
|
|
|
220
222
|
ignoreParentReadOnly ? : Boolean
|
|
221
223
|
/**
|
|
222
224
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
225
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
226
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-insertBefore)
|
|
223
227
|
*/
|
|
224
228
|
insertBefore ? : HTMLElement|string
|
|
225
229
|
/**
|
|
226
230
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
231
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
232
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-insertFirst)
|
|
227
233
|
*/
|
|
228
234
|
insertFirst ? : HTMLElement|string
|
|
229
235
|
/**
|
|
@@ -46,6 +46,8 @@ defineProps<{
|
|
|
46
46
|
/**
|
|
47
47
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
48
48
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
49
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
50
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-appendTo)
|
|
49
51
|
*/
|
|
50
52
|
appendTo ? : HTMLElement|string
|
|
51
53
|
/**
|
|
@@ -318,10 +320,14 @@ defineProps<{
|
|
|
318
320
|
inputFieldAlign ? : 'start'|'end'
|
|
319
321
|
/**
|
|
320
322
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
323
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
324
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-insertBefore)
|
|
321
325
|
*/
|
|
322
326
|
insertBefore ? : HTMLElement|string
|
|
323
327
|
/**
|
|
324
328
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
329
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
330
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-insertFirst)
|
|
325
331
|
*/
|
|
326
332
|
insertFirst ? : HTMLElement|string
|
|
327
333
|
/**
|
|
@@ -696,7 +702,7 @@ const emit = defineEmits<{
|
|
|
696
702
|
* @param {object} params.event Event object
|
|
697
703
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
698
704
|
*/
|
|
699
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
705
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
700
706
|
/**
|
|
701
707
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
702
708
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -722,7 +728,7 @@ const emit = defineEmits<{
|
|
|
722
728
|
* @param {object} params.event Event object
|
|
723
729
|
* @param {any} params.event.state State object config
|
|
724
730
|
*/
|
|
725
|
-
(e: 'beforeStateApply', params: ((event: { state: any }) =>
|
|
731
|
+
(e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
726
732
|
/**
|
|
727
733
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
728
734
|
* @param {string} e Event name
|
|
@@ -730,7 +736,7 @@ const emit = defineEmits<{
|
|
|
730
736
|
* @param {object} params.event Event object
|
|
731
737
|
* @param {any} params.event.state State object config
|
|
732
738
|
*/
|
|
733
|
-
(e: 'beforeStateSave', params: ((event: { state: any }) =>
|
|
739
|
+
(e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
734
740
|
/**
|
|
735
741
|
* Fired when the chat bubble tool icon is clicked.
|
|
736
742
|
* @param {string} e Event name
|
|
@@ -31,6 +31,8 @@ export declare type BryntumChatPanelProps = {
|
|
|
31
31
|
/**
|
|
32
32
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
33
33
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
34
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
35
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-appendTo)
|
|
34
36
|
*/
|
|
35
37
|
appendTo ? : HTMLElement|string
|
|
36
38
|
/**
|
|
@@ -303,10 +305,14 @@ export declare type BryntumChatPanelProps = {
|
|
|
303
305
|
inputFieldAlign ? : 'start'|'end'
|
|
304
306
|
/**
|
|
305
307
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
308
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
309
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-insertBefore)
|
|
306
310
|
*/
|
|
307
311
|
insertBefore ? : HTMLElement|string
|
|
308
312
|
/**
|
|
309
313
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
314
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
315
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-insertFirst)
|
|
310
316
|
*/
|
|
311
317
|
insertFirst ? : HTMLElement|string
|
|
312
318
|
/**
|
|
@@ -42,6 +42,8 @@ defineProps<{
|
|
|
42
42
|
/**
|
|
43
43
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
44
44
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
45
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox#config-appendTo)
|
|
45
47
|
*/
|
|
46
48
|
appendTo ? : HTMLElement|string
|
|
47
49
|
/**
|
|
@@ -108,6 +110,15 @@ defineProps<{
|
|
|
108
110
|
* A value of `undefined` will cause this widget not to include its value when checked.
|
|
109
111
|
*/
|
|
110
112
|
checkedValue ? : any
|
|
113
|
+
/**
|
|
114
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
115
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
|
|
116
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
117
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox#config-checkValidity)
|
|
118
|
+
* @param {Core.widget.Field} field The field being validated
|
|
119
|
+
* @returns {void}
|
|
120
|
+
*/
|
|
121
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
111
122
|
/**
|
|
112
123
|
* Custom CSS classes to add to element.
|
|
113
124
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -296,10 +307,14 @@ defineProps<{
|
|
|
296
307
|
inputWidth ? : string|number
|
|
297
308
|
/**
|
|
298
309
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
310
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
311
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox#config-insertBefore)
|
|
299
312
|
*/
|
|
300
313
|
insertBefore ? : HTMLElement|string
|
|
301
314
|
/**
|
|
302
315
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
316
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
317
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox#config-insertFirst)
|
|
303
318
|
*/
|
|
304
319
|
insertFirst ? : HTMLElement|string
|
|
305
320
|
/**
|
|
@@ -624,7 +639,7 @@ const emit = defineEmits<{
|
|
|
624
639
|
* @param {boolean} params.event.valid True if this field is in a valid state.
|
|
625
640
|
* @param {Event} params.event.event The triggering DOM event if any
|
|
626
641
|
*/
|
|
627
|
-
(e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) =>
|
|
642
|
+
(e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => boolean|void)|string): boolean|void
|
|
628
643
|
/**
|
|
629
644
|
* Fires before an object is destroyed.
|
|
630
645
|
* @param {string} e Event name
|
|
@@ -640,7 +655,7 @@ const emit = defineEmits<{
|
|
|
640
655
|
* @param {object} params.event Event object
|
|
641
656
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
642
657
|
*/
|
|
643
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
658
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
644
659
|
/**
|
|
645
660
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
646
661
|
* @param {string} e Event name
|
|
@@ -824,6 +839,7 @@ const widgetData = {
|
|
|
824
839
|
'bubbleEvents',
|
|
825
840
|
'centered',
|
|
826
841
|
'checkedValue',
|
|
842
|
+
'checkValidity',
|
|
827
843
|
'color',
|
|
828
844
|
'config',
|
|
829
845
|
'constrainTo',
|
|
@@ -42,6 +42,8 @@ defineProps<{
|
|
|
42
42
|
/**
|
|
43
43
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
44
44
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
45
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-appendTo)
|
|
45
47
|
*/
|
|
46
48
|
appendTo ? : HTMLElement|string
|
|
47
49
|
/**
|
|
@@ -305,10 +307,14 @@ defineProps<{
|
|
|
305
307
|
inputFieldAlign ? : 'start'|'end'
|
|
306
308
|
/**
|
|
307
309
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
310
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
311
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-insertBefore)
|
|
308
312
|
*/
|
|
309
313
|
insertBefore ? : HTMLElement|string
|
|
310
314
|
/**
|
|
311
315
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
316
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
317
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-insertFirst)
|
|
312
318
|
*/
|
|
313
319
|
insertFirst ? : HTMLElement|string
|
|
314
320
|
/**
|
|
@@ -709,7 +715,7 @@ const emit = defineEmits<{
|
|
|
709
715
|
* @param {object} params.event Event object
|
|
710
716
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
711
717
|
*/
|
|
712
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
718
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
713
719
|
/**
|
|
714
720
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
715
721
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -735,7 +741,7 @@ const emit = defineEmits<{
|
|
|
735
741
|
* @param {object} params.event Event object
|
|
736
742
|
* @param {any} params.event.state State object config
|
|
737
743
|
*/
|
|
738
|
-
(e: 'beforeStateApply', params: ((event: { state: any }) =>
|
|
744
|
+
(e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
739
745
|
/**
|
|
740
746
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
741
747
|
* @param {string} e Event name
|
|
@@ -743,7 +749,7 @@ const emit = defineEmits<{
|
|
|
743
749
|
* @param {object} params.event Event object
|
|
744
750
|
* @param {any} params.event.state State object config
|
|
745
751
|
*/
|
|
746
|
-
(e: 'beforeStateSave', params: ((event: { state: any }) =>
|
|
752
|
+
(e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
747
753
|
/**
|
|
748
754
|
* Fires when any other event is fired from the object.
|
|
749
755
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#event-catchAll)
|
|
@@ -27,6 +27,8 @@ export declare type BryntumCheckboxGroupProps = {
|
|
|
27
27
|
/**
|
|
28
28
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
29
29
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
30
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
31
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-appendTo)
|
|
30
32
|
*/
|
|
31
33
|
appendTo ? : HTMLElement|string
|
|
32
34
|
/**
|
|
@@ -290,10 +292,14 @@ export declare type BryntumCheckboxGroupProps = {
|
|
|
290
292
|
inputFieldAlign ? : 'start'|'end'
|
|
291
293
|
/**
|
|
292
294
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
295
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
296
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-insertBefore)
|
|
293
297
|
*/
|
|
294
298
|
insertBefore ? : HTMLElement|string
|
|
295
299
|
/**
|
|
296
300
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
301
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
302
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-insertFirst)
|
|
297
303
|
*/
|
|
298
304
|
insertFirst ? : HTMLElement|string
|
|
299
305
|
/**
|
|
@@ -27,6 +27,8 @@ export declare type BryntumCheckboxProps = {
|
|
|
27
27
|
/**
|
|
28
28
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
29
29
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
30
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
31
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox#config-appendTo)
|
|
30
32
|
*/
|
|
31
33
|
appendTo ? : HTMLElement|string
|
|
32
34
|
/**
|
|
@@ -93,6 +95,15 @@ export declare type BryntumCheckboxProps = {
|
|
|
93
95
|
* A value of `undefined` will cause this widget not to include its value when checked.
|
|
94
96
|
*/
|
|
95
97
|
checkedValue ? : any
|
|
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/core/docs/api/Core/widget/Field#property-isValid)
|
|
101
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
102
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox#config-checkValidity)
|
|
103
|
+
* @param {Core.widget.Field} field The field being validated
|
|
104
|
+
* @returns {void}
|
|
105
|
+
*/
|
|
106
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
96
107
|
/**
|
|
97
108
|
* Custom CSS classes to add to element.
|
|
98
109
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -281,10 +292,14 @@ export declare type BryntumCheckboxProps = {
|
|
|
281
292
|
inputWidth ? : string|number
|
|
282
293
|
/**
|
|
283
294
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
295
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
296
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox#config-insertBefore)
|
|
284
297
|
*/
|
|
285
298
|
insertBefore ? : HTMLElement|string
|
|
286
299
|
/**
|
|
287
300
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
301
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
302
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox#config-insertFirst)
|
|
288
303
|
*/
|
|
289
304
|
insertFirst ? : HTMLElement|string
|
|
290
305
|
/**
|
|
@@ -52,6 +52,8 @@ defineProps<{
|
|
|
52
52
|
/**
|
|
53
53
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
54
54
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
55
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
56
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-appendTo)
|
|
55
57
|
*/
|
|
56
58
|
appendTo ? : HTMLElement|string
|
|
57
59
|
/**
|
|
@@ -101,9 +103,11 @@ defineProps<{
|
|
|
101
103
|
/**
|
|
102
104
|
* If [closable](https://bryntum.com/products/core/docs/api/Core/widget/ChipView#config-closable) is `true`, this is the name of a callback function to handle what the "close"
|
|
103
105
|
* action means. If not provided, the record representing the chip is removed from the store.
|
|
106
|
+
* @param {Core.data.Model[]} records Records to be closed
|
|
107
|
+
* @param {object} options Close options
|
|
104
108
|
* @returns {void}
|
|
105
109
|
*/
|
|
106
|
-
closeHandler ? : string|(() => void)
|
|
110
|
+
closeHandler ? : string|((records: Model[], options: object) => void)
|
|
107
111
|
/**
|
|
108
112
|
* Custom CSS classes to add to element.
|
|
109
113
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -280,10 +284,14 @@ defineProps<{
|
|
|
280
284
|
ignoreParentReadOnly ? : Boolean
|
|
281
285
|
/**
|
|
282
286
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
287
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
288
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-insertBefore)
|
|
283
289
|
*/
|
|
284
290
|
insertBefore ? : HTMLElement|string
|
|
285
291
|
/**
|
|
286
292
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
293
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
294
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-insertFirst)
|
|
287
295
|
*/
|
|
288
296
|
insertFirst ? : HTMLElement|string
|
|
289
297
|
/**
|
|
@@ -567,7 +575,7 @@ const emit = defineEmits<{
|
|
|
567
575
|
* @param {object} params.event Event object
|
|
568
576
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
569
577
|
*/
|
|
570
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
578
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
571
579
|
/**
|
|
572
580
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
573
581
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -581,7 +589,7 @@ const emit = defineEmits<{
|
|
|
581
589
|
* @param {number} params.event.index List item index
|
|
582
590
|
* @param {Event} params.event.event Triggering event
|
|
583
591
|
*/
|
|
584
|
-
(e: 'beforeItem', params: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
592
|
+
(e: 'beforeItem', params: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string): boolean|void
|
|
585
593
|
/**
|
|
586
594
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
587
595
|
* @param {string} e Event name
|
|
@@ -37,6 +37,8 @@ export declare type BryntumChipViewProps = {
|
|
|
37
37
|
/**
|
|
38
38
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
39
39
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
40
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
41
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-appendTo)
|
|
40
42
|
*/
|
|
41
43
|
appendTo ? : HTMLElement|string
|
|
42
44
|
/**
|
|
@@ -86,9 +88,11 @@ export declare type BryntumChipViewProps = {
|
|
|
86
88
|
/**
|
|
87
89
|
* If [closable](https://bryntum.com/products/core/docs/api/Core/widget/ChipView#config-closable) is `true`, this is the name of a callback function to handle what the "close"
|
|
88
90
|
* action means. If not provided, the record representing the chip is removed from the store.
|
|
91
|
+
* @param {Core.data.Model[]} records Records to be closed
|
|
92
|
+
* @param {object} options Close options
|
|
89
93
|
* @returns {void}
|
|
90
94
|
*/
|
|
91
|
-
closeHandler ? : string|(() => void)
|
|
95
|
+
closeHandler ? : string|((records: Model[], options: object) => void)
|
|
92
96
|
/**
|
|
93
97
|
* Custom CSS classes to add to element.
|
|
94
98
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -265,10 +269,14 @@ export declare type BryntumChipViewProps = {
|
|
|
265
269
|
ignoreParentReadOnly ? : Boolean
|
|
266
270
|
/**
|
|
267
271
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
272
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
273
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-insertBefore)
|
|
268
274
|
*/
|
|
269
275
|
insertBefore ? : HTMLElement|string
|
|
270
276
|
/**
|
|
271
277
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
278
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
279
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-insertFirst)
|
|
272
280
|
*/
|
|
273
281
|
insertFirst ? : HTMLElement|string
|
|
274
282
|
/**
|