@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
|
@@ -935,6 +935,11 @@ defineProps<{
|
|
|
935
935
|
* [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/view/SchedulerBase#config-project)
|
|
936
936
|
*/
|
|
937
937
|
project ? : ProjectModel|ProjectModelConfig|object
|
|
938
|
+
/**
|
|
939
|
+
* The project model class to use when creating the project instance. Override this to use a custom project
|
|
940
|
+
* model class. In SchedulerPro and Gantt, this is overridden to use their respective project model classes.
|
|
941
|
+
*/
|
|
942
|
+
projectModelClass ? : typeof ProjectModel
|
|
938
943
|
/**
|
|
939
944
|
* Range used to set the length of the time axis when used as a component of a Calendar. Suitable units are
|
|
940
945
|
* `'month'`, `'week'` and `'day'`.
|
|
@@ -2041,7 +2046,7 @@ const emit = defineEmits<{
|
|
|
2041
2046
|
* @param {Scheduler.model.AssignmentModel[]} params.event.deselected An array of assignments that will be removed from the selection.
|
|
2042
2047
|
* @param {Scheduler.model.AssignmentModel[]} params.event.selection The currently selected assignments, before applying `selected` and `deselected`.
|
|
2043
2048
|
*/
|
|
2044
|
-
(e: 'beforeAssignmentSelectionChange', params: ((event: { source: Scheduler, action: 'select'|'deselect'|'update'|'clear', selected: AssignmentModel[], deselected: AssignmentModel[], selection: AssignmentModel[] }) =>
|
|
2049
|
+
(e: 'beforeAssignmentSelectionChange', params: ((event: { source: Scheduler, action: 'select'|'deselect'|'update'|'clear', selected: AssignmentModel[], deselected: AssignmentModel[], selection: AssignmentModel[] }) => boolean|void)|string): boolean|void
|
|
2045
2050
|
/**
|
|
2046
2051
|
* This event fires whenever the [autoCreate gesture](https://bryntum.com/products/calendar/docs/api/Scheduler/view/SchedulerBase#config-autoCreate) is detected.
|
|
2047
2052
|
* [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/view/SchedulerBase#event-beforeAutoCreate)
|
|
@@ -2061,7 +2066,7 @@ const emit = defineEmits<{
|
|
|
2061
2066
|
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
2062
2067
|
* @param {Grid.util.GridLocation} params.event.editorContext Editing context
|
|
2063
2068
|
*/
|
|
2064
|
-
(e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
2069
|
+
(e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string): boolean|void
|
|
2065
2070
|
/**
|
|
2066
2071
|
* 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.
|
|
2067
2072
|
* [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/view/SchedulerBase#event-beforeCancelRowEdit)
|
|
@@ -2080,7 +2085,7 @@ const emit = defineEmits<{
|
|
|
2080
2085
|
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
2081
2086
|
* @param {CellEditorContext} params.event.editorContext Editing context
|
|
2082
2087
|
*/
|
|
2083
|
-
(e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
2088
|
+
(e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string): boolean|void
|
|
2084
2089
|
/**
|
|
2085
2090
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
2086
2091
|
* buttons while [autoEdit](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -2090,7 +2095,7 @@ const emit = defineEmits<{
|
|
|
2090
2095
|
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
2091
2096
|
* @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).
|
|
2092
2097
|
*/
|
|
2093
|
-
(e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
2098
|
+
(e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string): boolean|void
|
|
2094
2099
|
/**
|
|
2095
2100
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
2096
2101
|
* @param {string} e Event name
|
|
@@ -2100,7 +2105,7 @@ const emit = defineEmits<{
|
|
|
2100
2105
|
* @param {string} params.event.field The field being changed
|
|
2101
2106
|
* @param {any} params.event.value The value being set
|
|
2102
2107
|
*/
|
|
2103
|
-
(e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) =>
|
|
2108
|
+
(e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => boolean|void)|string): boolean|void
|
|
2104
2109
|
/**
|
|
2105
2110
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
2106
2111
|
* @param {string} e Event name
|
|
@@ -2120,7 +2125,7 @@ const emit = defineEmits<{
|
|
|
2120
2125
|
* @param {Grid.column.Column} params.event.column The dragged column.
|
|
2121
2126
|
* @param {Event} params.event.event The browser event.
|
|
2122
2127
|
*/
|
|
2123
|
-
(e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
2128
|
+
(e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string): boolean|void
|
|
2124
2129
|
/**
|
|
2125
2130
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
2126
2131
|
* @param {string} e Event name
|
|
@@ -2133,7 +2138,7 @@ const emit = defineEmits<{
|
|
|
2133
2138
|
* @param {Event} params.event.event The browser event.
|
|
2134
2139
|
* @param {string} params.event.region The region where the column was dropped.
|
|
2135
2140
|
*/
|
|
2136
|
-
(e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
2141
|
+
(e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string): boolean|void
|
|
2137
2142
|
/**
|
|
2138
2143
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
2139
2144
|
* `false`.
|
|
@@ -2144,7 +2149,7 @@ const emit = defineEmits<{
|
|
|
2144
2149
|
* @param {Grid.column.Column} params.event.column The column
|
|
2145
2150
|
* @param {Event} params.event.domEvent The browser event
|
|
2146
2151
|
*/
|
|
2147
|
-
(e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
2152
|
+
(e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
2148
2153
|
/**
|
|
2149
2154
|
* This event is fired on the owning Scheduler when the context [element](https://bryntum.com/products/calendar/docs/api/Scheduler/feature/ScheduleContext#property-element) or
|
|
2150
2155
|
* [widget](https://bryntum.com/products/calendar/docs/api/Scheduler/feature/ScheduleContext#property-widget) is about to be shown.
|
|
@@ -2161,7 +2166,7 @@ const emit = defineEmits<{
|
|
|
2161
2166
|
* @param {number} params.event.position.x The x coordinate of the context element
|
|
2162
2167
|
* @param {number} params.event.position.y The y coordinate of the context element
|
|
2163
2168
|
*/
|
|
2164
|
-
(e: 'beforeContextShow', params: ((event: { source: ScheduleContext, context: TimelineContext, element: HTMLElement, position: { width: number, height: number, x: number, y: number } }) =>
|
|
2169
|
+
(e: 'beforeContextShow', params: ((event: { source: ScheduleContext, context: TimelineContext, element: HTMLElement, position: { width: number, height: number, x: number, y: number } }) => boolean|void)|string): boolean|void
|
|
2165
2170
|
/**
|
|
2166
2171
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
2167
2172
|
* @param {string} e Event name
|
|
@@ -2185,7 +2190,7 @@ const emit = defineEmits<{
|
|
|
2185
2190
|
* @param {string} params.event.lineDelimiter The CSV delimiter to separate lines
|
|
2186
2191
|
* @param {string} params.event.columnDelimiter The CSV delimiter to separate values on one line
|
|
2187
2192
|
*/
|
|
2188
|
-
(e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
2193
|
+
(e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string): boolean|void
|
|
2189
2194
|
/**
|
|
2190
2195
|
* Fires on the owning Scheduler or Gantt widget before a dependency is added from the dependency
|
|
2191
2196
|
* edit popup
|
|
@@ -2196,7 +2201,7 @@ const emit = defineEmits<{
|
|
|
2196
2201
|
* @param {Scheduler.feature.DependencyEdit} params.event.dependencyEdit The dependency edit feature
|
|
2197
2202
|
* @param {Scheduler.model.DependencyModel} params.event.dependencyRecord The dependency about to be added
|
|
2198
2203
|
*/
|
|
2199
|
-
(e: 'beforeDependencyAdd', params: ((event: { source: Scheduler, dependencyEdit: DependencyEdit, dependencyRecord: DependencyModel }) =>
|
|
2204
|
+
(e: 'beforeDependencyAdd', params: ((event: { source: Scheduler, dependencyEdit: DependencyEdit, dependencyRecord: DependencyModel }) => boolean|void)|string): boolean|void
|
|
2200
2205
|
/**
|
|
2201
2206
|
* Fired on the owning Scheduler/Gantt before a dependency creation drag operation starts. Return `false` to
|
|
2202
2207
|
* prevent it
|
|
@@ -2205,7 +2210,7 @@ const emit = defineEmits<{
|
|
|
2205
2210
|
* @param {object} params.event Event object
|
|
2206
2211
|
* @param {Scheduler.model.TimeSpan} params.event.source The source task
|
|
2207
2212
|
*/
|
|
2208
|
-
(e: 'beforeDependencyCreateDrag', params: ((event: { source: TimeSpan }) =>
|
|
2213
|
+
(e: 'beforeDependencyCreateDrag', params: ((event: { source: TimeSpan }) => boolean|void)|string): boolean|void
|
|
2209
2214
|
/**
|
|
2210
2215
|
* Fired on the owning Scheduler/Gantt when a dependency drag creation operation is about to finalize
|
|
2211
2216
|
* @param {string} e Event name
|
|
@@ -2260,7 +2265,7 @@ const emit = defineEmits<{
|
|
|
2260
2265
|
* @param {Scheduler.model.DependencyModel} params.event.dependencyRecord The dependency about to be saved
|
|
2261
2266
|
* @param {object} params.event.values The new values
|
|
2262
2267
|
*/
|
|
2263
|
-
(e: 'beforeDependencySave', params: ((event: { source: Scheduler, dependencyRecord: DependencyModel, values: object }) =>
|
|
2268
|
+
(e: 'beforeDependencySave', params: ((event: { source: Scheduler, dependencyRecord: DependencyModel, values: object }) => boolean|void)|string): boolean|void
|
|
2264
2269
|
/**
|
|
2265
2270
|
* Fires before an object is destroyed.
|
|
2266
2271
|
* @param {string} e Event name
|
|
@@ -2280,7 +2285,7 @@ const emit = defineEmits<{
|
|
|
2280
2285
|
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord
|
|
2281
2286
|
* @param {Date} params.event.date The datetime associated with the drag start point.
|
|
2282
2287
|
*/
|
|
2283
|
-
(e: 'beforeDragCreate', params: ((event: { source: Scheduler, resourceRecord: ResourceModel, date: Date }) =>
|
|
2288
|
+
(e: 'beforeDragCreate', params: ((event: { source: Scheduler, resourceRecord: ResourceModel, date: Date }) => boolean|void)|string): boolean|void
|
|
2284
2289
|
/**
|
|
2285
2290
|
* Fires on the owning Scheduler to allow implementer to prevent immediate finalization by setting
|
|
2286
2291
|
* `data.context.async = true` in the listener, to show a confirmation popup etc.
|
|
@@ -2309,7 +2314,7 @@ const emit = defineEmits<{
|
|
|
2309
2314
|
* @param {Scheduler.model.ResourceModel[]} params.event.resourceRecords Resources that the record is assigned to
|
|
2310
2315
|
* @param {Scheduler.model.AssignmentModel[]} params.event.assignmentRecords The assignment records
|
|
2311
2316
|
*/
|
|
2312
|
-
(e: 'beforeEventAdd', params: ((event: { source: Scheduler, eventRecord: EventModel, resourceRecords: ResourceModel[], assignmentRecords: AssignmentModel[] }) =>
|
|
2317
|
+
(e: 'beforeEventAdd', params: ((event: { source: Scheduler, eventRecord: EventModel, resourceRecords: ResourceModel[], assignmentRecords: AssignmentModel[] }) => boolean|void)|string): boolean|void
|
|
2313
2318
|
/**
|
|
2314
2319
|
* Fires before an event is removed. Can be triggered by user pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> or by the
|
|
2315
2320
|
* event editor. Return `false` to immediately veto the removal (or a `Promise` yielding `true` or `false`
|
|
@@ -2337,7 +2342,7 @@ const emit = defineEmits<{
|
|
|
2337
2342
|
* @param {Scheduler.model.AssignmentModel[]} params.event.assignmentRecords Assignment records being dragged
|
|
2338
2343
|
* @param {MouseEvent} params.event.domEvent Browser event
|
|
2339
2344
|
*/
|
|
2340
|
-
(e: 'beforeEventDrag', params: ((event: { source: Scheduler, eventRecord: EventModel, resourceRecord: ResourceModel, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], domEvent: MouseEvent }) =>
|
|
2345
|
+
(e: 'beforeEventDrag', params: ((event: { source: Scheduler, eventRecord: EventModel, resourceRecord: ResourceModel, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], domEvent: MouseEvent }) => boolean|void)|string): boolean|void
|
|
2341
2346
|
/**
|
|
2342
2347
|
* Fires on the owning Scheduler before drag selection starts. Return false to prevent the operation.
|
|
2343
2348
|
* @param {string} e Event name
|
|
@@ -2346,7 +2351,7 @@ const emit = defineEmits<{
|
|
|
2346
2351
|
* @param {Scheduler.view.SchedulerBase} params.event.source The Scheduler instance
|
|
2347
2352
|
* @param {Event} params.event.event The native browser DOM event
|
|
2348
2353
|
*/
|
|
2349
|
-
(e: 'beforeEventDragSelect', params: ((event: { source: SchedulerBase, event: Event }) =>
|
|
2354
|
+
(e: 'beforeEventDragSelect', params: ((event: { source: SchedulerBase, event: Event }) => boolean|void)|string): boolean|void
|
|
2350
2355
|
/**
|
|
2351
2356
|
* This event is fired on the owning Scheduler after the event drag operation completes, but before changing any data.
|
|
2352
2357
|
* It allows implementer to use asynchronous validation/finalization by setting `context.async = true`
|
|
@@ -2360,15 +2365,19 @@ const emit = defineEmits<{
|
|
|
2360
2365
|
* @param {object} params.event.context
|
|
2361
2366
|
* @param {DropData} params.event.context.dropData Information about the drop points for dragged events/assignments.
|
|
2362
2367
|
* @param {boolean} params.event.context.async Set to `true` to not finalize the drag-drop operation immediately (e.g. to wait for user confirmation)
|
|
2368
|
+
* @param {Scheduler.model.EventModel} params.event.context.eventRecord The primary event record being dragged
|
|
2363
2369
|
* @param {Scheduler.model.EventModel[]} params.event.context.eventRecords Event records being dragged
|
|
2364
2370
|
* @param {Scheduler.model.AssignmentModel[]} params.event.context.assignmentRecords Assignment records being dragged
|
|
2365
2371
|
* @param {Scheduler.model.EventModel} params.event.context.targetEventRecord The event record (if any) where the drop happened
|
|
2372
|
+
* @param {Scheduler.model.ResourceModel} params.event.context.resourceRecord Resource record the drag started from
|
|
2366
2373
|
* @param {Scheduler.model.ResourceModel} params.event.context.newResource Resource record for drop target
|
|
2374
|
+
* @param {Date} params.event.context.startDate New start date after the drop
|
|
2375
|
+
* @param {Date} params.event.context.endDate New end date after the drop
|
|
2367
2376
|
* @param {boolean} params.event.context.valid Set this to `false` to abort the drop immediately.
|
|
2368
2377
|
* @param {Function} params.event.context.finalize Call this method after an <strong>async</strong> finalization flow, to finalize the drag-drop operation. This method accepts one argument: pass `true` to update records, or `false` to ignore changes
|
|
2369
2378
|
* @param {MouseEvent} params.event.domEvent Browser event
|
|
2370
2379
|
*/
|
|
2371
|
-
(e: 'beforeEventDropFinalize', params: ((event: { source: Scheduler, context: { dropData: DropData, async: boolean, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], targetEventRecord: EventModel, newResource: ResourceModel, valid: boolean, finalize: Function }, domEvent: MouseEvent }) => void)|string): void
|
|
2380
|
+
(e: 'beforeEventDropFinalize', params: ((event: { source: Scheduler, context: { dropData: DropData, async: boolean, eventRecord: EventModel, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], targetEventRecord: EventModel, resourceRecord: ResourceModel, newResource: ResourceModel, startDate: Date, endDate: Date, valid: boolean, finalize: Function }, domEvent: MouseEvent }) => void)|string): void
|
|
2372
2381
|
/**
|
|
2373
2382
|
* Fires on the owning Scheduler before an event is displayed in an editor.
|
|
2374
2383
|
* This may be listened for to allow an application to take over event editing duties. Returning `false`
|
|
@@ -2383,7 +2392,7 @@ const emit = defineEmits<{
|
|
|
2383
2392
|
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord The Resource record for the event. If the event is being created, it will not contain a resource, so this parameter specifies the resource the event is being created for.
|
|
2384
2393
|
* @param {HTMLElement} params.event.eventElement The element which represents the event in the scheduler display.
|
|
2385
2394
|
*/
|
|
2386
|
-
(e: 'beforeEventEdit', params: ((event: { source: Scheduler, eventEdit: SchedulerEventEdit, eventRecord: EventModel, resourceRecord: ResourceModel, eventElement: HTMLElement }) =>
|
|
2395
|
+
(e: 'beforeEventEdit', params: ((event: { source: Scheduler, eventEdit: SchedulerEventEdit, eventRecord: EventModel, resourceRecord: ResourceModel, eventElement: HTMLElement }) => boolean|void)|string): boolean|void
|
|
2387
2396
|
/**
|
|
2388
2397
|
* Fires on the owning Scheduler when the editor for an event is available but before it is populated with
|
|
2389
2398
|
* data and shown. Allows manipulating fields etc.
|
|
@@ -2408,7 +2417,7 @@ const emit = defineEmits<{
|
|
|
2408
2417
|
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord Resource record the resize starts within
|
|
2409
2418
|
* @param {MouseEvent} params.event.event Browser event
|
|
2410
2419
|
*/
|
|
2411
|
-
(e: 'beforeEventResize', params: ((event: { source: Scheduler, eventRecord: EventModel, resourceRecord: ResourceModel, event: MouseEvent }) =>
|
|
2420
|
+
(e: 'beforeEventResize', params: ((event: { source: Scheduler, eventRecord: EventModel, resourceRecord: ResourceModel, event: MouseEvent }) => boolean|void)|string): boolean|void
|
|
2412
2421
|
/**
|
|
2413
2422
|
* Fired on the owning Scheduler to allow implementer to prevent immediate finalization by returning a promise
|
|
2414
2423
|
* in the listener, to show a confirmation popup etc
|
|
@@ -2457,7 +2466,7 @@ const emit = defineEmits<{
|
|
|
2457
2466
|
* @param {Scheduler.model.EventModel[]} params.event.deselected An array of events that will be removed from the selection.
|
|
2458
2467
|
* @param {Scheduler.model.EventModel[]} params.event.selection The currently selected events, before applying `selected` and `deselected`.
|
|
2459
2468
|
*/
|
|
2460
|
-
(e: 'beforeEventSelectionChange', params: ((event: { source: Scheduler, action: 'select'|'deselect'|'update'|'clear', selected: EventModel[], deselected: EventModel[], selection: EventModel[] }) =>
|
|
2469
|
+
(e: 'beforeEventSelectionChange', params: ((event: { source: Scheduler, action: 'select'|'deselect'|'update'|'clear', selected: EventModel[], deselected: EventModel[], selection: EventModel[] }) => boolean|void)|string): boolean|void
|
|
2461
2470
|
/**
|
|
2462
2471
|
* Fires on the owning Grid before Excel export starts. Return `false` to cancel the export.
|
|
2463
2472
|
* @param {string} e Event name
|
|
@@ -2467,7 +2476,7 @@ const emit = defineEmits<{
|
|
|
2467
2476
|
* @param {XLSColumn[]} params.event.columns An array of columns to export
|
|
2468
2477
|
* @param {any[][]} params.event.rows An array of records to export
|
|
2469
2478
|
*/
|
|
2470
|
-
(e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
2479
|
+
(e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string): boolean|void
|
|
2471
2480
|
/**
|
|
2472
2481
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
2473
2482
|
* @param {string} e Event name
|
|
@@ -2476,7 +2485,7 @@ const emit = defineEmits<{
|
|
|
2476
2485
|
* @param {Grid.util.GridLocation} params.event.cell Information about the column / record
|
|
2477
2486
|
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
2478
2487
|
*/
|
|
2479
|
-
(e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
2488
|
+
(e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
|
|
2480
2489
|
/**
|
|
2481
2490
|
* 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.
|
|
2482
2491
|
* @param {string} e Event name
|
|
@@ -2503,7 +2512,7 @@ const emit = defineEmits<{
|
|
|
2503
2512
|
* @param {object} params.event Event object
|
|
2504
2513
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
2505
2514
|
*/
|
|
2506
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
2515
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
2507
2516
|
/**
|
|
2508
2517
|
* Fires on the owning Scheduler or Gantt widget before pan starts. Return `false` to prevent the operation.
|
|
2509
2518
|
* @param {string} e Event name
|
|
@@ -2511,7 +2520,7 @@ const emit = defineEmits<{
|
|
|
2511
2520
|
* @param {object} params.event Event object
|
|
2512
2521
|
* @param {Event} params.event.event The native browser DOM event
|
|
2513
2522
|
*/
|
|
2514
|
-
(e: 'beforePan', params: ((event: { event: Event }) =>
|
|
2523
|
+
(e: 'beforePan', params: ((event: { event: Event }) => boolean|void)|string): boolean|void
|
|
2515
2524
|
/**
|
|
2516
2525
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
2517
2526
|
* @param {string} e Event name
|
|
@@ -2531,7 +2540,7 @@ const emit = defineEmits<{
|
|
|
2531
2540
|
* @param {object} params.event Event object
|
|
2532
2541
|
* @param {PdfExportConfig} params.event.config Export config
|
|
2533
2542
|
*/
|
|
2534
|
-
(e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) =>
|
|
2543
|
+
(e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) => boolean|void)|string): boolean|void
|
|
2535
2544
|
/**
|
|
2536
2545
|
* Fired before the [viewPreset](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
2537
2546
|
* @param {string} e Event name
|
|
@@ -2543,7 +2552,7 @@ const emit = defineEmits<{
|
|
|
2543
2552
|
* @param {Scheduler.preset.ViewPreset} params.event.from The outgoing ViewPreset.
|
|
2544
2553
|
* @param {Scheduler.preset.ViewPreset} params.event.to The ViewPreset being switched to.
|
|
2545
2554
|
*/
|
|
2546
|
-
(e: 'beforePresetChange', params: ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) =>
|
|
2555
|
+
(e: 'beforePresetChange', params: ((event: { source: Scheduler, startDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => boolean|void)|string): boolean|void
|
|
2547
2556
|
/**
|
|
2548
2557
|
* Fires before a row is rendered.
|
|
2549
2558
|
* @param {string} e Event name
|
|
@@ -2592,7 +2601,7 @@ const emit = defineEmits<{
|
|
|
2592
2601
|
* @param {Scheduler.util.TimelineContext[]} params.event.selectedContexts The context objects containing information about the selected cells
|
|
2593
2602
|
* @param {DomConfig} params.event.domConfig A [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) config object which is used to render the selected cell elements.
|
|
2594
2603
|
*/
|
|
2595
|
-
(e: 'beforeSelectedContextsShow', params: ((event: { source: ScheduleContext, selectedContexts: TimelineContext[], domConfig: DomConfig }) =>
|
|
2604
|
+
(e: 'beforeSelectedContextsShow', params: ((event: { source: ScheduleContext, selectedContexts: TimelineContext[], domConfig: DomConfig }) => boolean|void)|string): boolean|void
|
|
2596
2605
|
/**
|
|
2597
2606
|
* Fires before the selection changes. Returning `false` from a listener prevents the change
|
|
2598
2607
|
* @param {string} e Event name
|
|
@@ -2608,7 +2617,7 @@ const emit = defineEmits<{
|
|
|
2608
2617
|
* @param {Grid.util.GridLocation[]} params.event.selectedCells The cells to be selected in this operation.
|
|
2609
2618
|
* @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
2610
2619
|
*/
|
|
2611
|
-
(e: 'beforeSelectionChange', params: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
2620
|
+
(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
|
|
2612
2621
|
/**
|
|
2613
2622
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
2614
2623
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -2635,7 +2644,7 @@ const emit = defineEmits<{
|
|
|
2635
2644
|
* @param {object} params.event Event object
|
|
2636
2645
|
* @param {Scheduler.model.TimeSpan} params.event.source The hovered task
|
|
2637
2646
|
*/
|
|
2638
|
-
(e: 'beforeShowTerminals', params: ((event: { source: TimeSpan }) =>
|
|
2647
|
+
(e: 'beforeShowTerminals', params: ((event: { source: TimeSpan }) => boolean|void)|string): boolean|void
|
|
2639
2648
|
/**
|
|
2640
2649
|
* Fires on the owning Grid before editing starts, return `false` to prevent editing
|
|
2641
2650
|
* @param {string} e Event name
|
|
@@ -2644,7 +2653,7 @@ const emit = defineEmits<{
|
|
|
2644
2653
|
* @param {Grid.view.Grid} params.event.source Owner grid
|
|
2645
2654
|
* @param {RowEditorContext} params.event.editorContext Editing context
|
|
2646
2655
|
*/
|
|
2647
|
-
(e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
2656
|
+
(e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string): boolean|void
|
|
2648
2657
|
/**
|
|
2649
2658
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
2650
2659
|
* @param {string} e Event name
|
|
@@ -2652,7 +2661,7 @@ const emit = defineEmits<{
|
|
|
2652
2661
|
* @param {object} params.event Event object
|
|
2653
2662
|
* @param {SchedulerStateInfo} params.event.state State object config
|
|
2654
2663
|
*/
|
|
2655
|
-
(e: 'beforeStateApply', params: ((event: { state: SchedulerStateInfo }) =>
|
|
2664
|
+
(e: 'beforeStateApply', params: ((event: { state: SchedulerStateInfo }) => boolean|void)|string): boolean|void
|
|
2656
2665
|
/**
|
|
2657
2666
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
2658
2667
|
* @param {string} e Event name
|
|
@@ -2660,7 +2669,7 @@ const emit = defineEmits<{
|
|
|
2660
2669
|
* @param {object} params.event Event object
|
|
2661
2670
|
* @param {SchedulerStateInfo} params.event.state State object config
|
|
2662
2671
|
*/
|
|
2663
|
-
(e: 'beforeStateSave', params: ((event: { state: SchedulerStateInfo }) =>
|
|
2672
|
+
(e: 'beforeStateSave', params: ((event: { state: SchedulerStateInfo }) => boolean|void)|string): boolean|void
|
|
2664
2673
|
/**
|
|
2665
2674
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
2666
2675
|
* Returning `false` from a listener prevents the operation
|
|
@@ -2672,7 +2681,7 @@ const emit = defineEmits<{
|
|
|
2672
2681
|
* @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
|
|
2673
2682
|
* @param {Event} params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
2674
2683
|
*/
|
|
2675
|
-
(e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
2684
|
+
(e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
2676
2685
|
/**
|
|
2677
2686
|
* Fired before a parent node record toggles its collapsed state.
|
|
2678
2687
|
* @param {string} e Event name
|
|
@@ -2755,7 +2764,7 @@ const emit = defineEmits<{
|
|
|
2755
2764
|
* @param {Grid.column.Column} params.event.column Column
|
|
2756
2765
|
* @param {Core.data.Model} params.event.record Record
|
|
2757
2766
|
*/
|
|
2758
|
-
(e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
2767
|
+
(e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string): boolean|void
|
|
2759
2768
|
/**
|
|
2760
2769
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
2761
2770
|
* @param {string} e Event name
|
|
@@ -2908,7 +2917,7 @@ const emit = defineEmits<{
|
|
|
2908
2917
|
* @param {Event} params.event.event The browser event.
|
|
2909
2918
|
* @param {string} params.event.region The region where the column was dropped.
|
|
2910
2919
|
*/
|
|
2911
|
-
(e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
2920
|
+
(e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string): boolean|void
|
|
2912
2921
|
/**
|
|
2913
2922
|
* This event is fired after a resize gesture is completed.
|
|
2914
2923
|
* @param {string} e Event name
|
|
@@ -3067,7 +3076,7 @@ const emit = defineEmits<{
|
|
|
3067
3076
|
* @param {HTMLElement} params.event.element
|
|
3068
3077
|
* @param {MouseEvent} [params.event.event] Pointer event which triggered the context menu (if any)
|
|
3069
3078
|
*/
|
|
3070
|
-
(e: 'dependencyMenuBeforeShow', params: ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, dependencyRecord: DependencyModel, element: HTMLElement, event?: MouseEvent }) =>
|
|
3079
|
+
(e: 'dependencyMenuBeforeShow', params: ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, dependencyRecord: DependencyModel, element: HTMLElement, event?: MouseEvent }) => boolean|void)|string): boolean|void
|
|
3071
3080
|
/**
|
|
3072
3081
|
* This event fires on the owning Scheduler when an item is selected in the context menu.
|
|
3073
3082
|
* @param {string} e Event name
|
|
@@ -3393,7 +3402,7 @@ const emit = defineEmits<{
|
|
|
3393
3402
|
* @param {HTMLElement} params.event.eventElement
|
|
3394
3403
|
* @param {MouseEvent} [params.event.event] Pointer event which triggered the context menu (if any)
|
|
3395
3404
|
*/
|
|
3396
|
-
(e: 'eventMenuBeforeShow', params: ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, eventElement: HTMLElement, event?: MouseEvent }) =>
|
|
3405
|
+
(e: 'eventMenuBeforeShow', params: ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, eventElement: HTMLElement, event?: MouseEvent }) => boolean|void)|string): boolean|void
|
|
3397
3406
|
/**
|
|
3398
3407
|
* This event fires on the owning Scheduler when an item is selected in the context menu.
|
|
3399
3408
|
* @param {string} e Event name
|
|
@@ -3654,7 +3663,7 @@ const emit = defineEmits<{
|
|
|
3654
3663
|
* @param {Grid.util.GridLocation} params.event.cell Information about the column / record
|
|
3655
3664
|
* @param {MouseEvent} params.event.domEvent The raw DOM event
|
|
3656
3665
|
*/
|
|
3657
|
-
(e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
3666
|
+
(e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
|
|
3658
3667
|
/**
|
|
3659
3668
|
* Fires on the owning Grid when cell editing is finished
|
|
3660
3669
|
* @param {string} e Event name
|
|
@@ -3712,7 +3721,7 @@ const emit = defineEmits<{
|
|
|
3712
3721
|
* @param {Core.data.Model[]} params.event.context.records The dragged row records
|
|
3713
3722
|
* @param {MouseEvent,TouchEvent} params.event.event
|
|
3714
3723
|
*/
|
|
3715
|
-
(e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
3724
|
+
(e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string): boolean|void
|
|
3716
3725
|
/**
|
|
3717
3726
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
3718
3727
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -3791,7 +3800,7 @@ const emit = defineEmits<{
|
|
|
3791
3800
|
* @param {Event} params.event.domEvent The triggering DOM event.
|
|
3792
3801
|
* @param {Grid.column.Column} params.event.column The column clicked on.
|
|
3793
3802
|
*/
|
|
3794
|
-
(e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) =>
|
|
3803
|
+
(e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => boolean|void)|string): boolean|void
|
|
3795
3804
|
/**
|
|
3796
3805
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
3797
3806
|
* 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).
|
|
@@ -3804,7 +3813,7 @@ const emit = defineEmits<{
|
|
|
3804
3813
|
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
3805
3814
|
* @param {Grid.column.Column} params.event.column Column
|
|
3806
3815
|
*/
|
|
3807
|
-
(e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
3816
|
+
(e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string): boolean|void
|
|
3808
3817
|
/**
|
|
3809
3818
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
3810
3819
|
* @param {string} e Event name
|
|
@@ -3956,7 +3965,7 @@ const emit = defineEmits<{
|
|
|
3956
3965
|
* @param {Scheduler.preset.ViewPreset} params.event.from The outgoing ViewPreset.
|
|
3957
3966
|
* @param {Scheduler.preset.ViewPreset} params.event.to The ViewPreset being switched to.
|
|
3958
3967
|
*/
|
|
3959
|
-
(e: 'presetChange', params: ((event: { source: Scheduler, startDate: Date, centerDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) =>
|
|
3968
|
+
(e: 'presetChange', params: ((event: { source: Scheduler, startDate: Date, centerDate: Date, endDate: Date, from: ViewPreset, to: ViewPreset }) => boolean|void)|string): boolean|void
|
|
3960
3969
|
/**
|
|
3961
3970
|
* Fired when a Widget's read only state is toggled
|
|
3962
3971
|
* @param {string} e Event name
|
|
@@ -4039,7 +4048,7 @@ const emit = defineEmits<{
|
|
|
4039
4048
|
* @param {Scheduler.model.ResourceModel} params.event.context.resource The dragged resource
|
|
4040
4049
|
* @param {MouseEvent,TouchEvent} params.event.event
|
|
4041
4050
|
*/
|
|
4042
|
-
(e: 'resourceColumnBeforeDragStart', params: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) =>
|
|
4051
|
+
(e: 'resourceColumnBeforeDragStart', params: ((event: { source: Scheduler, context: { resource: ResourceModel }, event: MouseEvent|TouchEvent }) => boolean|void)|string): boolean|void
|
|
4043
4052
|
/**
|
|
4044
4053
|
* Fired before the drop is finalized. You can return `false` or a Promise that resolves to `false`
|
|
4045
4054
|
* to cancel the drop operation.
|
|
@@ -4148,7 +4157,7 @@ const emit = defineEmits<{
|
|
|
4148
4157
|
* @param {Grid.column.Column} params.event.column Column
|
|
4149
4158
|
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord Record
|
|
4150
4159
|
*/
|
|
4151
|
-
(e: 'resourceMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, resourceRecord: ResourceModel }) =>
|
|
4160
|
+
(e: 'resourceMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, resourceRecord: ResourceModel }) => boolean|void)|string): boolean|void
|
|
4152
4161
|
/**
|
|
4153
4162
|
* This event fires on the owning scheduler when an item is selected in the context menu.
|
|
4154
4163
|
* @param {string} e Event name
|
|
@@ -4394,7 +4403,7 @@ const emit = defineEmits<{
|
|
|
4394
4403
|
* @param {Scheduler.model.AssignmentModel} params.event.assignmentRecord Assignment record, if assignments are used
|
|
4395
4404
|
* @param {HTMLElement} params.event.eventElement
|
|
4396
4405
|
*/
|
|
4397
|
-
(e: 'scheduleMenuBeforeShow', params: ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, resourceRecord: ResourceModel, date: Date, assignmentRecord: AssignmentModel, eventElement: HTMLElement }) =>
|
|
4406
|
+
(e: 'scheduleMenuBeforeShow', params: ((event: { source: Scheduler, items: Record<string, MenuItemEntry>, resourceRecord: ResourceModel, date: Date, assignmentRecord: AssignmentModel, eventElement: HTMLElement }) => boolean|void)|string): boolean|void
|
|
4398
4407
|
/**
|
|
4399
4408
|
* This event fires on the owning Scheduler or Gantt widget when an item is selected in the context menu.
|
|
4400
4409
|
* @param {string} e Event name
|
|
@@ -4508,7 +4517,7 @@ const emit = defineEmits<{
|
|
|
4508
4517
|
* @param {Event} params.event.domEvent DOM event
|
|
4509
4518
|
* @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource record
|
|
4510
4519
|
*/
|
|
4511
|
-
(e: 'scrollButtonClick', params: ((event: { domEvent: Event, resourceRecord: ResourceModel }) =>
|
|
4520
|
+
(e: 'scrollButtonClick', params: ((event: { domEvent: Event, resourceRecord: ResourceModel }) => boolean|void)|string): boolean|void
|
|
4512
4521
|
/**
|
|
4513
4522
|
* The selection has been changed.
|
|
4514
4523
|
* @param {string} e Event name
|
|
@@ -4574,7 +4583,7 @@ const emit = defineEmits<{
|
|
|
4574
4583
|
* @param {Grid.view.SubGrid} params.event.subGrid The subgrid
|
|
4575
4584
|
* @param {Event} params.event.domEvent The native DOM event
|
|
4576
4585
|
*/
|
|
4577
|
-
(e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
4586
|
+
(e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
4578
4587
|
/**
|
|
4579
4588
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
4580
4589
|
* @param {string} e Event name
|
|
@@ -4605,7 +4614,7 @@ const emit = defineEmits<{
|
|
|
4605
4614
|
* @param {Grid.view.SubGrid} params.event.subGrid The subgrid
|
|
4606
4615
|
* @param {Event} params.event.domEvent The native DOM event
|
|
4607
4616
|
*/
|
|
4608
|
-
(e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
4617
|
+
(e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
|
|
4609
4618
|
/**
|
|
4610
4619
|
* Fires on the owning Grid when editing starts
|
|
4611
4620
|
* @param {string} e Event name
|
|
@@ -4778,7 +4787,7 @@ const emit = defineEmits<{
|
|
|
4778
4787
|
* @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
|
|
4779
4788
|
* @param {Grid.column.Column} params.event.column Time axis column
|
|
4780
4789
|
*/
|
|
4781
|
-
(e: 'timeAxisHeaderMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
4790
|
+
(e: 'timeAxisHeaderMenuBeforeShow', params: ((event: { source: Scheduler, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string): boolean|void
|
|
4782
4791
|
/**
|
|
4783
4792
|
* This event fires on the owning Scheduler or Gantt widget when an item is selected in the header context menu.
|
|
4784
4793
|
* @param {string} e Event name
|
|
@@ -5043,6 +5052,7 @@ const widgetData = {
|
|
|
5043
5052
|
'preserveFocusOnDatasetChange',
|
|
5044
5053
|
'preserveScrollOnDatasetChange',
|
|
5045
5054
|
'preventTooltipOnTouch',
|
|
5055
|
+
'projectModelClass',
|
|
5046
5056
|
'relayStoreEvents',
|
|
5047
5057
|
'resizable',
|
|
5048
5058
|
'resizeToFitIncludesHeader',
|
|
@@ -921,6 +921,11 @@ export declare type BryntumSchedulerBaseProps = {
|
|
|
921
921
|
* [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/view/SchedulerBase#config-project)
|
|
922
922
|
*/
|
|
923
923
|
project ? : ProjectModel|ProjectModelConfig|object
|
|
924
|
+
/**
|
|
925
|
+
* The project model class to use when creating the project instance. Override this to use a custom project
|
|
926
|
+
* model class. In SchedulerPro and Gantt, this is overridden to use their respective project model classes.
|
|
927
|
+
*/
|
|
928
|
+
projectModelClass ? : typeof ProjectModel
|
|
924
929
|
/**
|
|
925
930
|
* Range used to set the length of the time axis when used as a component of a Calendar. Suitable units are
|
|
926
931
|
* `'month'`, `'week'` and `'day'`.
|
|
@@ -873,7 +873,7 @@ const emit = defineEmits<{
|
|
|
873
873
|
* @param {object} params.event Event object
|
|
874
874
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
875
875
|
*/
|
|
876
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
876
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
877
877
|
/**
|
|
878
878
|
* Fires before this CalendarPanel refreshes in response to changes in its month.
|
|
879
879
|
* @param {string} e Event name
|
|
@@ -907,7 +907,7 @@ const emit = defineEmits<{
|
|
|
907
907
|
* @param {object} params.event Event object
|
|
908
908
|
* @param {any} params.event.state State object config
|
|
909
909
|
*/
|
|
910
|
-
(e: 'beforeStateApply', params: ((event: { state: any }) =>
|
|
910
|
+
(e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
911
911
|
/**
|
|
912
912
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
913
913
|
* @param {string} e Event name
|
|
@@ -915,7 +915,7 @@ const emit = defineEmits<{
|
|
|
915
915
|
* @param {object} params.event Event object
|
|
916
916
|
* @param {any} params.event.state State object config
|
|
917
917
|
*/
|
|
918
|
-
(e: 'beforeStateSave', params: ((event: { state: any }) =>
|
|
918
|
+
(e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
|
|
919
919
|
/**
|
|
920
920
|
* Fires when any other event is fired from the object.
|
|
921
921
|
* [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/SchedulerDatePicker#event-catchAll)
|
|
@@ -921,6 +921,11 @@ export declare type BryntumSchedulerProps = {
|
|
|
921
921
|
* [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/view/Scheduler#config-project)
|
|
922
922
|
*/
|
|
923
923
|
project ? : ProjectModel|ProjectModelConfig|object
|
|
924
|
+
/**
|
|
925
|
+
* The project model class to use when creating the project instance. Override this to use a custom project
|
|
926
|
+
* model class. In SchedulerPro and Gantt, this is overridden to use their respective project model classes.
|
|
927
|
+
*/
|
|
928
|
+
projectModelClass ? : typeof ProjectModel
|
|
924
929
|
/**
|
|
925
930
|
* Range used to set the length of the time axis when used as a component of a Calendar. Suitable units are
|
|
926
931
|
* `'month'`, `'week'` and `'day'`.
|
|
@@ -108,6 +108,15 @@ defineProps<{
|
|
|
108
108
|
* A value of `undefined` will cause this widget not to include its value when checked.
|
|
109
109
|
*/
|
|
110
110
|
checkedValue ? : any
|
|
111
|
+
/**
|
|
112
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
113
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#property-isValid)
|
|
114
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
|
|
115
|
+
* [More...](https://bryntum.com/products/calendar/docs/api/Core/widget/SlideToggle#config-checkValidity)
|
|
116
|
+
* @param {Core.widget.Field} field The field being validated
|
|
117
|
+
* @returns {void}
|
|
118
|
+
*/
|
|
119
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
111
120
|
/**
|
|
112
121
|
* Custom CSS classes to add to element.
|
|
113
122
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -624,7 +633,7 @@ const emit = defineEmits<{
|
|
|
624
633
|
* @param {boolean} params.event.valid True if this field is in a valid state.
|
|
625
634
|
* @param {Event} params.event.event The triggering DOM event if any
|
|
626
635
|
*/
|
|
627
|
-
(e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) =>
|
|
636
|
+
(e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => boolean|void)|string): boolean|void
|
|
628
637
|
/**
|
|
629
638
|
* Fires before an object is destroyed.
|
|
630
639
|
* @param {string} e Event name
|
|
@@ -640,7 +649,7 @@ const emit = defineEmits<{
|
|
|
640
649
|
* @param {object} params.event Event object
|
|
641
650
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
642
651
|
*/
|
|
643
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
652
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
644
653
|
/**
|
|
645
654
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
646
655
|
* @param {string} e Event name
|
|
@@ -824,6 +833,7 @@ const widgetData = {
|
|
|
824
833
|
'bubbleEvents',
|
|
825
834
|
'centered',
|
|
826
835
|
'checkedValue',
|
|
836
|
+
'checkValidity',
|
|
827
837
|
'color',
|
|
828
838
|
'config',
|
|
829
839
|
'constrainTo',
|
|
@@ -94,6 +94,15 @@ export declare type BryntumSlideToggleProps = {
|
|
|
94
94
|
* A value of `undefined` will cause this widget not to include its value when checked.
|
|
95
95
|
*/
|
|
96
96
|
checkedValue ? : any
|
|
97
|
+
/**
|
|
98
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
99
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#property-isValid)
|
|
100
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
|
|
101
|
+
* [More...](https://bryntum.com/products/calendar/docs/api/Core/widget/SlideToggle#config-checkValidity)
|
|
102
|
+
* @param {Core.widget.Field} field The field being validated
|
|
103
|
+
* @returns {void}
|
|
104
|
+
*/
|
|
105
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
97
106
|
/**
|
|
98
107
|
* Custom CSS classes to add to element.
|
|
99
108
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -512,7 +512,7 @@ const emit = defineEmits<{
|
|
|
512
512
|
* @param {object} params.event Event object
|
|
513
513
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
514
514
|
*/
|
|
515
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
515
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
516
516
|
/**
|
|
517
517
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
518
518
|
* @param {string} e Event name
|
|
@@ -454,7 +454,7 @@ const emit = defineEmits<{
|
|
|
454
454
|
* @param {object} params.event Event object
|
|
455
455
|
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
456
456
|
*/
|
|
457
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
457
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
458
458
|
/**
|
|
459
459
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
460
460
|
* @param {string} e Event name
|