v7.3.0
SupportExamplesFree Trial

Upgrade guide for Scheduler v7.0.0

New themes, styling & FontAwesome changes

This release has extensive changes in the styling of all Bryntum products, and any custom themes and app styling will need to be updated. See Grid's upgrade guide for more information.

Individual animation related configs deprecated

In addition to the individual animation related configs that has been deprecated in Grid, the enableEventAnimations config in Scheduler has also been deprecated in favor of the new transition config:

  • Scheduler.enableEventAnimations -> changeEvent

Old code

new Scheduler({
    enableEventAnimations : true
})

New code

new Scheduler({
    transition : {
        changeEvent : true
    }
})

There are also a set of new transitions that can be configured this way, read more in the What's New guide.

The DependencyMenu feature is now enabled by default

The DependencyMenu feature is now enabled by default. If you want to disable it, set features.dependencyMenu to false in your Scheduler config.

Old code

new Scheduler({
    features : {
        dependencies : true
    }
});

New code

new Scheduler({
    features : {
        dependencies    : true,
        dependencyMenu  : false
    }
});

Dragged events now snap to resources by default

By default, events in a Scheduler configured with snap: true now also snap to resources during drag. To revert to the previous behavior set the snapToResource config of the EventDrag feature to false:

Old code

new Scheduler({
    snap : true
});

New code

new Scheduler({
    snap : true,
    features : {
        eventDrag : {
            snapToResource : false
        }
    }    
});

Default value for resourceImageExtension changed

Used to default to '.jpg', but has been changed to '.png' to by default allow avatars with transparent backgrounds. If you relay on resource name + extension to form the image URL, you might need to update your app.

Old code

new Scheduler({
    resourceImagePath : 'users/'
});

New code

new Scheduler({
    resourceImagePath      : 'users/',
    resourceImageExtension : '.jpg'
});

Event styles changed

As part of the visual overhaul for this major release, the event styles have been updated too. The default event style has been changed to the new 'tonal' style. Previously, the default style was 'plain' - which is now replaced by the new 'filled' style. To get a look more closely resembling the previous default style, set the eventStyle config to 'filled':

Old code

new Scheduler({
    // No eventStyle config set, defaults to 'plain'
});

New code

new Scheduler({
    // The 'filled' style is closest to the old default 'plain' style in look
    eventStyle : 'filled'
});

See the "What's New" guide for more information about the new event styles.

DatePicker's cellRenderer context

DatePicker's cellRenderer is now passed the cell element as the cell property of its render context. The inner element into which new content can be added is passed as innerCell. Previously the inner element was passed in the cell property. This will only affect your apps if you have implemented a cellRenderer in any DatePicker

Old code

cellRenderer({ cell, date }) {
    cell.innerHTML += `<b>${getValueForDate(date)}</b>`;
}

New code

cellRenderer({ innerCell, date }) {
    innerCell.innerHTML += `<b>${getValueForDate(date)}</b>`;
}

Contents