@bryntum/calendar-vue-3 7.2.0 → 7.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/chunks/AuFgCdLX.js.map +1 -1
- package/lib/chunks/B4_IqbDS.js.map +1 -1
- package/lib/chunks/B7YXa-I1.js.map +1 -1
- package/lib/chunks/B8RAuv9v.js.map +1 -1
- package/lib/chunks/B8gugSPH.js.map +1 -1
- package/lib/chunks/{Ch59oTZI.js → BDVK3ih3.js} +6 -4
- package/lib/chunks/BDVK3ih3.js.map +1 -0
- package/lib/chunks/BHuV4eJ2.js.map +1 -1
- package/lib/chunks/BO4n9DQP.js.map +1 -1
- package/lib/chunks/{D2U_kuKA.js → BOnm1I34.js} +4 -2
- package/lib/chunks/BOnm1I34.js.map +1 -0
- package/lib/chunks/BPTCZ6IE.js.map +1 -1
- package/lib/chunks/{CQYCteeF.js → BeLjASq2.js} +7 -9
- package/lib/chunks/BeLjASq2.js.map +1 -0
- package/lib/chunks/BfbKG2Q9.js.map +1 -1
- package/lib/chunks/BhoSqDZl.js.map +1 -1
- package/lib/chunks/BmTK3Q03.js.map +1 -1
- package/lib/chunks/{CNaG4gNt.js → BqjJWGYH.js} +6 -4
- package/lib/chunks/BqjJWGYH.js.map +1 -0
- package/lib/chunks/BtTswK-2.js.map +1 -1
- package/lib/chunks/BvJ77_94.js.map +1 -1
- package/lib/chunks/{BYwbKAIu.js → Bxe38CDH.js} +4 -2
- package/lib/chunks/Bxe38CDH.js.map +1 -0
- package/lib/chunks/{-CJ-30JA.js → C88DnD0Q.js} +4 -2
- package/lib/chunks/C88DnD0Q.js.map +1 -0
- package/lib/chunks/CIQAmaY-.js.map +1 -1
- package/lib/chunks/{Blkgab9S.js → CUk9Mo9a.js} +3 -5
- package/lib/chunks/CUk9Mo9a.js.map +1 -0
- package/lib/chunks/CW4ZETjg.js.map +1 -1
- package/lib/chunks/CWqNGMcV.js.map +1 -1
- package/lib/chunks/C_mtEjpv.js.map +1 -1
- package/lib/chunks/Ce5lJzzn.js.map +1 -1
- package/lib/chunks/CoATnIIv.js.map +1 -1
- package/lib/chunks/CocHPfxT.js.map +1 -1
- package/lib/chunks/{DO0PUBED.js → CshnxH5i.js} +4 -2
- package/lib/chunks/CshnxH5i.js.map +1 -0
- package/lib/chunks/Cz07volV.js.map +1 -1
- package/lib/chunks/D-frdMjd.js.map +1 -1
- package/lib/chunks/D2pGT64x.js.map +1 -1
- package/lib/chunks/D65UKHfq.js.map +1 -1
- package/lib/chunks/DDCIqYqw.js.map +1 -1
- package/lib/chunks/{ZjOFly06.js → DPZhUx1w.js} +3 -3
- package/lib/chunks/DPZhUx1w.js.map +1 -0
- package/lib/chunks/DWa9zkiz.js.map +1 -1
- package/lib/chunks/DXlCOnqx.js.map +1 -1
- package/lib/chunks/Dcppz32C.js.map +1 -1
- package/lib/chunks/DdFEd1cr.js.map +1 -1
- package/lib/chunks/DlB-5MPr.js.map +1 -1
- package/lib/chunks/DlS1ldri.js.map +1 -1
- package/lib/chunks/Dw-ylqNh.js.map +1 -1
- package/lib/chunks/Dxf58SvP.js.map +1 -1
- package/lib/chunks/{gtjnnwQX.js → DzP54eL2.js} +9 -7
- package/lib/chunks/DzP54eL2.js.map +1 -0
- package/lib/chunks/DzU3frDv.js.map +1 -1
- package/lib/chunks/N4SJNjPG.js.map +1 -1
- package/lib/chunks/Ot6TFUU0.js.map +1 -1
- package/lib/chunks/SLEVEsHl.js.map +1 -1
- package/lib/chunks/{CCqSjypI.js → UB71pEbF.js} +7 -5
- package/lib/chunks/UB71pEbF.js.map +1 -0
- package/lib/chunks/hfgcSOCj.js.map +1 -1
- package/lib/chunks/jDPujxEl.js.map +1 -1
- package/lib/chunks/lsEyA_FU.js.map +1 -1
- package/lib/chunks/q6XtT4cQ.js.map +1 -1
- package/lib/components/BryntumAgendaView.js +1 -1
- package/lib/components/BryntumEventList.js +1 -1
- package/lib/components/BryntumGrid.js +1 -1
- package/lib/components/BryntumGridBase.js +1 -1
- package/lib/components/BryntumMonthAgendaView.js +1 -1
- package/lib/components/BryntumMonthGrid.js +1 -1
- package/lib/components/BryntumScheduler.js +1 -1
- package/lib/components/BryntumSchedulerBase.js +1 -1
- package/lib/components/BryntumTimelineHistogram.js +1 -1
- package/lib/components/BryntumTreeGrid.js +1 -1
- package/lib/components/BryntumYearView.js +1 -1
- package/lib/index.js +11 -11
- package/package.json +1 -1
- package/src/components/BryntumAIFilterField.vue +1 -1
- package/src/components/BryntumAIFilterFieldProps.ts +1 -1
- package/src/components/BryntumAgendaView.vue +19 -7
- package/src/components/BryntumAgendaViewProps.ts +5 -5
- package/src/components/BryntumCalendar.vue +20 -16
- package/src/components/BryntumCalendarDatePicker.vue +1 -1
- package/src/components/BryntumCalendarDatePickerProps.ts +1 -1
- package/src/components/BryntumCalendarProps.ts +3 -2
- package/src/components/BryntumCheckbox.vue +1 -1
- package/src/components/BryntumCheckboxProps.ts +1 -1
- package/src/components/BryntumChecklistFilterCombo.vue +2 -2
- package/src/components/BryntumChecklistFilterComboProps.ts +2 -2
- package/src/components/BryntumChipView.vue +1 -1
- package/src/components/BryntumChipViewProps.ts +1 -1
- package/src/components/BryntumColorField.vue +1 -1
- package/src/components/BryntumColorFieldProps.ts +1 -1
- package/src/components/BryntumCombo.vue +2 -2
- package/src/components/BryntumComboProps.ts +2 -2
- package/src/components/BryntumDateField.vue +1 -1
- package/src/components/BryntumDateFieldProps.ts +1 -1
- package/src/components/BryntumDateRangeField.vue +1 -1
- package/src/components/BryntumDateRangeFieldProps.ts +1 -1
- package/src/components/BryntumDateTimeField.vue +1 -1
- package/src/components/BryntumDateTimeFieldProps.ts +1 -1
- package/src/components/BryntumDayAgendaView.vue +1 -1
- package/src/components/BryntumDayAgendaViewProps.ts +1 -1
- package/src/components/BryntumDayResourceView.vue +1 -1
- package/src/components/BryntumDayResourceViewProps.ts +1 -1
- package/src/components/BryntumDayView.vue +1 -1
- package/src/components/BryntumDayViewProps.ts +1 -1
- package/src/components/BryntumDisplayField.vue +1 -1
- package/src/components/BryntumDisplayFieldProps.ts +1 -1
- package/src/components/BryntumDurationField.vue +1 -1
- package/src/components/BryntumDurationFieldProps.ts +1 -1
- package/src/components/BryntumEditor.vue +3 -3
- package/src/components/BryntumEditorProps.ts +1 -1
- package/src/components/BryntumEventColorField.vue +1 -1
- package/src/components/BryntumEventColorFieldProps.ts +1 -1
- package/src/components/BryntumEventList.vue +19 -7
- package/src/components/BryntumEventListProps.ts +5 -5
- package/src/components/BryntumFileField.vue +1 -1
- package/src/components/BryntumFileFieldProps.ts +1 -1
- package/src/components/BryntumFilterField.vue +1 -1
- package/src/components/BryntumFilterFieldProps.ts +1 -1
- package/src/components/BryntumGrid.vue +18 -6
- package/src/components/BryntumGridBase.vue +18 -6
- package/src/components/BryntumGridBaseProps.ts +4 -4
- package/src/components/BryntumGridProps.ts +4 -4
- package/src/components/BryntumGroupBar.vue +1 -1
- package/src/components/BryntumGroupBarProps.ts +1 -1
- package/src/components/BryntumHint.vue +1 -1
- package/src/components/BryntumHintProps.ts +1 -1
- package/src/components/BryntumList.vue +1 -1
- package/src/components/BryntumListProps.ts +1 -1
- package/src/components/BryntumMenu.vue +1 -1
- package/src/components/BryntumMenuProps.ts +1 -1
- package/src/components/BryntumMonthAgendaView.vue +3 -3
- package/src/components/BryntumMonthAgendaViewProps.ts +2 -2
- package/src/components/BryntumMonthGrid.vue +1 -8
- package/src/components/BryntumMonthGridProps.ts +1 -7
- package/src/components/BryntumMonthView.vue +2 -2
- package/src/components/BryntumMonthViewProps.ts +2 -2
- package/src/components/BryntumNumberField.vue +1 -1
- package/src/components/BryntumNumberFieldProps.ts +1 -1
- package/src/components/BryntumPasswordField.vue +1 -1
- package/src/components/BryntumPasswordFieldProps.ts +1 -1
- package/src/components/BryntumProjectCombo.vue +2 -2
- package/src/components/BryntumProjectComboProps.ts +2 -2
- package/src/components/BryntumRadio.vue +1 -1
- package/src/components/BryntumRadioProps.ts +1 -1
- package/src/components/BryntumRangeMenu.vue +1 -1
- package/src/components/BryntumRangeMenuProps.ts +1 -1
- package/src/components/BryntumResourceCombo.vue +2 -2
- package/src/components/BryntumResourceComboProps.ts +2 -2
- package/src/components/BryntumResourceFilter.vue +1 -1
- package/src/components/BryntumResourceFilterProps.ts +1 -1
- package/src/components/BryntumScheduler.vue +27 -14
- package/src/components/BryntumSchedulerBase.vue +27 -14
- package/src/components/BryntumSchedulerBaseProps.ts +8 -8
- package/src/components/BryntumSchedulerProps.ts +8 -8
- package/src/components/BryntumSlideToggle.vue +1 -1
- package/src/components/BryntumSlideToggleProps.ts +1 -1
- package/src/components/BryntumSlider.vue +1 -1
- package/src/components/BryntumSliderProps.ts +1 -1
- package/src/components/BryntumTextAreaField.vue +1 -1
- package/src/components/BryntumTextAreaFieldProps.ts +1 -1
- package/src/components/BryntumTextAreaPickerField.vue +1 -1
- package/src/components/BryntumTextAreaPickerFieldProps.ts +1 -1
- package/src/components/BryntumTextField.vue +1 -1
- package/src/components/BryntumTextFieldProps.ts +1 -1
- package/src/components/BryntumTimeField.vue +1 -1
- package/src/components/BryntumTimeFieldProps.ts +1 -1
- package/src/components/BryntumTimeVisualizingEditor.vue +1 -1
- package/src/components/BryntumTimeVisualizingEditorProps.ts +1 -1
- package/src/components/BryntumTimelineHistogram.vue +20 -8
- package/src/components/BryntumTimelineHistogramProps.ts +4 -4
- package/src/components/BryntumTreeCombo.vue +2 -2
- package/src/components/BryntumTreeComboProps.ts +2 -2
- package/src/components/BryntumTreeGrid.vue +18 -6
- package/src/components/BryntumTreeGridProps.ts +4 -4
- package/src/components/BryntumWeekView.vue +1 -1
- package/src/components/BryntumWeekViewProps.ts +1 -1
- package/src/components/BryntumYearView.vue +1 -8
- package/src/components/BryntumYearViewProps.ts +1 -7
- package/lib/chunks/-CJ-30JA.js.map +0 -1
- package/lib/chunks/BYwbKAIu.js.map +0 -1
- package/lib/chunks/Blkgab9S.js.map +0 -1
- package/lib/chunks/CCqSjypI.js.map +0 -1
- package/lib/chunks/CNaG4gNt.js.map +0 -1
- package/lib/chunks/CQYCteeF.js.map +0 -1
- package/lib/chunks/Ch59oTZI.js.map +0 -1
- package/lib/chunks/D2U_kuKA.js.map +0 -1
- package/lib/chunks/DO0PUBED.js.map +0 -1
- package/lib/chunks/ZjOFly06.js.map +0 -1
- package/lib/chunks/gtjnnwQX.js.map +0 -1
|
@@ -189,7 +189,7 @@ defineProps<{
|
|
|
189
189
|
contentElementCls ? : string|object
|
|
190
190
|
/**
|
|
191
191
|
* If configured as `true`, this means that when an unmatched string is typed into the
|
|
192
|
-
* combo's input field, and
|
|
192
|
+
* combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/calendar/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
|
|
193
193
|
* a new record will be created using the typed string as the [displayField](https://bryntum.com/products/calendar/docs/api/Core/widget/Combo#config-displayField).
|
|
194
194
|
* ...
|
|
195
195
|
* [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/Combo#config-createOnUnmatched)
|
|
@@ -684,7 +684,7 @@ defineProps<{
|
|
|
684
684
|
required ? : Boolean
|
|
685
685
|
/**
|
|
686
686
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
687
|
-
* the
|
|
687
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
688
688
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
689
689
|
* behaviour will be activated.
|
|
690
690
|
*/
|
|
@@ -175,7 +175,7 @@ export declare type BryntumComboProps = {
|
|
|
175
175
|
contentElementCls ? : string|object
|
|
176
176
|
/**
|
|
177
177
|
* If configured as `true`, this means that when an unmatched string is typed into the
|
|
178
|
-
* combo's input field, and
|
|
178
|
+
* combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/calendar/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
|
|
179
179
|
* a new record will be created using the typed string as the [displayField](https://bryntum.com/products/calendar/docs/api/Core/widget/Combo#config-displayField).
|
|
180
180
|
* ...
|
|
181
181
|
* [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/Combo#config-createOnUnmatched)
|
|
@@ -670,7 +670,7 @@ export declare type BryntumComboProps = {
|
|
|
670
670
|
required ? : Boolean
|
|
671
671
|
/**
|
|
672
672
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
673
|
-
* the
|
|
673
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
674
674
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
675
675
|
* behaviour will be activated.
|
|
676
676
|
*/
|
|
@@ -546,7 +546,7 @@ defineProps<{
|
|
|
546
546
|
required ? : Boolean
|
|
547
547
|
/**
|
|
548
548
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
549
|
-
* the
|
|
549
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
550
550
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
551
551
|
* behaviour will be activated.
|
|
552
552
|
*/
|
|
@@ -532,7 +532,7 @@ export declare type BryntumDateFieldProps = {
|
|
|
532
532
|
required ? : Boolean
|
|
533
533
|
/**
|
|
534
534
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
535
|
-
* the
|
|
535
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
536
536
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
537
537
|
* behaviour will be activated.
|
|
538
538
|
*/
|
|
@@ -557,7 +557,7 @@ defineProps<{
|
|
|
557
557
|
required ? : Boolean
|
|
558
558
|
/**
|
|
559
559
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
560
|
-
* the
|
|
560
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
561
561
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
562
562
|
* behaviour will be activated.
|
|
563
563
|
*/
|
|
@@ -543,7 +543,7 @@ export declare type BryntumDateRangeFieldProps = {
|
|
|
543
543
|
required ? : Boolean
|
|
544
544
|
/**
|
|
545
545
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
546
|
-
* the
|
|
546
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
547
547
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
548
548
|
* behaviour will be activated.
|
|
549
549
|
*/
|
|
@@ -478,7 +478,7 @@ defineProps<{
|
|
|
478
478
|
required ? : Boolean
|
|
479
479
|
/**
|
|
480
480
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
481
|
-
* the
|
|
481
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
482
482
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
483
483
|
* behaviour will be activated.
|
|
484
484
|
*/
|
|
@@ -464,7 +464,7 @@ export declare type BryntumDateTimeFieldProps = {
|
|
|
464
464
|
required ? : Boolean
|
|
465
465
|
/**
|
|
466
466
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
467
|
-
* the
|
|
467
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
468
468
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
469
469
|
* behaviour will be activated.
|
|
470
470
|
*/
|
|
@@ -503,7 +503,7 @@ defineProps<{
|
|
|
503
503
|
* @param {object} detail.renderData.dataset An object which produces the `dataset` of the resulting event bar
|
|
504
504
|
* @param {boolean} detail.renderData.solidBar This is valid for views which create event bars. This is set to `true` by default for all day and interday events so that these appear as a solid block of background color. An eventRenderer may mutate this flag to change in what manner the event bar is colored - as a solid bar of color, or using the foreground color (text and icons) such as the MonthView, the CalendarRow (all day events in a DayView), and OverflowPopups
|
|
505
505
|
* @param {string} detail.renderData.bodyColor When used in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this color is applied to the body of the event element. Note that this must be light enough that the text color (From the SASS variable `$dayview-event-color`) is visible
|
|
506
|
-
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour.
|
|
506
|
+
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, renderData }) { return <MyEventComponent event={eventRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For calendars with many visible events or frequently re-rendered views, this may impact scrolling performance compared to returning plain strings or [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) objects. Consider using JSX primarily for events that require complex interactive React components.*
|
|
507
507
|
* @returns {DomConfig,DomConfig[],string,void} The content to be used as the event body.
|
|
508
508
|
*/
|
|
509
509
|
eventRenderer ? : ((detail: { view: CalendarView, eventRecord: EventModel, resourceRecord: ResourceModel, renderData: { style: object, cls: object, iconStyle: object, iconCls: object, eventColor: string, eventBackground: string, textColor: string, eventInnerStyle: object, dataset: object, solidBar: Boolean, bodyColor: string, showBullet: Boolean } }) => DomConfig|DomConfig[]|string|void)|string
|
|
@@ -489,7 +489,7 @@ export declare type BryntumDayAgendaViewProps = {
|
|
|
489
489
|
* @param {object} detail.renderData.dataset An object which produces the `dataset` of the resulting event bar
|
|
490
490
|
* @param {boolean} detail.renderData.solidBar This is valid for views which create event bars. This is set to `true` by default for all day and interday events so that these appear as a solid block of background color. An eventRenderer may mutate this flag to change in what manner the event bar is colored - as a solid bar of color, or using the foreground color (text and icons) such as the MonthView, the CalendarRow (all day events in a DayView), and OverflowPopups
|
|
491
491
|
* @param {string} detail.renderData.bodyColor When used in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this color is applied to the body of the event element. Note that this must be light enough that the text color (From the SASS variable `$dayview-event-color`) is visible
|
|
492
|
-
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour.
|
|
492
|
+
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, renderData }) { return <MyEventComponent event={eventRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For calendars with many visible events or frequently re-rendered views, this may impact scrolling performance compared to returning plain strings or [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) objects. Consider using JSX primarily for events that require complex interactive React components.*
|
|
493
493
|
* @returns {DomConfig,DomConfig[],string,void} The content to be used as the event body.
|
|
494
494
|
*/
|
|
495
495
|
eventRenderer ? : ((detail: { view: CalendarView, eventRecord: EventModel, resourceRecord: ResourceModel, renderData: { style: object, cls: object, iconStyle: object, iconCls: object, eventColor: string, eventBackground: string, textColor: string, eventInnerStyle: object, dataset: object, solidBar: Boolean, bodyColor: string, showBullet: Boolean } }) => DomConfig|DomConfig[]|string|void)|string
|
|
@@ -502,7 +502,7 @@ defineProps<{
|
|
|
502
502
|
* @param {object} detail.renderData.dataset An object which produces the `dataset` of the resulting event bar
|
|
503
503
|
* @param {boolean} detail.renderData.solidBar This is valid for views which create event bars. This is set to `true` by default for all day and interday events so that these appear as a solid block of background color. An eventRenderer may mutate this flag to change in what manner the event bar is colored - as a solid bar of color, or using the foreground color (text and icons) such as the MonthView, the CalendarRow (all day events in a DayView), and OverflowPopups
|
|
504
504
|
* @param {string} detail.renderData.bodyColor When used in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this color is applied to the body of the event element. Note that this must be light enough that the text color (From the SASS variable `$dayview-event-color`) is visible
|
|
505
|
-
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour.
|
|
505
|
+
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, renderData }) { return <MyEventComponent event={eventRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For calendars with many visible events or frequently re-rendered views, this may impact scrolling performance compared to returning plain strings or [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) objects. Consider using JSX primarily for events that require complex interactive React components.*
|
|
506
506
|
* @returns {DomConfig,DomConfig[],string,void} The content to be used as the event body.
|
|
507
507
|
*/
|
|
508
508
|
eventRenderer ? : ((detail: { view: CalendarView, eventRecord: EventModel, resourceRecord: ResourceModel, renderData: { style: object, cls: object, iconStyle: object, iconCls: object, eventColor: string, eventBackground: string, textColor: string, eventInnerStyle: object, dataset: object, solidBar: Boolean, bodyColor: string, showBullet: Boolean } }) => DomConfig|DomConfig[]|string|void)|string
|
|
@@ -488,7 +488,7 @@ export declare type BryntumDayResourceViewProps = {
|
|
|
488
488
|
* @param {object} detail.renderData.dataset An object which produces the `dataset` of the resulting event bar
|
|
489
489
|
* @param {boolean} detail.renderData.solidBar This is valid for views which create event bars. This is set to `true` by default for all day and interday events so that these appear as a solid block of background color. An eventRenderer may mutate this flag to change in what manner the event bar is colored - as a solid bar of color, or using the foreground color (text and icons) such as the MonthView, the CalendarRow (all day events in a DayView), and OverflowPopups
|
|
490
490
|
* @param {string} detail.renderData.bodyColor When used in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this color is applied to the body of the event element. Note that this must be light enough that the text color (From the SASS variable `$dayview-event-color`) is visible
|
|
491
|
-
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour.
|
|
491
|
+
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, renderData }) { return <MyEventComponent event={eventRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For calendars with many visible events or frequently re-rendered views, this may impact scrolling performance compared to returning plain strings or [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) objects. Consider using JSX primarily for events that require complex interactive React components.*
|
|
492
492
|
* @returns {DomConfig,DomConfig[],string,void} The content to be used as the event body.
|
|
493
493
|
*/
|
|
494
494
|
eventRenderer ? : ((detail: { view: CalendarView, eventRecord: EventModel, resourceRecord: ResourceModel, renderData: { style: object, cls: object, iconStyle: object, iconCls: object, eventColor: string, eventBackground: string, textColor: string, eventInnerStyle: object, dataset: object, solidBar: Boolean, bodyColor: string, showBullet: Boolean } }) => DomConfig|DomConfig[]|string|void)|string
|
|
@@ -502,7 +502,7 @@ defineProps<{
|
|
|
502
502
|
* @param {object} detail.renderData.dataset An object which produces the `dataset` of the resulting event bar
|
|
503
503
|
* @param {boolean} detail.renderData.solidBar This is valid for views which create event bars. This is set to `true` by default for all day and interday events so that these appear as a solid block of background color. An eventRenderer may mutate this flag to change in what manner the event bar is colored - as a solid bar of color, or using the foreground color (text and icons) such as the MonthView, the CalendarRow (all day events in a DayView), and OverflowPopups
|
|
504
504
|
* @param {string} detail.renderData.bodyColor When used in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this color is applied to the body of the event element. Note that this must be light enough that the text color (From the SASS variable `$dayview-event-color`) is visible
|
|
505
|
-
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour.
|
|
505
|
+
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, renderData }) { return <MyEventComponent event={eventRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For calendars with many visible events or frequently re-rendered views, this may impact scrolling performance compared to returning plain strings or [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) objects. Consider using JSX primarily for events that require complex interactive React components.*
|
|
506
506
|
* @returns {DomConfig,DomConfig[],string,void} The content to be used as the event body.
|
|
507
507
|
*/
|
|
508
508
|
eventRenderer ? : ((detail: { view: CalendarView, eventRecord: EventModel, resourceRecord: ResourceModel, renderData: { style: object, cls: object, iconStyle: object, iconCls: object, eventColor: string, eventBackground: string, textColor: string, eventInnerStyle: object, dataset: object, solidBar: Boolean, bodyColor: string, showBullet: Boolean } }) => DomConfig|DomConfig[]|string|void)|string
|
|
@@ -488,7 +488,7 @@ export declare type BryntumDayViewProps = {
|
|
|
488
488
|
* @param {object} detail.renderData.dataset An object which produces the `dataset` of the resulting event bar
|
|
489
489
|
* @param {boolean} detail.renderData.solidBar This is valid for views which create event bars. This is set to `true` by default for all day and interday events so that these appear as a solid block of background color. An eventRenderer may mutate this flag to change in what manner the event bar is colored - as a solid bar of color, or using the foreground color (text and icons) such as the MonthView, the CalendarRow (all day events in a DayView), and OverflowPopups
|
|
490
490
|
* @param {string} detail.renderData.bodyColor When used in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this color is applied to the body of the event element. Note that this must be light enough that the text color (From the SASS variable `$dayview-event-color`) is visible
|
|
491
|
-
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour.
|
|
491
|
+
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, renderData }) { return <MyEventComponent event={eventRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For calendars with many visible events or frequently re-rendered views, this may impact scrolling performance compared to returning plain strings or [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) objects. Consider using JSX primarily for events that require complex interactive React components.*
|
|
492
492
|
* @returns {DomConfig,DomConfig[],string,void} The content to be used as the event body.
|
|
493
493
|
*/
|
|
494
494
|
eventRenderer ? : ((detail: { view: CalendarView, eventRecord: EventModel, resourceRecord: ResourceModel, renderData: { style: object, cls: object, iconStyle: object, iconCls: object, eventColor: string, eventBackground: string, textColor: string, eventInnerStyle: object, dataset: object, solidBar: Boolean, bodyColor: string, showBullet: Boolean } }) => DomConfig|DomConfig[]|string|void)|string
|
|
@@ -491,7 +491,7 @@ defineProps<{
|
|
|
491
491
|
required ? : Boolean
|
|
492
492
|
/**
|
|
493
493
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
494
|
-
* the
|
|
494
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
495
495
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
496
496
|
* behaviour will be activated.
|
|
497
497
|
*/
|
|
@@ -477,7 +477,7 @@ export declare type BryntumDisplayFieldProps = {
|
|
|
477
477
|
required ? : Boolean
|
|
478
478
|
/**
|
|
479
479
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
480
|
-
* the
|
|
480
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
481
481
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
482
482
|
* behaviour will be activated.
|
|
483
483
|
*/
|
|
@@ -531,7 +531,7 @@ defineProps<{
|
|
|
531
531
|
required ? : Boolean
|
|
532
532
|
/**
|
|
533
533
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
534
|
-
* the
|
|
534
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
535
535
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
536
536
|
* behaviour will be activated.
|
|
537
537
|
*/
|
|
@@ -517,7 +517,7 @@ export declare type BryntumDurationFieldProps = {
|
|
|
517
517
|
required ? : Boolean
|
|
518
518
|
/**
|
|
519
519
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
520
|
-
* the
|
|
520
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
521
521
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
522
522
|
* behaviour will be activated.
|
|
523
523
|
*/
|
|
@@ -67,7 +67,7 @@ defineProps<{
|
|
|
67
67
|
*/
|
|
68
68
|
autoUpdateRecord ? : Boolean
|
|
69
69
|
/**
|
|
70
|
-
* What action should be taken when focus moves out of the editor, either by
|
|
70
|
+
* What action should be taken when focus moves out of the editor, either by <kbd>Tab</kbd> or clicking outside.
|
|
71
71
|
* May be `'complete'` or `'cancel`'. Any other value results in no action being taken upon focus leaving the editor
|
|
72
72
|
* leaving the application to listen for the [focusOut](https://bryntum.com/products/calendar/docs/api/Core/widget/Editor#event-focusOut) event.
|
|
73
73
|
*/
|
|
@@ -650,7 +650,7 @@ const emit = defineEmits<{
|
|
|
650
650
|
*/
|
|
651
651
|
(e: 'afterEdit', params: ((event: { source: Editor, record?: Model }) => void)|string): void
|
|
652
652
|
/**
|
|
653
|
-
* Fired when cancellation has been requested, either by
|
|
653
|
+
* Fired when cancellation has been requested, either by <kbd>Escape</kbd>, or focus loss (if configured to cancel on blur).
|
|
654
654
|
* The cancellation may be vetoed, in which case, focus is moved back into the editor.
|
|
655
655
|
* @param {string} e Event name
|
|
656
656
|
* @param {object} params Event parameters
|
|
@@ -662,7 +662,7 @@ const emit = defineEmits<{
|
|
|
662
662
|
*/
|
|
663
663
|
(e: 'beforeCancel', params: ((event: { oldValue: object, value: object, event: Event, source: Editor }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
664
664
|
/**
|
|
665
|
-
* Fired when an edit completion has been requested, either by
|
|
665
|
+
* Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
|
|
666
666
|
* The completion may be vetoed, in which case, focus is moved back into the editor.
|
|
667
667
|
* @param {string} e Event name
|
|
668
668
|
* @param {object} params Event parameters
|
|
@@ -53,7 +53,7 @@ export declare type BryntumEditorProps = {
|
|
|
53
53
|
*/
|
|
54
54
|
autoUpdateRecord ? : Boolean
|
|
55
55
|
/**
|
|
56
|
-
* What action should be taken when focus moves out of the editor, either by
|
|
56
|
+
* What action should be taken when focus moves out of the editor, either by <kbd>Tab</kbd> or clicking outside.
|
|
57
57
|
* May be `'complete'` or `'cancel`'. Any other value results in no action being taken upon focus leaving the editor
|
|
58
58
|
* leaving the application to listen for the [focusOut](https://bryntum.com/products/calendar/docs/api/Core/widget/Editor#event-focusOut) event.
|
|
59
59
|
*/
|
|
@@ -510,7 +510,7 @@ defineProps<{
|
|
|
510
510
|
required ? : Boolean
|
|
511
511
|
/**
|
|
512
512
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
513
|
-
* the
|
|
513
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
514
514
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
515
515
|
* behaviour will be activated.
|
|
516
516
|
*/
|
|
@@ -496,7 +496,7 @@ export declare type BryntumEventColorFieldProps = {
|
|
|
496
496
|
required ? : Boolean
|
|
497
497
|
/**
|
|
498
498
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
499
|
-
* the
|
|
499
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
500
500
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
501
501
|
* behaviour will be activated.
|
|
502
502
|
*/
|
|
@@ -435,7 +435,7 @@ defineProps<{
|
|
|
435
435
|
* @param {object} detail.renderData.dataset An object which produces the `dataset` of the resulting event bar
|
|
436
436
|
* @param {boolean} detail.renderData.solidBar This is valid for views which create event bars. This is set to `true` by default for all day and interday events so that these appear as a solid block of background color. An eventRenderer may mutate this flag to change in what manner the event bar is colored - as a solid bar of color, or using the foreground color (text and icons) such as the MonthView, the CalendarRow (all day events in a DayView), and OverflowPopups
|
|
437
437
|
* @param {string} detail.renderData.bodyColor When used in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this color is applied to the body of the event element. Note that this must be light enough that the text color (From the SASS variable `$dayview-event-color`) is visible
|
|
438
|
-
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour.
|
|
438
|
+
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, renderData }) { return <MyEventComponent event={eventRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For calendars with many visible events or frequently re-rendered views, this may impact scrolling performance compared to returning plain strings or [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) objects. Consider using JSX primarily for events that require complex interactive React components.*
|
|
439
439
|
* @returns {DomConfig,DomConfig[],string,void} The content to be used as the event body.
|
|
440
440
|
*/
|
|
441
441
|
eventRenderer ? : ((detail: { view: CalendarView, eventRecord: EventModel, resourceRecord: ResourceModel, renderData: { style: object, cls: object, iconStyle: object, iconCls: object, eventColor: string, eventBackground: string, textColor: string, eventInnerStyle: object, dataset: object, solidBar: Boolean, bodyColor: string, showBullet: Boolean } }) => DomConfig|DomConfig[]|string|void)|string
|
|
@@ -854,7 +854,7 @@ defineProps<{
|
|
|
854
854
|
rootElement ? : ShadowRoot|HTMLElement
|
|
855
855
|
/**
|
|
856
856
|
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
857
|
-
*
|
|
857
|
+
* overridden by specifying a [rowHeight](https://bryntum.com/products/calendar/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
|
|
858
858
|
* a column [renderer](https://bryntum.com/products/calendar/docs/api/Grid/column/Column#config-renderer).
|
|
859
859
|
* ...
|
|
860
860
|
* [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/EventList#config-rowHeight)
|
|
@@ -1170,7 +1170,7 @@ defineProps<{
|
|
|
1170
1170
|
cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
|
|
1171
1171
|
/**
|
|
1172
1172
|
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
1173
|
-
*
|
|
1173
|
+
* <kbd>Space</kbd> key when the cell is focused.
|
|
1174
1174
|
* ...
|
|
1175
1175
|
* [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellMenu)
|
|
1176
1176
|
*/
|
|
@@ -1270,8 +1270,8 @@ defineProps<{
|
|
|
1270
1270
|
filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
|
|
1271
1271
|
/**
|
|
1272
1272
|
* Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
|
|
1273
|
-
* <kbd>
|
|
1274
|
-
* one anywhere on grid). Use <kbd>
|
|
1273
|
+
* <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
1274
|
+
* one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
|
|
1275
1275
|
* grouper.
|
|
1276
1276
|
* ...
|
|
1277
1277
|
* [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Group)
|
|
@@ -1476,7 +1476,7 @@ const emit = defineEmits<{
|
|
|
1476
1476
|
*/
|
|
1477
1477
|
(e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1478
1478
|
/**
|
|
1479
|
-
* Fires on the owning Grid before deleting a range of selected cell values by pressing
|
|
1479
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
1480
1480
|
* buttons while [autoEdit](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
1481
1481
|
* @param {string} e Event name
|
|
1482
1482
|
* @param {object} params Event parameters
|
|
@@ -2482,7 +2482,7 @@ const emit = defineEmits<{
|
|
|
2482
2482
|
* @param {Response} params.event.response Optional response, if received
|
|
2483
2483
|
* @param {Error} params.event.error Optional error, if exception occurred
|
|
2484
2484
|
*/
|
|
2485
|
-
(e: 'pdfExport', params: ((event: { response?:
|
|
2485
|
+
(e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
|
|
2486
2486
|
/**
|
|
2487
2487
|
* Fired when the range of dates encapsulated by this view changes.
|
|
2488
2488
|
* ...
|
|
@@ -2778,6 +2778,16 @@ const emit = defineEmits<{
|
|
|
2778
2778
|
* @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
|
|
2779
2779
|
*/
|
|
2780
2780
|
(e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
|
|
2781
|
+
/**
|
|
2782
|
+
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
2783
|
+
* @param {string} e Event name
|
|
2784
|
+
* @param {object} params Event parameters
|
|
2785
|
+
* @param {object} params.event Event object
|
|
2786
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
2787
|
+
* @param {(string|Function)[]} params.event.groupers Array of field names or functions representing the current grouping levels
|
|
2788
|
+
* @param {(string|Function)[]} params.event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
2789
|
+
*/
|
|
2790
|
+
(e: 'treeGroup', params: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string): void
|
|
2781
2791
|
/**
|
|
2782
2792
|
* Fires when row locking is disabled.
|
|
2783
2793
|
* @param {string} e Event name
|
|
@@ -3075,6 +3085,7 @@ const widgetData = {
|
|
|
3075
3085
|
'onToggleGroup',
|
|
3076
3086
|
'onToggleNode',
|
|
3077
3087
|
'onToolClick',
|
|
3088
|
+
'onTreeGroup',
|
|
3078
3089
|
'onUnlockRows',
|
|
3079
3090
|
'onUnsplit',
|
|
3080
3091
|
'pastEventCls',
|
|
@@ -3247,6 +3258,7 @@ const widgetData = {
|
|
|
3247
3258
|
'toggleGroup',
|
|
3248
3259
|
'toggleNode',
|
|
3249
3260
|
'toolClick',
|
|
3261
|
+
'treeGroup',
|
|
3250
3262
|
'unlockRows',
|
|
3251
3263
|
'unsplit'
|
|
3252
3264
|
]
|
|
@@ -421,7 +421,7 @@ export declare type BryntumEventListProps = {
|
|
|
421
421
|
* @param {object} detail.renderData.dataset An object which produces the `dataset` of the resulting event bar
|
|
422
422
|
* @param {boolean} detail.renderData.solidBar This is valid for views which create event bars. This is set to `true` by default for all day and interday events so that these appear as a solid block of background color. An eventRenderer may mutate this flag to change in what manner the event bar is colored - as a solid bar of color, or using the foreground color (text and icons) such as the MonthView, the CalendarRow (all day events in a DayView), and OverflowPopups
|
|
423
423
|
* @param {string} detail.renderData.bodyColor When used in a [DayView](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView), this color is applied to the body of the event element. Note that this must be light enough that the text color (From the SASS variable `$dayview-event-color`) is visible
|
|
424
|
-
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour.
|
|
424
|
+
* @param {boolean} detail.renderData.showBullet If there is no `iconCls`, and the event is not recurring, then by default a "bullet" circular icon is shown if the view's [showBullet](https://bryntum.com/products/calendar/docs/api/Calendar/widget/mixin/CalendarMixin#config-showBullet) if set. Setting this property in an event renderer overrides this behaviour. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, renderData }) { return <MyEventComponent event={eventRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For calendars with many visible events or frequently re-rendered views, this may impact scrolling performance compared to returning plain strings or [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) objects. Consider using JSX primarily for events that require complex interactive React components.*
|
|
425
425
|
* @returns {DomConfig,DomConfig[],string,void} The content to be used as the event body.
|
|
426
426
|
*/
|
|
427
427
|
eventRenderer ? : ((detail: { view: CalendarView, eventRecord: EventModel, resourceRecord: ResourceModel, renderData: { style: object, cls: object, iconStyle: object, iconCls: object, eventColor: string, eventBackground: string, textColor: string, eventInnerStyle: object, dataset: object, solidBar: Boolean, bodyColor: string, showBullet: Boolean } }) => DomConfig|DomConfig[]|string|void)|string
|
|
@@ -840,7 +840,7 @@ export declare type BryntumEventListProps = {
|
|
|
840
840
|
rootElement ? : ShadowRoot|HTMLElement
|
|
841
841
|
/**
|
|
842
842
|
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
843
|
-
*
|
|
843
|
+
* overridden by specifying a [rowHeight](https://bryntum.com/products/calendar/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
|
|
844
844
|
* a column [renderer](https://bryntum.com/products/calendar/docs/api/Grid/column/Column#config-renderer).
|
|
845
845
|
* ...
|
|
846
846
|
* [View online docs...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/EventList#config-rowHeight)
|
|
@@ -1156,7 +1156,7 @@ export declare type BryntumEventListProps = {
|
|
|
1156
1156
|
cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
|
|
1157
1157
|
/**
|
|
1158
1158
|
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
1159
|
-
*
|
|
1159
|
+
* <kbd>Space</kbd> key when the cell is focused.
|
|
1160
1160
|
* ...
|
|
1161
1161
|
* [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellMenu)
|
|
1162
1162
|
*/
|
|
@@ -1256,8 +1256,8 @@ export declare type BryntumEventListProps = {
|
|
|
1256
1256
|
filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
|
|
1257
1257
|
/**
|
|
1258
1258
|
* Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
|
|
1259
|
-
* <kbd>
|
|
1260
|
-
* one anywhere on grid). Use <kbd>
|
|
1259
|
+
* <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
1260
|
+
* one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
|
|
1261
1261
|
* grouper.
|
|
1262
1262
|
* ...
|
|
1263
1263
|
* [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Group)
|
|
@@ -502,7 +502,7 @@ defineProps<{
|
|
|
502
502
|
required ? : Boolean
|
|
503
503
|
/**
|
|
504
504
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
505
|
-
* the
|
|
505
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
506
506
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
507
507
|
* behaviour will be activated.
|
|
508
508
|
*/
|
|
@@ -488,7 +488,7 @@ export declare type BryntumFileFieldProps = {
|
|
|
488
488
|
required ? : Boolean
|
|
489
489
|
/**
|
|
490
490
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
491
|
-
* the
|
|
491
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
492
492
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
493
493
|
* behaviour will be activated.
|
|
494
494
|
*/
|
|
@@ -532,7 +532,7 @@ defineProps<{
|
|
|
532
532
|
required ? : Boolean
|
|
533
533
|
/**
|
|
534
534
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
535
|
-
* the
|
|
535
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
536
536
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
537
537
|
* behaviour will be activated.
|
|
538
538
|
*/
|
|
@@ -518,7 +518,7 @@ export declare type BryntumFilterFieldProps = {
|
|
|
518
518
|
required ? : Boolean
|
|
519
519
|
/**
|
|
520
520
|
* If this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
521
|
-
* the
|
|
521
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
522
522
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-clearable)
|
|
523
523
|
* behaviour will be activated.
|
|
524
524
|
*/
|
|
@@ -590,7 +590,7 @@ defineProps<{
|
|
|
590
590
|
rootElement ? : ShadowRoot|HTMLElement
|
|
591
591
|
/**
|
|
592
592
|
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
593
|
-
*
|
|
593
|
+
* overridden by specifying a [rowHeight](https://bryntum.com/products/calendar/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
|
|
594
594
|
* a column [renderer](https://bryntum.com/products/calendar/docs/api/Grid/column/Column#config-renderer).
|
|
595
595
|
* ...
|
|
596
596
|
* [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/view/Grid#config-rowHeight)
|
|
@@ -818,7 +818,7 @@ defineProps<{
|
|
|
818
818
|
cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
|
|
819
819
|
/**
|
|
820
820
|
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
821
|
-
*
|
|
821
|
+
* <kbd>Space</kbd> key when the cell is focused.
|
|
822
822
|
* ...
|
|
823
823
|
* [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellMenu)
|
|
824
824
|
*/
|
|
@@ -918,8 +918,8 @@ defineProps<{
|
|
|
918
918
|
filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
|
|
919
919
|
/**
|
|
920
920
|
* Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
|
|
921
|
-
* <kbd>
|
|
922
|
-
* one anywhere on grid). Use <kbd>
|
|
921
|
+
* <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
922
|
+
* one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
|
|
923
923
|
* grouper.
|
|
924
924
|
* ...
|
|
925
925
|
* [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Group)
|
|
@@ -1108,7 +1108,7 @@ const emit = defineEmits<{
|
|
|
1108
1108
|
*/
|
|
1109
1109
|
(e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
1110
1110
|
/**
|
|
1111
|
-
* Fires on the owning Grid before deleting a range of selected cell values by pressing
|
|
1111
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
1112
1112
|
* buttons while [autoEdit](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
1113
1113
|
* @param {string} e Event name
|
|
1114
1114
|
* @param {object} params Event parameters
|
|
@@ -2044,7 +2044,7 @@ const emit = defineEmits<{
|
|
|
2044
2044
|
* @param {Response} params.event.response Optional response, if received
|
|
2045
2045
|
* @param {Error} params.event.error Optional error, if exception occurred
|
|
2046
2046
|
*/
|
|
2047
|
-
(e: 'pdfExport', params: ((event: { response?:
|
|
2047
|
+
(e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
|
|
2048
2048
|
/**
|
|
2049
2049
|
* Fired when a Widget's read only state is toggled
|
|
2050
2050
|
* @param {string} e Event name
|
|
@@ -2305,6 +2305,16 @@ const emit = defineEmits<{
|
|
|
2305
2305
|
* @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
|
|
2306
2306
|
*/
|
|
2307
2307
|
(e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
|
|
2308
|
+
/**
|
|
2309
|
+
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
2310
|
+
* @param {string} e Event name
|
|
2311
|
+
* @param {object} params Event parameters
|
|
2312
|
+
* @param {object} params.event Event object
|
|
2313
|
+
* @param {Grid.view.Grid} params.event.source The grid instance
|
|
2314
|
+
* @param {(string|Function)[]} params.event.groupers Array of field names or functions representing the current grouping levels
|
|
2315
|
+
* @param {(string|Function)[]} params.event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
2316
|
+
*/
|
|
2317
|
+
(e: 'treeGroup', params: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string): void
|
|
2308
2318
|
/**
|
|
2309
2319
|
* Fires when row locking is disabled.
|
|
2310
2320
|
* @param {string} e Event name
|
|
@@ -2598,6 +2608,7 @@ const widgetData = {
|
|
|
2598
2608
|
'onToggleGroup',
|
|
2599
2609
|
'onToggleNode',
|
|
2600
2610
|
'onToolClick',
|
|
2611
|
+
'onTreeGroup',
|
|
2601
2612
|
'onUnlockRows',
|
|
2602
2613
|
'onUnsplit',
|
|
2603
2614
|
'preserveScroll',
|
|
@@ -2747,6 +2758,7 @@ const widgetData = {
|
|
|
2747
2758
|
'toggleGroup',
|
|
2748
2759
|
'toggleNode',
|
|
2749
2760
|
'toolClick',
|
|
2761
|
+
'treeGroup',
|
|
2750
2762
|
'unlockRows',
|
|
2751
2763
|
'unsplit'
|
|
2752
2764
|
]
|