@bryntum/calendar-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/README.md +1 -1
- package/lib/chunks/-gfCfICt.js.map +1 -1
- package/lib/chunks/{BBmKbcBm.js → 0OZOSj3K.js} +11 -9
- package/lib/chunks/0OZOSj3K.js.map +1 -0
- package/lib/chunks/{DQEdPoQo.js → 6ysIOAeQ.js} +9 -7
- package/lib/chunks/6ysIOAeQ.js.map +1 -0
- package/lib/chunks/8f6XqGsD.js.map +1 -1
- package/lib/chunks/9tApH0if.js.map +1 -1
- package/lib/chunks/AVadRojY.js.map +1 -1
- package/lib/chunks/B4eYsje_.js.map +1 -1
- package/lib/chunks/{CPHxjIqw.js → B7wodVs1.js} +9 -7
- package/lib/chunks/B7wodVs1.js.map +1 -0
- package/lib/chunks/BBc3kJ2l.js.map +1 -1
- package/lib/chunks/BD3V-SxA.js.map +1 -1
- package/lib/chunks/{DURERga3.js → BFQMFysc.js} +6 -4
- package/lib/chunks/BFQMFysc.js.map +1 -0
- package/lib/chunks/BHB_Xr7B.js.map +1 -1
- package/lib/chunks/BRHH9-fs.js.map +1 -1
- package/lib/chunks/{DxT4VIUT.js → BSTFzAku.js} +3 -1
- package/lib/chunks/BSTFzAku.js.map +1 -0
- package/lib/chunks/BUTdFPf9.js.map +1 -1
- package/lib/chunks/BVEipTu4.js.map +1 -1
- package/lib/chunks/BYLyV5Qz.js.map +1 -1
- package/lib/chunks/BbOrQ8ft.js.map +1 -1
- package/lib/chunks/{DzuHthMw.js → BdoTFJhe.js} +9 -7
- package/lib/chunks/BdoTFJhe.js.map +1 -0
- package/lib/chunks/{j6GbzQ11.js → BeA4Wx8Y.js} +12 -10
- package/lib/chunks/BeA4Wx8Y.js.map +1 -0
- package/lib/chunks/{JKRtgYCJ.js → BeiCK7f8.js} +9 -7
- package/lib/chunks/BeiCK7f8.js.map +1 -0
- package/lib/chunks/BoILvqhB.js.map +1 -1
- package/lib/chunks/{BKPgz4z1.js → C-rJdjwM.js} +14 -12
- package/lib/chunks/C-rJdjwM.js.map +1 -0
- package/lib/chunks/C1e81geK.js.map +1 -1
- package/lib/chunks/C3im5F6T.js.map +1 -1
- package/lib/chunks/C4_EvmHb.js.map +1 -1
- package/lib/chunks/{BI8wQGwJ.js → C8FspEDS.js} +7 -5
- package/lib/chunks/C8FspEDS.js.map +1 -0
- package/lib/chunks/{CWM22e1v.js → CI4tLO9K.js} +6 -4
- package/lib/chunks/CI4tLO9K.js.map +1 -0
- package/lib/chunks/{kCsdJsDp.js → CIV2Plgi.js} +5 -3
- package/lib/chunks/CIV2Plgi.js.map +1 -0
- package/lib/chunks/CK8pVkWO.js.map +1 -1
- package/lib/chunks/{fCOl6gGe.js → CL2aSYwL.js} +4 -2
- package/lib/chunks/CL2aSYwL.js.map +1 -0
- package/lib/chunks/COQRF4O2.js.map +1 -1
- package/lib/chunks/CObxLUVv.js.map +1 -1
- package/lib/chunks/CYO0U3xG.js.map +1 -1
- package/lib/chunks/{QXeRMnaM.js → CZmKZOXs.js} +11 -9
- package/lib/chunks/CZmKZOXs.js.map +1 -0
- package/lib/chunks/{uBR9aAgk.js → CbvZfQIb.js} +6 -4
- package/lib/chunks/CbvZfQIb.js.map +1 -0
- package/lib/chunks/{BWhkyANY.js → CeQqNQur.js} +12 -10
- package/lib/chunks/CeQqNQur.js.map +1 -0
- package/lib/chunks/{VUkGxEQX.js → CeiQfFj4.js} +9 -7
- package/lib/chunks/CeiQfFj4.js.map +1 -0
- package/lib/chunks/CfyHmkPe.js.map +1 -1
- package/lib/chunks/CiecGioc.js.map +1 -1
- package/lib/chunks/CjfHlzPr.js.map +1 -1
- package/lib/chunks/{JkqrKvFU.js → Cl2RaLEy.js} +10 -8
- package/lib/chunks/Cl2RaLEy.js.map +1 -0
- package/lib/chunks/Cpmv-8CX.js.map +1 -1
- package/lib/chunks/CsRtPonL.js.map +1 -1
- package/lib/chunks/Ct9WYKLH.js.map +1 -1
- package/lib/chunks/{C6c2zNh0.js → CuaZAnUQ.js} +9 -7
- package/lib/chunks/CuaZAnUQ.js.map +1 -0
- package/lib/chunks/D2Rp5DqD.js.map +1 -1
- package/lib/chunks/D8LFX3Si.js.map +1 -1
- package/lib/chunks/DCeVwori.js.map +1 -1
- package/lib/chunks/DFdgK5Ff.js.map +1 -1
- package/lib/chunks/DGNDLzjC.js.map +1 -1
- package/lib/chunks/DKh1JBaq.js.map +1 -1
- package/lib/chunks/DQ2aBJ55.js.map +1 -1
- package/lib/chunks/{DI98porG.js → DSTwKMaq.js} +11 -9
- package/lib/chunks/DSTwKMaq.js.map +1 -0
- package/lib/chunks/DTAFonQW.js.map +1 -1
- package/lib/chunks/{B8gQABN9.js → DUaUWLyw.js} +3 -1
- package/lib/chunks/DUaUWLyw.js.map +1 -0
- package/lib/chunks/DUsiYkFK.js.map +1 -1
- package/lib/chunks/DdpHkb3E.js.map +1 -1
- package/lib/chunks/DgIBeET0.js.map +1 -1
- package/lib/chunks/DgJZ6ZlB.js.map +1 -1
- package/lib/chunks/DhwKNWjD.js.map +1 -1
- package/lib/chunks/{C19d7e9r.js → DoFyfMXF.js} +7 -5
- package/lib/chunks/DoFyfMXF.js.map +1 -0
- package/lib/chunks/DpVMBZKg.js.map +1 -1
- package/lib/chunks/DpX76W8R.js.map +1 -1
- package/lib/chunks/{FzMaadW6.js → Dw8g2KwQ.js} +9 -7
- package/lib/chunks/Dw8g2KwQ.js.map +1 -0
- package/lib/chunks/DwfSxgDx.js.map +1 -1
- package/lib/chunks/{CNs1dLtt.js → DxoJlWU3.js} +8 -6
- package/lib/chunks/DxoJlWU3.js.map +1 -0
- package/lib/chunks/DyrhHazx.js.map +1 -1
- package/lib/chunks/{CvRb-PD8.js → DzXzhdwr.js} +13 -11
- package/lib/chunks/DzXzhdwr.js.map +1 -0
- package/lib/chunks/Ffj7MYiP.js.map +1 -1
- package/lib/chunks/{E1AHpT8W.js → GFug45r8.js} +9 -7
- package/lib/chunks/GFug45r8.js.map +1 -0
- package/lib/chunks/KzCo7H0B.js.map +1 -1
- package/lib/chunks/PBX4P85B.js.map +1 -1
- package/lib/chunks/Tt3YRLoT.js.map +1 -1
- package/lib/chunks/UIRN-9Gk.js.map +1 -1
- package/lib/chunks/Uub1pbHE.js.map +1 -1
- package/lib/chunks/VxQFGAPu.js.map +1 -1
- package/lib/chunks/cT-MuN_z.js.map +1 -1
- package/lib/chunks/{3pMrXrSV.js → dSkHfi4J.js} +10 -8
- package/lib/chunks/dSkHfi4J.js.map +1 -0
- package/lib/chunks/gdOjznoN.js.map +1 -1
- package/lib/chunks/lkmEYnvD.js.map +1 -1
- package/lib/chunks/mzLGzWY5.js.map +1 -1
- package/lib/chunks/{7r3BIYih.js → nMvWDbO6.js} +9 -7
- package/lib/chunks/nMvWDbO6.js.map +1 -0
- package/lib/chunks/qmIX92PW.js.map +1 -1
- package/lib/chunks/{BspGLrQY.js → r66Wz1km.js} +6 -4
- package/lib/chunks/r66Wz1km.js.map +1 -0
- package/lib/chunks/rg6JAh_X.js.map +1 -1
- package/lib/chunks/wPKCUEuQ.js.map +1 -1
- package/lib/components/BryntumAIFilterField.js +1 -1
- package/lib/components/BryntumBooleanCombo.js +1 -1
- package/lib/components/BryntumCalendar.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/BryntumEventColorField.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/BryntumProjectCombo.js +1 -1
- package/lib/components/BryntumRadio.js +1 -1
- package/lib/components/BryntumResourceCombo.js +1 -1
- package/lib/components/BryntumScheduler.js +1 -1
- package/lib/components/BryntumSchedulerBase.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/components/BryntumViewPresetCombo.js +1 -1
- package/lib/index.js +29 -29
- package/package.json +1 -1
- package/src/components/BryntumAIFilterField.vue +11 -1
- package/src/components/BryntumAIFilterFieldProps.ts +9 -0
- package/src/components/BryntumAgendaView.vue +27 -27
- 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/BryntumCalendar.vue +30 -24
- package/src/components/BryntumCalendarDatePicker.vue +3 -3
- package/src/components/BryntumCalendarProps.ts +6 -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/BryntumDayAgendaView.vue +5 -5
- package/src/components/BryntumDayResourceView.vue +11 -7
- package/src/components/BryntumDayResourceViewProps.ts +6 -2
- package/src/components/BryntumDayView.vue +11 -7
- package/src/components/BryntumDayViewProps.ts +6 -2
- 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/BryntumEventColorField.vue +11 -1
- package/src/components/BryntumEventColorFieldProps.ts +9 -0
- package/src/components/BryntumEventList.vue +27 -27
- 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/BryntumModeSelector.vue +1 -1
- package/src/components/BryntumMonthAgendaView.vue +5 -5
- package/src/components/BryntumMonthGrid.vue +7 -7
- package/src/components/BryntumMonthPicker.vue +3 -3
- package/src/components/BryntumMonthView.vue +6 -6
- 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/BryntumProjectCombo.vue +11 -1
- package/src/components/BryntumProjectComboProps.ts +9 -0
- package/src/components/BryntumRadio.vue +12 -2
- package/src/components/BryntumRadioGroup.vue +3 -3
- package/src/components/BryntumRadioProps.ts +9 -0
- package/src/components/BryntumRangeMenu.vue +3 -3
- package/src/components/BryntumResourceCombo.vue +11 -1
- package/src/components/BryntumResourceComboProps.ts +9 -0
- package/src/components/BryntumResourceFilter.vue +2 -2
- package/src/components/BryntumResourceView.vue +5 -5
- package/src/components/BryntumScheduler.vue +60 -50
- package/src/components/BryntumSchedulerBase.vue +60 -50
- package/src/components/BryntumSchedulerBaseProps.ts +5 -0
- package/src/components/BryntumSchedulerDatePicker.vue +3 -3
- package/src/components/BryntumSchedulerProps.ts +5 -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/BryntumTimeVisualizingEditor.vue +3 -3
- package/src/components/BryntumTimeZoomSlider.vue +1 -1
- package/src/components/BryntumTimelineHistogram.vue +30 -30
- 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/BryntumUndoRedo.vue +1 -1
- package/src/components/BryntumViewPresetCombo.vue +11 -1
- package/src/components/BryntumViewPresetComboProps.ts +9 -0
- package/src/components/BryntumWeekView.vue +11 -7
- package/src/components/BryntumWeekViewProps.ts +6 -2
- package/src/components/BryntumWidget.vue +1 -1
- package/src/components/BryntumYearPicker.vue +3 -3
- package/src/components/BryntumYearPlanner.vue +5 -5
- package/src/components/BryntumYearView.vue +6 -6
- package/lib/chunks/3pMrXrSV.js.map +0 -1
- package/lib/chunks/7r3BIYih.js.map +0 -1
- package/lib/chunks/B8gQABN9.js.map +0 -1
- package/lib/chunks/BBmKbcBm.js.map +0 -1
- package/lib/chunks/BI8wQGwJ.js.map +0 -1
- package/lib/chunks/BKPgz4z1.js.map +0 -1
- package/lib/chunks/BWhkyANY.js.map +0 -1
- package/lib/chunks/BspGLrQY.js.map +0 -1
- package/lib/chunks/C19d7e9r.js.map +0 -1
- package/lib/chunks/C6c2zNh0.js.map +0 -1
- package/lib/chunks/CNs1dLtt.js.map +0 -1
- package/lib/chunks/CPHxjIqw.js.map +0 -1
- package/lib/chunks/CWM22e1v.js.map +0 -1
- package/lib/chunks/CvRb-PD8.js.map +0 -1
- package/lib/chunks/DI98porG.js.map +0 -1
- package/lib/chunks/DQEdPoQo.js.map +0 -1
- package/lib/chunks/DURERga3.js.map +0 -1
- package/lib/chunks/DxT4VIUT.js.map +0 -1
- package/lib/chunks/DzuHthMw.js.map +0 -1
- package/lib/chunks/E1AHpT8W.js.map +0 -1
- package/lib/chunks/FzMaadW6.js.map +0 -1
- package/lib/chunks/JKRtgYCJ.js.map +0 -1
- package/lib/chunks/JkqrKvFU.js.map +0 -1
- package/lib/chunks/QXeRMnaM.js.map +0 -1
- package/lib/chunks/VUkGxEQX.js.map +0 -1
- package/lib/chunks/fCOl6gGe.js.map +0 -1
- package/lib/chunks/j6GbzQ11.js.map +0 -1
- package/lib/chunks/kCsdJsDp.js.map +0 -1
- package/lib/chunks/uBR9aAgk.js.map +0 -1
|
@@ -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/calendar/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/calendar/docs/api/Core/widget/Field#property-isValid)
|
|
103
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
|
|
104
|
+
* [More...](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
102
111
|
* in the [triggers](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#property-isValid)
|
|
89
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
|
|
90
|
+
* [More...](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
88
97
|
* in the [triggers](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#property-isValid)
|
|
101
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
|
|
102
|
+
* [More...](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
100
109
|
* in the [triggers](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#property-isValid)
|
|
87
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
|
|
88
|
+
* [More...](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
86
95
|
* in the [triggers](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#property-isValid)
|
|
97
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
|
|
98
|
+
* [More...](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
96
105
|
* in the [triggers](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#property-isValid)
|
|
83
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
|
|
84
|
+
* [More...](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
82
91
|
* in the [triggers](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#property-isValid)
|
|
101
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
|
|
102
|
+
* [More...](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
100
109
|
* in the [triggers](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#property-isValid)
|
|
87
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
|
|
88
|
+
* [More...](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
86
95
|
* in the [triggers](https://bryntum.com/products/calendar/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)
|
|
@@ -780,7 +780,7 @@ const emit = defineEmits<{
|
|
|
780
780
|
* @param {object} params.event Event object
|
|
781
781
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
782
782
|
*/
|
|
783
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
783
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
784
784
|
/**
|
|
785
785
|
* Triggered before a new [responsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveState) is applied.
|
|
786
786
|
* @param {string} e Event name
|
|
@@ -816,7 +816,7 @@ const emit = defineEmits<{
|
|
|
816
816
|
* @param {object} params.event Event object
|
|
817
817
|
* @param {any} params.event.state State object config
|
|
818
818
|
*/
|
|
819
|
-
(e: 'beforeStateApply', params: ((event: { state: any }) =>
|
|
819
|
+
(e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
820
820
|
/**
|
|
821
821
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
822
822
|
* @param {string} e Event name
|
|
@@ -824,7 +824,7 @@ const emit = defineEmits<{
|
|
|
824
824
|
* @param {object} params.event Event object
|
|
825
825
|
* @param {any} params.event.state State object config
|
|
826
826
|
*/
|
|
827
|
-
(e: 'beforeStateSave', params: ((event: { state: any }) =>
|
|
827
|
+
(e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
828
828
|
/**
|
|
829
829
|
* Fires when any other event is fired from the object.
|
|
830
830
|
* [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/TimeVisualizingEditor#event-catchAll)
|
|
@@ -511,7 +511,7 @@ const emit = defineEmits<{
|
|
|
511
511
|
* @param {object} params.event Event object
|
|
512
512
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
513
513
|
*/
|
|
514
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
514
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
515
515
|
/**
|
|
516
516
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
517
517
|
* @param {string} e Event name
|
|
@@ -1512,7 +1512,7 @@ const emit = defineEmits<{
|
|
|
1512
1512
|
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1513
1513
|
* @param {Grid.util.GridLocation} params.event.editorContext Editing context
|
|
1514
1514
|
*/
|
|
1515
|
-
(e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
1515
|
+
(e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string): boolean|void
|
|
1516
1516
|
/**
|
|
1517
1517
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
1518
1518
|
* [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/view/TimelineHistogram#event-beforeCancelRowEdit)
|
|
@@ -1531,7 +1531,7 @@ const emit = defineEmits<{
|
|
|
1531
1531
|
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1532
1532
|
* @param {CellEditorContext} params.event.editorContext Editing context
|
|
1533
1533
|
*/
|
|
1534
|
-
(e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
1534
|
+
(e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string): boolean|void
|
|
1535
1535
|
/**
|
|
1536
1536
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
1537
1537
|
* buttons while [autoEdit](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -1541,7 +1541,7 @@ const emit = defineEmits<{
|
|
|
1541
1541
|
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1542
1542
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} params.event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
1543
1543
|
*/
|
|
1544
|
-
(e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
1544
|
+
(e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string): boolean|void
|
|
1545
1545
|
/**
|
|
1546
1546
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
1547
1547
|
* @param {string} e Event name
|
|
@@ -1551,7 +1551,7 @@ const emit = defineEmits<{
|
|
|
1551
1551
|
* @param {string} params.event.field The field being changed
|
|
1552
1552
|
* @param {any} params.event.value The value being set
|
|
1553
1553
|
*/
|
|
1554
|
-
(e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) =>
|
|
1554
|
+
(e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => boolean|void)|string): boolean|void
|
|
1555
1555
|
/**
|
|
1556
1556
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
1557
1557
|
* @param {string} e Event name
|
|
@@ -1571,7 +1571,7 @@ const emit = defineEmits<{
|
|
|
1571
1571
|
* @param {Grid.column.Column} params.event.column The dragged column.
|
|
1572
1572
|
* @param {Event} params.event.event The browser event.
|
|
1573
1573
|
*/
|
|
1574
|
-
(e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
1574
|
+
(e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string): boolean|void
|
|
1575
1575
|
/**
|
|
1576
1576
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
1577
1577
|
* @param {string} e Event name
|
|
@@ -1584,7 +1584,7 @@ const emit = defineEmits<{
|
|
|
1584
1584
|
* @param {Event} params.event.event The browser event.
|
|
1585
1585
|
* @param {string} params.event.region The region where the column was dropped.
|
|
1586
1586
|
*/
|
|
1587
|
-
(e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
1587
|
+
(e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string): boolean|void
|
|
1588
1588
|
/**
|
|
1589
1589
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
1590
1590
|
* `false`.
|
|
@@ -1595,7 +1595,7 @@ const emit = defineEmits<{
|
|
|
1595
1595
|
* @param {Grid.column.Column} params.event.column The column
|
|
1596
1596
|
* @param {Event} params.event.domEvent The browser event
|
|
1597
1597
|
*/
|
|
1598
|
-
(e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
1598
|
+
(e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
1599
1599
|
/**
|
|
1600
1600
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
1601
1601
|
* @param {string} e Event name
|
|
@@ -1619,7 +1619,7 @@ const emit = defineEmits<{
|
|
|
1619
1619
|
* @param {string} params.event.lineDelimiter The CSV delimiter to separate lines
|
|
1620
1620
|
* @param {string} params.event.columnDelimiter The CSV delimiter to separate values on one line
|
|
1621
1621
|
*/
|
|
1622
|
-
(e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
1622
|
+
(e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string): boolean|void
|
|
1623
1623
|
/**
|
|
1624
1624
|
* Fires before an object is destroyed.
|
|
1625
1625
|
* @param {string} e Event name
|
|
@@ -1652,7 +1652,7 @@ const emit = defineEmits<{
|
|
|
1652
1652
|
* @param {XLSColumn[]} params.event.columns An array of columns to export
|
|
1653
1653
|
* @param {any[][]} params.event.rows An array of records to export
|
|
1654
1654
|
*/
|
|
1655
|
-
(e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
1655
|
+
(e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string): boolean|void
|
|
1656
1656
|
/**
|
|
1657
1657
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
1658
1658
|
* @param {string} e Event name
|
|
@@ -1661,7 +1661,7 @@ const emit = defineEmits<{
|
|
|
1661
1661
|
* @param {Grid.util.GridLocation} params.event.cell Information about the column / record
|
|
1662
1662
|
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
1663
1663
|
*/
|
|
1664
|
-
(e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
1664
|
+
(e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
|
|
1665
1665
|
/**
|
|
1666
1666
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
1667
1667
|
* @param {string} e Event name
|
|
@@ -1688,7 +1688,7 @@ const emit = defineEmits<{
|
|
|
1688
1688
|
* @param {object} params.event Event object
|
|
1689
1689
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
1690
1690
|
*/
|
|
1691
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
1691
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
1692
1692
|
/**
|
|
1693
1693
|
* Fires before the component stores a record's histogram data into the cache.
|
|
1694
1694
|
* [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/view/TimelineHistogram#event-beforeHistogramDataCacheSet)
|
|
@@ -1707,7 +1707,7 @@ const emit = defineEmits<{
|
|
|
1707
1707
|
* @param {object} params.event Event object
|
|
1708
1708
|
* @param {Event} params.event.event The native browser DOM event
|
|
1709
1709
|
*/
|
|
1710
|
-
(e: 'beforePan', params: ((event: { event: Event }) =>
|
|
1710
|
+
(e: 'beforePan', params: ((event: { event: Event }) => boolean|void)|string): boolean|void
|
|
1711
1711
|
/**
|
|
1712
1712
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
1713
1713
|
* @param {string} e Event name
|
|
@@ -1727,7 +1727,7 @@ const emit = defineEmits<{
|
|
|
1727
1727
|
* @param {object} params.event Event object
|
|
1728
1728
|
* @param {PdfExportConfig} params.event.config Export config
|
|
1729
1729
|
*/
|
|
1730
|
-
(e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) =>
|
|
1730
|
+
(e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) => boolean|void)|string): boolean|void
|
|
1731
1731
|
/**
|
|
1732
1732
|
* Fired before the [viewPreset](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
1733
1733
|
* @param {string} e Event name
|
|
@@ -1739,7 +1739,7 @@ const emit = defineEmits<{
|
|
|
1739
1739
|
* @param {Scheduler.preset.ViewPreset} params.event.from The outgoing ViewPreset.
|
|
1740
1740
|
* @param {Scheduler.preset.ViewPreset} params.event.to The ViewPreset being switched to.
|
|
1741
1741
|
*/
|
|
1742
|
-
(e: 'beforePresetChange', params: ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) =>
|
|
1742
|
+
(e: 'beforePresetChange', params: ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => boolean|void)|string): boolean|void
|
|
1743
1743
|
/**
|
|
1744
1744
|
* Fires before the component renders a row.
|
|
1745
1745
|
* [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/view/TimelineHistogram#event-beforeRenderHistogramRow)
|
|
@@ -1815,7 +1815,7 @@ const emit = defineEmits<{
|
|
|
1815
1815
|
* @param {Grid.util.GridLocation[]} params.event.selectedCells The cells to be selected in this operation.
|
|
1816
1816
|
* @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
1817
1817
|
*/
|
|
1818
|
-
(e: 'beforeSelectionChange', params: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
1818
|
+
(e: 'beforeSelectionChange', params: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string): boolean|void
|
|
1819
1819
|
/**
|
|
1820
1820
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
1821
1821
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -1842,7 +1842,7 @@ const emit = defineEmits<{
|
|
|
1842
1842
|
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
1843
1843
|
* @param {RowEditorContext} params.event.editorContext Editing context
|
|
1844
1844
|
*/
|
|
1845
|
-
(e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
1845
|
+
(e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string): boolean|void
|
|
1846
1846
|
/**
|
|
1847
1847
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
1848
1848
|
* @param {string} e Event name
|
|
@@ -1850,7 +1850,7 @@ const emit = defineEmits<{
|
|
|
1850
1850
|
* @param {object} params.event Event object
|
|
1851
1851
|
* @param {GridStateInfo} params.event.state State object config
|
|
1852
1852
|
*/
|
|
1853
|
-
(e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) =>
|
|
1853
|
+
(e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
|
|
1854
1854
|
/**
|
|
1855
1855
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
1856
1856
|
* @param {string} e Event name
|
|
@@ -1858,7 +1858,7 @@ const emit = defineEmits<{
|
|
|
1858
1858
|
* @param {object} params.event Event object
|
|
1859
1859
|
* @param {GridStateInfo} params.event.state State object config
|
|
1860
1860
|
*/
|
|
1861
|
-
(e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) =>
|
|
1861
|
+
(e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
|
|
1862
1862
|
/**
|
|
1863
1863
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
1864
1864
|
* Returning `false` from a listener prevents the operation
|
|
@@ -1870,7 +1870,7 @@ const emit = defineEmits<{
|
|
|
1870
1870
|
* @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
|
|
1871
1871
|
* @param {Event} params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
1872
1872
|
*/
|
|
1873
|
-
(e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
1873
|
+
(e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
1874
1874
|
/**
|
|
1875
1875
|
* Fired before a parent node record toggles its collapsed state.
|
|
1876
1876
|
* @param {string} e Event name
|
|
@@ -1953,7 +1953,7 @@ const emit = defineEmits<{
|
|
|
1953
1953
|
* @param {Grid.column.Column} params.event.column Column
|
|
1954
1954
|
* @param {Core.data.Model} params.event.record Record
|
|
1955
1955
|
*/
|
|
1956
|
-
(e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
1956
|
+
(e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string): boolean|void
|
|
1957
1957
|
/**
|
|
1958
1958
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
1959
1959
|
* @param {string} e Event name
|
|
@@ -2106,7 +2106,7 @@ const emit = defineEmits<{
|
|
|
2106
2106
|
* @param {Event} params.event.event The browser event.
|
|
2107
2107
|
* @param {string} params.event.region The region where the column was dropped.
|
|
2108
2108
|
*/
|
|
2109
|
-
(e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
2109
|
+
(e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string): boolean|void
|
|
2110
2110
|
/**
|
|
2111
2111
|
* This event is fired after a resize gesture is completed.
|
|
2112
2112
|
* @param {string} e Event name
|
|
@@ -2306,7 +2306,7 @@ const emit = defineEmits<{
|
|
|
2306
2306
|
* @param {Grid.util.GridLocation} params.event.cell Information about the column / record
|
|
2307
2307
|
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
2308
2308
|
*/
|
|
2309
|
-
(e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
2309
|
+
(e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
|
|
2310
2310
|
/**
|
|
2311
2311
|
* Fires on the owning Grid when cell editing is finished
|
|
2312
2312
|
* @param {string} e Event name
|
|
@@ -2364,7 +2364,7 @@ const emit = defineEmits<{
|
|
|
2364
2364
|
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
2365
2365
|
* @param {MouseEvent,TouchEvent} params.event.event
|
|
2366
2366
|
*/
|
|
2367
|
-
(e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
2367
|
+
(e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string): boolean|void
|
|
2368
2368
|
/**
|
|
2369
2369
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
2370
2370
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -2443,7 +2443,7 @@ const emit = defineEmits<{
|
|
|
2443
2443
|
* @param {Event} params.event.domEvent The triggering DOM event.
|
|
2444
2444
|
* @param {Grid.column.Column} params.event.column The column clicked on.
|
|
2445
2445
|
*/
|
|
2446
|
-
(e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) =>
|
|
2446
|
+
(e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => boolean|void)|string): boolean|void
|
|
2447
2447
|
/**
|
|
2448
2448
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
2449
2449
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/calendar/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -2456,7 +2456,7 @@ const emit = defineEmits<{
|
|
|
2456
2456
|
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
2457
2457
|
* @param {Grid.column.Column} params.event.column Column
|
|
2458
2458
|
*/
|
|
2459
|
-
(e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
2459
|
+
(e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string): boolean|void
|
|
2460
2460
|
/**
|
|
2461
2461
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
2462
2462
|
* @param {string} e Event name
|
|
@@ -2589,7 +2589,7 @@ const emit = defineEmits<{
|
|
|
2589
2589
|
* @param {Scheduler.preset.ViewPreset} params.event.from The outgoing ViewPreset.
|
|
2590
2590
|
* @param {Scheduler.preset.ViewPreset} params.event.to The ViewPreset being switched to.
|
|
2591
2591
|
*/
|
|
2592
|
-
(e: 'presetChange', params: ((event: { source: Scheduler, startDate: Date, centerDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) =>
|
|
2592
|
+
(e: 'presetChange', params: ((event: { source: Scheduler, startDate: Date, centerDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => boolean|void)|string): boolean|void
|
|
2593
2593
|
/**
|
|
2594
2594
|
* Fired when a Widget's read only state is toggled
|
|
2595
2595
|
* @param {string} e Event name
|
|
@@ -2647,7 +2647,7 @@ const emit = defineEmits<{
|
|
|
2647
2647
|
* @param {Grid.column.Column} params.event.column Column
|
|
2648
2648
|
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord Record
|
|
2649
2649
|
*/
|
|
2650
|
-
(e: 'resourceMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, resourceRecord: ResourceModel }) =>
|
|
2650
|
+
(e: 'resourceMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, resourceRecord: ResourceModel }) => boolean|void)|string): boolean|void
|
|
2651
2651
|
/**
|
|
2652
2652
|
* This event fires on the owning scheduler when an item is selected in the context menu.
|
|
2653
2653
|
* @param {string} e Event name
|
|
@@ -2891,7 +2891,7 @@ const emit = defineEmits<{
|
|
|
2891
2891
|
* @param {Grid.view.SubGrid} params.event.subGrid The subgrid
|
|
2892
2892
|
* @param {Event} params.event.domEvent The native DOM event
|
|
2893
2893
|
*/
|
|
2894
|
-
(e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
2894
|
+
(e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
2895
2895
|
/**
|
|
2896
2896
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
2897
2897
|
* @param {string} e Event name
|
|
@@ -2922,7 +2922,7 @@ const emit = defineEmits<{
|
|
|
2922
2922
|
* @param {Grid.view.SubGrid} params.event.subGrid The subgrid
|
|
2923
2923
|
* @param {Event} params.event.domEvent The native DOM event
|
|
2924
2924
|
*/
|
|
2925
|
-
(e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
2925
|
+
(e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
2926
2926
|
/**
|
|
2927
2927
|
* Fires on the owning Grid when editing starts
|
|
2928
2928
|
* @param {string} e Event name
|
|
@@ -3025,7 +3025,7 @@ const emit = defineEmits<{
|
|
|
3025
3025
|
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
3026
3026
|
* @param {Grid.column.Column} params.event.column Time axis column
|
|
3027
3027
|
*/
|
|
3028
|
-
(e: 'timeAxisHeaderMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
3028
|
+
(e: 'timeAxisHeaderMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string): boolean|void
|
|
3029
3029
|
/**
|
|
3030
3030
|
* This event fires on the owning Scheduler or Gantt widget when an item is selected in the header context menu.
|
|
3031
3031
|
* @param {string} e Event name
|
|
@@ -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)
|
|
@@ -104,6 +104,15 @@ defineProps<{
|
|
|
104
104
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
105
105
|
*/
|
|
106
106
|
centered ? : Boolean
|
|
107
|
+
/**
|
|
108
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
109
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#property-isValid)
|
|
110
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
|
|
111
|
+
* [More...](https://bryntum.com/products/calendar/docs/api/Grid/widget/TreeCombo#config-checkValidity)
|
|
112
|
+
* @param {Core.widget.Field} field The field being validated
|
|
113
|
+
* @returns {void}
|
|
114
|
+
*/
|
|
115
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
107
116
|
/**
|
|
108
117
|
* A config object to configure the [ChipView](https://bryntum.com/products/calendar/docs/api/Core/widget/ChipView) to display the
|
|
109
118
|
* selected value set when [multiSelect](https://bryntum.com/products/calendar/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -815,7 +824,7 @@ const emit = defineEmits<{
|
|
|
815
824
|
* @param {object} params.event Event object
|
|
816
825
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
817
826
|
*/
|
|
818
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
827
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
819
828
|
/**
|
|
820
829
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
821
830
|
* @param {string} e Event name
|
|
@@ -1003,6 +1012,7 @@ const widgetData = {
|
|
|
1003
1012
|
'cacheLastResult',
|
|
1004
1013
|
'caseSensitive',
|
|
1005
1014
|
'centered',
|
|
1015
|
+
'checkValidity',
|
|
1006
1016
|
'chipView',
|
|
1007
1017
|
'clearable',
|
|
1008
1018
|
'clearTextOnPickerHide',
|