@bryntum/calendar-vue-3 7.2.0 → 7.2.2

package/src/components/BryntumScheduler.vue

@@ -427,7 +427,7 @@ defineProps<{
      */
     emptyText ? : string|EmptyTextDomConfig
     /**
-     * Allow using [Delete] and [Backspace] to remove events/assignments
+     * Allow using <kbd>Delete</kbd> and <kbd>Backspace</kbd> to remove events/assignments
      */
     enableDeleteKey ? : Boolean
     /**
@@ -528,8 +528,8 @@ defineProps<{
      * @param {'tonal','filled','bordered','traced','outlined','indented','line','dashed','minimal','rounded','calendar','interday','gantt',null} detail.renderData.eventStyle The `eventStyle` of the event. Use this to apply custom styles to the event DOM element
      * @param {string} detail.renderData.eventColor The `eventColor` of the event. Use this to set a custom color for the rendered event
      * @param {string} detail.renderData.ariaLabel A description of the event details used for screen readers
-     * @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents.
-     * @returns {string,DomConfig,DomConfig[]} A simple string, or a DomConfig (or array thereof)
+     * @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, resourceRecord, renderData }) {     return &lt;MyEventComponent event={eventRecord} resource={resourceRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For schedulers 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.*
+     * @returns {string,DomConfig,DomConfig[]} A simple string, a DomConfig (or array thereof), or a JSX element when using React
      */
     eventRenderer ? : (detail: { eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, scheduler: Scheduler, renderData: { event: EventModel, cls: DomClassList|string, wrapperCls: DomClassList|string, iconCls: DomClassList|string, left: number, width: number, height: number, style: string|Record<string, string>, wrapperStyle: string|Record<string, string>, eventStyle: 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null, eventColor: string, ariaLabel: string, children: DomConfig[] } }) => string|DomConfig|DomConfig[]
     /**
@@ -1617,7 +1617,7 @@ defineProps<{
     cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellMenu)
      */
@@ -1709,8 +1709,8 @@ defineProps<{
      */
     dependencyMenuFeature ? : object|Boolean|string|DependencyMenu|DependencyMenuConfig
     /**
-     * Allow using <kbd>Ctrl</kbd>/<kbd>CMD</kbd> + <kbd>C</kbd>/<kbd>X</kbd> and <kbd>Ctrl</kbd>/<kbd>CMD</kbd> +
-     * <kbd>V</kbd> to copy/cut and paste events.
+     * Allow using <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>X</kbd> and
+     * <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>V</kbd> to copy/cut and paste events.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Scheduler/feature/EventCopyPaste)
      */
@@ -1812,8 +1812,8 @@ defineProps<{
     filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Group)
@@ -2179,7 +2179,7 @@ const emit = defineEmits<{
      */
     (e: 'assignmentSelectionChange', params: ((event: { source: Scheduler, action: 'select'|'deselect'|'update'|'clear', selected: AssignmentModel[], deselected: AssignmentModel[], selection: AssignmentModel[] }) => void)|string): void
     /**
-     * Fires before an assignment is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or
+     * Fires before an assignment is removed. Can be triggered by user pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> or
      * by the event editor. Can for example be used to display a custom dialog to confirm deletion, in which
      * case records should be "manually" removed after confirmation:
      * ...
@@ -2249,7 +2249,7 @@ const emit = defineEmits<{
      */
     (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
     /**
-     * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
+     * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
      * buttons while [autoEdit](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
      * @param {string} e Event name
      * @param {object} params Event parameters
@@ -2481,7 +2481,7 @@ const emit = defineEmits<{
      */
     (e: 'beforeEventAdd', params: ((event: { source: Scheduler, eventRecord: EventModel, resourceRecords: ResourceModel[], assignmentRecords: AssignmentModel[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
     /**
-     * Fires before an event is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or by the
+     * Fires before an event is removed. Can be triggered by user pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> or by the
      * event editor. Return `false` to immediately veto the removal (or a `Promise` yielding `true` or `false`
      * for async vetoing).
      * ...
@@ -4117,12 +4117,13 @@ const emit = defineEmits<{
      * @param {Scheduler.model.EventModel[]} params.event.originalEventRecords The event records that were copied
      * @param {Scheduler.model.AssignmentModel[]} params.event.originalAssignmentRecords The assignment records that were copied
      * @param {Date} params.event.date The paste date
-     * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The target resource record
+     * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The target resource record. When multiple resources are pasted to, this will be the top resource
+     * @param {Scheduler.model.ResourceModel[]} params.event.resourceRecords All target resource records that the events would be pasted to
      * @param {boolean} params.event.isCut `true` if this is a cut action
      * @param {string} params.event.entityName 'event' to distinguish this event from other `pasteNotAllowed` events
      * @param {'overlappingEvents','resourceReadOnly'} params.event.reason A string id to use for displaying an error message to the user.
      */
-    (e: 'pasteNotAllowed', params: ((event: { source: Scheduler, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], originalEventRecords: EventModel[], originalAssignmentRecords: AssignmentModel[], date: Date, resourceRecord: ResourceModel, isCut: boolean, entityName: string, reason: 'overlappingEvents'|'resourceReadOnly' }) => void)|string): void
+    (e: 'pasteNotAllowed', params: ((event: { source: Scheduler, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], originalEventRecords: EventModel[], originalAssignmentRecords: AssignmentModel[], date: Date, resourceRecord: ResourceModel, resourceRecords: ResourceModel[], isCut: boolean, entityName: string, reason: 'overlappingEvents'|'resourceReadOnly' }) => void)|string): void
     /**
      * Fires on the owning Grid when export has finished
      * @param {string} e Event name
@@ -4131,7 +4132,7 @@ const emit = defineEmits<{
      * @param {Response} params.event.response Optional response, if received
      * @param {Error} params.event.error Optional error, if exception occurred
      */
-    (e: 'pdfExport', params: ((event: { response?: any, error?: Error }) => void)|string): void
+    (e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
     /**
      * Fired after the [viewPreset](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) has changed.
      * @param {string} e Event name
@@ -5096,6 +5097,16 @@ const emit = defineEmits<{
      * @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
      */
     (e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
+    /**
+     * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
+     * @param {string} e Event name
+     * @param {object} params Event parameters
+     * @param {object} params.event Event object
+     * @param {Grid.view.Grid} params.event.source The grid instance
+     * @param {(string|Function)[]} params.event.groupers Array of field names or functions representing the current grouping levels
+     * @param {(string|Function)[]} params.event.oldGroupers Array of field names or functions representing the previous grouping levels
+     */
+    (e: 'treeGroup', params: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string): void
     /**
      * Fires when row locking is disabled.
      * @param {string} e Event name
@@ -5593,6 +5604,7 @@ const widgetData = {
         'onToggleGroup',
         'onToggleNode',
         'onToolClick',
+        'onTreeGroup',
         'onUnlockRows',
         'onUnsplit',
         'onVisibleDateRangeChange',
@@ -5924,6 +5936,7 @@ const widgetData = {
         'toggleGroup',
         'toggleNode',
         'toolClick',
+        'treeGroup',
         'unlockRows',
         'unsplit',
         'visibleDateRangeChange'

package/src/components/BryntumSchedulerBase.vue

@@ -427,7 +427,7 @@ defineProps<{
      */
     emptyText ? : string|EmptyTextDomConfig
     /**
-     * Allow using [Delete] and [Backspace] to remove events/assignments
+     * Allow using <kbd>Delete</kbd> and <kbd>Backspace</kbd> to remove events/assignments
      */
     enableDeleteKey ? : Boolean
     /**
@@ -528,8 +528,8 @@ defineProps<{
      * @param {'tonal','filled','bordered','traced','outlined','indented','line','dashed','minimal','rounded','calendar','interday','gantt',null} detail.renderData.eventStyle The `eventStyle` of the event. Use this to apply custom styles to the event DOM element
      * @param {string} detail.renderData.eventColor The `eventColor` of the event. Use this to set a custom color for the rendered event
      * @param {string} detail.renderData.ariaLabel A description of the event details used for screen readers
-     * @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents.
-     * @returns {string,DomConfig,DomConfig[]} A simple string, or a DomConfig (or array thereof)
+     * @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, resourceRecord, renderData }) {     return &lt;MyEventComponent event={eventRecord} resource={resourceRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For schedulers 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.*
+     * @returns {string,DomConfig,DomConfig[]} A simple string, a DomConfig (or array thereof), or a JSX element when using React
      */
     eventRenderer ? : (detail: { eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, scheduler: Scheduler, renderData: { event: EventModel, cls: DomClassList|string, wrapperCls: DomClassList|string, iconCls: DomClassList|string, left: number, width: number, height: number, style: string|Record<string, string>, wrapperStyle: string|Record<string, string>, eventStyle: 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null, eventColor: string, ariaLabel: string, children: DomConfig[] } }) => string|DomConfig|DomConfig[]
     /**
@@ -1616,7 +1616,7 @@ defineProps<{
     cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellMenu)
      */
@@ -1708,8 +1708,8 @@ defineProps<{
      */
     dependencyMenuFeature ? : object|Boolean|string|DependencyMenu|DependencyMenuConfig
     /**
-     * Allow using <kbd>Ctrl</kbd>/<kbd>CMD</kbd> + <kbd>C</kbd>/<kbd>X</kbd> and <kbd>Ctrl</kbd>/<kbd>CMD</kbd> +
-     * <kbd>V</kbd> to copy/cut and paste events.
+     * Allow using <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>X</kbd> and
+     * <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>V</kbd> to copy/cut and paste events.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Scheduler/feature/EventCopyPaste)
      */
@@ -1811,8 +1811,8 @@ defineProps<{
     filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Group)
@@ -2178,7 +2178,7 @@ const emit = defineEmits<{
      */
     (e: 'assignmentSelectionChange', params: ((event: { source: Scheduler, action: 'select'|'deselect'|'update'|'clear', selected: AssignmentModel[], deselected: AssignmentModel[], selection: AssignmentModel[] }) => void)|string): void
     /**
-     * Fires before an assignment is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or
+     * Fires before an assignment is removed. Can be triggered by user pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> or
      * by the event editor. Can for example be used to display a custom dialog to confirm deletion, in which
      * case records should be "manually" removed after confirmation:
      * ...
@@ -2248,7 +2248,7 @@ const emit = defineEmits<{
      */
     (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
     /**
-     * Fires on the owning Grid before deleting a range of selected cell values by pressing `Backspace` or `Del`
+     * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
      * buttons while [autoEdit](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
      * @param {string} e Event name
      * @param {object} params Event parameters
@@ -2480,7 +2480,7 @@ const emit = defineEmits<{
      */
     (e: 'beforeEventAdd', params: ((event: { source: Scheduler, eventRecord: EventModel, resourceRecords: ResourceModel[], assignmentRecords: AssignmentModel[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
     /**
-     * Fires before an event is removed. Can be triggered by user pressing [DELETE] or [BACKSPACE] or by the
+     * Fires before an event is removed. Can be triggered by user pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> or by the
      * event editor. Return `false` to immediately veto the removal (or a `Promise` yielding `true` or `false`
      * for async vetoing).
      * ...
@@ -4116,12 +4116,13 @@ const emit = defineEmits<{
      * @param {Scheduler.model.EventModel[]} params.event.originalEventRecords The event records that were copied
      * @param {Scheduler.model.AssignmentModel[]} params.event.originalAssignmentRecords The assignment records that were copied
      * @param {Date} params.event.date The paste date
-     * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The target resource record
+     * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The target resource record. When multiple resources are pasted to, this will be the top resource
+     * @param {Scheduler.model.ResourceModel[]} params.event.resourceRecords All target resource records that the events would be pasted to
      * @param {boolean} params.event.isCut `true` if this is a cut action
      * @param {string} params.event.entityName 'event' to distinguish this event from other `pasteNotAllowed` events
      * @param {'overlappingEvents','resourceReadOnly'} params.event.reason A string id to use for displaying an error message to the user.
      */
-    (e: 'pasteNotAllowed', params: ((event: { source: Scheduler, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], originalEventRecords: EventModel[], originalAssignmentRecords: AssignmentModel[], date: Date, resourceRecord: ResourceModel, isCut: boolean, entityName: string, reason: 'overlappingEvents'|'resourceReadOnly' }) => void)|string): void
+    (e: 'pasteNotAllowed', params: ((event: { source: Scheduler, eventRecords: EventModel[], assignmentRecords: AssignmentModel[], originalEventRecords: EventModel[], originalAssignmentRecords: AssignmentModel[], date: Date, resourceRecord: ResourceModel, resourceRecords: ResourceModel[], isCut: boolean, entityName: string, reason: 'overlappingEvents'|'resourceReadOnly' }) => void)|string): void
     /**
      * Fires on the owning Grid when export has finished
      * @param {string} e Event name
@@ -4130,7 +4131,7 @@ const emit = defineEmits<{
      * @param {Response} params.event.response Optional response, if received
      * @param {Error} params.event.error Optional error, if exception occurred
      */
-    (e: 'pdfExport', params: ((event: { response?: any, error?: Error }) => void)|string): void
+    (e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
     /**
      * Fired after the [viewPreset](https://bryntum.com/products/calendar/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) has changed.
      * @param {string} e Event name
@@ -5095,6 +5096,16 @@ const emit = defineEmits<{
      * @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
      */
     (e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
+    /**
+     * Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
+     * @param {string} e Event name
+     * @param {object} params Event parameters
+     * @param {object} params.event Event object
+     * @param {Grid.view.Grid} params.event.source The grid instance
+     * @param {(string|Function)[]} params.event.groupers Array of field names or functions representing the current grouping levels
+     * @param {(string|Function)[]} params.event.oldGroupers Array of field names or functions representing the previous grouping levels
+     */
+    (e: 'treeGroup', params: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string): void
     /**
      * Fires when row locking is disabled.
      * @param {string} e Event name
@@ -5591,6 +5602,7 @@ const widgetData = {
         'onToggleGroup',
         'onToggleNode',
         'onToolClick',
+        'onTreeGroup',
         'onUnlockRows',
         'onUnsplit',
         'onVisibleDateRangeChange',
@@ -5922,6 +5934,7 @@ const widgetData = {
         'toggleGroup',
         'toggleNode',
         'toolClick',
+        'treeGroup',
         'unlockRows',
         'unsplit',
         'visibleDateRangeChange'

package/src/components/BryntumSchedulerBaseProps.ts

@@ -413,7 +413,7 @@ export declare type BryntumSchedulerBaseProps = {
      */
     emptyText ? : string|EmptyTextDomConfig
     /**
-     * Allow using [Delete] and [Backspace] to remove events/assignments
+     * Allow using <kbd>Delete</kbd> and <kbd>Backspace</kbd> to remove events/assignments
      */
     enableDeleteKey ? : Boolean
     /**
@@ -514,8 +514,8 @@ export declare type BryntumSchedulerBaseProps = {
      * @param {'tonal','filled','bordered','traced','outlined','indented','line','dashed','minimal','rounded','calendar','interday','gantt',null} detail.renderData.eventStyle The `eventStyle` of the event. Use this to apply custom styles to the event DOM element
      * @param {string} detail.renderData.eventColor The `eventColor` of the event. Use this to set a custom color for the rendered event
      * @param {string} detail.renderData.ariaLabel A description of the event details used for screen readers
-     * @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents.
-     * @returns {string,DomConfig,DomConfig[]} A simple string, or a DomConfig (or array thereof)
+     * @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, resourceRecord, renderData }) {     return &lt;MyEventComponent event={eventRecord} resource={resourceRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For schedulers 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.*
+     * @returns {string,DomConfig,DomConfig[]} A simple string, a DomConfig (or array thereof), or a JSX element when using React
      */
     eventRenderer ? : (detail: { eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, scheduler: Scheduler, renderData: { event: EventModel, cls: DomClassList|string, wrapperCls: DomClassList|string, iconCls: DomClassList|string, left: number, width: number, height: number, style: string|Record<string, string>, wrapperStyle: string|Record<string, string>, eventStyle: 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null, eventColor: string, ariaLabel: string, children: DomConfig[] } }) => string|DomConfig|DomConfig[]
     /**
@@ -1602,7 +1602,7 @@ export declare type BryntumSchedulerBaseProps = {
     cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellMenu)
      */
@@ -1694,8 +1694,8 @@ export declare type BryntumSchedulerBaseProps = {
      */
     dependencyMenuFeature ? : object|Boolean|string|DependencyMenu|DependencyMenuConfig
     /**
-     * Allow using <kbd>Ctrl</kbd>/<kbd>CMD</kbd> + <kbd>C</kbd>/<kbd>X</kbd> and <kbd>Ctrl</kbd>/<kbd>CMD</kbd> +
-     * <kbd>V</kbd> to copy/cut and paste events.
+     * Allow using <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>X</kbd> and
+     * <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>V</kbd> to copy/cut and paste events.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Scheduler/feature/EventCopyPaste)
      */
@@ -1797,8 +1797,8 @@ export declare type BryntumSchedulerBaseProps = {
     filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Group)

package/src/components/BryntumSchedulerProps.ts

@@ -413,7 +413,7 @@ export declare type BryntumSchedulerProps = {
      */
     emptyText ? : string|EmptyTextDomConfig
     /**
-     * Allow using [Delete] and [Backspace] to remove events/assignments
+     * Allow using <kbd>Delete</kbd> and <kbd>Backspace</kbd> to remove events/assignments
      */
     enableDeleteKey ? : Boolean
     /**
@@ -514,8 +514,8 @@ export declare type BryntumSchedulerProps = {
      * @param {'tonal','filled','bordered','traced','outlined','indented','line','dashed','minimal','rounded','calendar','interday','gantt',null} detail.renderData.eventStyle The `eventStyle` of the event. Use this to apply custom styles to the event DOM element
      * @param {string} detail.renderData.eventColor The `eventColor` of the event. Use this to set a custom color for the rendered event
      * @param {string} detail.renderData.ariaLabel A description of the event details used for screen readers
-     * @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents.
-     * @returns {string,DomConfig,DomConfig[]} A simple string, or a DomConfig (or array thereof)
+     * @param {DomConfig[]} detail.renderData.children An array of DOM configs used as children to the `b-sch-event` element. Can be populated with additional DOM configs to have more control over contents. <h3>Using JSX (React)</h3> When using the Bryntum React wrapper, the event renderer can return JSX elements: ```javascript eventRenderer({ eventRecord, resourceRecord, renderData }) {     return &lt;MyEventComponent event={eventRecord} resource={resourceRecord} />; } ``` *Using JSX in the event renderer creates a React portal for each rendered event. For schedulers 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.*
+     * @returns {string,DomConfig,DomConfig[]} A simple string, a DomConfig (or array thereof), or a JSX element when using React
      */
     eventRenderer ? : (detail: { eventRecord: EventModel, resourceRecord: ResourceModel, assignmentRecord: AssignmentModel, scheduler: Scheduler, renderData: { event: EventModel, cls: DomClassList|string, wrapperCls: DomClassList|string, iconCls: DomClassList|string, left: number, width: number, height: number, style: string|Record<string, string>, wrapperStyle: string|Record<string, string>, eventStyle: 'tonal'|'filled'|'bordered'|'traced'|'outlined'|'indented'|'line'|'dashed'|'minimal'|'rounded'|'calendar'|'interday'|'gantt'|null, eventColor: string, ariaLabel: string, children: DomConfig[] } }) => string|DomConfig|DomConfig[]
     /**
@@ -1603,7 +1603,7 @@ export declare type BryntumSchedulerProps = {
     cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
     /**
      * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
-     * `SPACE` key when the cell is focused.
+     * <kbd>Space</kbd> key when the cell is focused.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/CellMenu)
      */
@@ -1695,8 +1695,8 @@ export declare type BryntumSchedulerProps = {
      */
     dependencyMenuFeature ? : object|Boolean|string|DependencyMenu|DependencyMenuConfig
     /**
-     * Allow using <kbd>Ctrl</kbd>/<kbd>CMD</kbd> + <kbd>C</kbd>/<kbd>X</kbd> and <kbd>Ctrl</kbd>/<kbd>CMD</kbd> +
-     * <kbd>V</kbd> to copy/cut and paste events.
+     * Allow using <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>X</kbd> and
+     * <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>V</kbd> to copy/cut and paste events.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Scheduler/feature/EventCopyPaste)
      */
@@ -1798,8 +1798,8 @@ export declare type BryntumSchedulerProps = {
     filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
     /**
      * Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
-     * <kbd>shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
-     * one anywhere on grid). Use <kbd>shift</kbd> + <kbd>alt</kbd> + click, or the context menu, to remove a column
+     * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
+     * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
      * grouper.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Grid/feature/Group)

package/src/components/BryntumSlideToggle.vue

@@ -488,7 +488,7 @@ defineProps<{
     required ? : Boolean
     /**
      * 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
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * 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)
      * behaviour will be activated.
      */

package/src/components/BryntumSlideToggleProps.ts

@@ -474,7 +474,7 @@ export declare type BryntumSlideToggleProps = {
     required ? : Boolean
     /**
      * 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
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * 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)
      * behaviour will be activated.
      */

package/src/components/BryntumSlider.vue

@@ -499,7 +499,7 @@ defineProps<{
     unit ? : string
     /**
      * Initial value.
-     * `String` value allows to link value by reference name.
+     * `String` value allows linking value by reference name.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/Slider#config-value)
      */

package/src/components/BryntumSliderProps.ts

@@ -485,7 +485,7 @@ export declare type BryntumSliderProps = {
     unit ? : string
     /**
      * Initial value.
-     * `String` value allows to link value by reference name.
+     * `String` value allows linking value by reference name.
      * ...
      * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/Slider#config-value)
      */

package/src/components/BryntumTextAreaField.vue

@@ -501,7 +501,7 @@ defineProps<{
     resize ? : 'none'|'both'|'horizontal'|'vertical'
     /**
      * 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
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * 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)
      * behaviour will be activated.
      */

package/src/components/BryntumTextAreaFieldProps.ts

@@ -487,7 +487,7 @@ export declare type BryntumTextAreaFieldProps = {
     resize ? : 'none'|'both'|'horizontal'|'vertical'
     /**
      * 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
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * 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)
      * behaviour will be activated.
      */

package/src/components/BryntumTextAreaPickerField.vue

@@ -516,7 +516,7 @@ defineProps<{
     resize ? : 'none'|'both'|'horizontal'|'vertical'
     /**
      * 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
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * 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)
      * behaviour will be activated.
      */

package/src/components/BryntumTextAreaPickerFieldProps.ts

@@ -502,7 +502,7 @@ export declare type BryntumTextAreaPickerFieldProps = {
     resize ? : 'none'|'both'|'horizontal'|'vertical'
     /**
      * 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
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * 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)
      * behaviour will be activated.
      */

package/src/components/BryntumTextField.vue

@@ -505,7 +505,7 @@ defineProps<{
     required ? : Boolean
     /**
      * 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
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * 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)
      * behaviour will be activated.
      */

package/src/components/BryntumTextFieldProps.ts

@@ -491,7 +491,7 @@ export declare type BryntumTextFieldProps = {
     required ? : Boolean
     /**
      * 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
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * 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)
      * behaviour will be activated.
      */

package/src/components/BryntumTimeField.vue

@@ -542,7 +542,7 @@ defineProps<{
     required ? : Boolean
     /**
      * 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
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * 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)
      * behaviour will be activated.
      */

package/src/components/BryntumTimeFieldProps.ts

@@ -528,7 +528,7 @@ export declare type BryntumTimeFieldProps = {
     required ? : Boolean
     /**
      * 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
-     * the `ESCAPE` key after editing the field will revert the field to the value it had when
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
      * 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)
      * behaviour will be activated.
      */

package/src/components/BryntumTimeVisualizingEditor.vue

@@ -133,7 +133,7 @@ defineProps<{
      */
     closeAction ? : 'hide'|'destroy'
     /**
-     * Close popup when `ESC` key is pressed.
+     * Close popup when <kbd>Escape</kbd> key is pressed.
      */
     closeOnEscape ? : Boolean
     /**

package/src/components/BryntumTimeVisualizingEditorProps.ts

@@ -119,7 +119,7 @@ export declare type BryntumTimeVisualizingEditorProps = {
      */
     closeAction ? : 'hide'|'destroy'
     /**
-     * Close popup when `ESC` key is pressed.
+     * Close popup when <kbd>Escape</kbd> key is pressed.
      */
     closeOnEscape ? : Boolean
     /**