Bryntum Scheduler 5.0.6

Bryntum Scheduler

Welcome to the Bryntum Scheduler, a pure JavaScript scheduler component which integrates easily with popular frameworks. Click a logo below to open the integration guide for the framework:

This document contains very brief info on the Scheduler's structure and how to get started. For more information, please view the guides and API Docs (open Scheduler in API docs).

Live demo

Here you can try out the Scheduler and some of its main features. For more demos please refer to the example browser.

Framework agnostic

The Bryntum Scheduler does not require any framework but works perfectly with popular frameworks such as React, Angular, Vue, Ionic and Ext JS. It also ships with frameworks demos which can be found in the examples/frameworks folder.

Include on your page

Include the distributed bundles using a script tag or as an ES module. Source maps are included so debugging should be a breeze :) For info on other use cases please view the guides found under /docs.

Folder structure

The project has the following folders:

FolderContents
/buildDistribution folder, contains js bundles, css themes, locales and fonts. More info below.
/docsDocumentation, open it in a browser (needs to be on a web server) to view guides & API docs.
/examplesDemos, open it in a browser (needs to be on a web server)
/libSource code, can be included in your ES6+ project using import.
/resourcesSCSS files to build our themes or your own custom theme.
/testsOur complete test suite, including Siesta Lite to allow you to run them in a browser.

Using bundles

The bundles are located in /build. Bundle files are:

FileContents
package.jsonImportable npm package
scheduler.lite.umd.jsUMD-format bundle without transpilation and WebComponents included
scheduler.module.jsES module bundle for usage with modern browsers or in build process
scheduler.lwc.module.jsES module bundle for usage with Lightning Web Components
scheduler.umd.jsTranspiled (babel -> ES5) bundle in UMD-format

All bundles are also available in minified versions, denoted with a .min.js file extension. Typings for TypeScripts can be found in files with a .d.ts file extension.

Example inclusion of UMD bundle:

<script type="text/javascript" src="build/scheduler.umd.js"></script>

Using themes

The themes are located in /build. Theme files are:

FileContents
scheduler.classic-dark.cssClassic-Dark theme
scheduler.classic.cssClassic theme
scheduler.classic-light.cssClassic-Light theme
scheduler.material.cssMaterial theme
scheduler.stockholm.cssStockholm theme

Each theme also exists in a thin version that only contains product specific styling (Schedulers full themes include Scheduler + Grid + all core styling such as buttons etc). For example scheduler.stockholm.thin.css. These are intended for when you include multiple Bryntum products on the same page, to avoid loading shared styling multiple times.

All themes are also available in minified versions, denoted with a .min.css file extension.

Example inclusion of Classic-Light theme:

<link rel="stylesheet" href="build/scheduler.classic-light.css" data-bryntum-theme>

Basic usage

How to create a simple scheduler (when using umd bundle) with a few resources and events:

var scheduler = new bryntum.scheduler.Scheduler({
    appendTo: document.body,
    height: 400,

    columns: [
        { text: 'Name', field: 'name', width: 160 }
    ],

    resources: [
        { id: 1, name: 'Dan Stevenson' },
        { id: 2, name: 'Talisha Babin' }
    ],

    events: [
        // the date format used is configurable, defaults to the simplified ISO format (e.g. 2017-10-05T14:48:00.000Z)
        // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
        { resourceId: 1, startDate: '2017-01-01', endDate: '2017-01-10' },
        { resourceId: 2, startDate: '2017-01-02', endDate: '2017-01-09' }
    ],

    startDate  : new Date(2017, 0, 1),
    endDate    : new Date(2017, 0, 10)
});

Some good to know details

Code and technologies

  • The scheduler is written in ECMAScript 2020 using modules. The modules are built into a bundle (as mentioned above) using WebPack + Babel. These bundles work in all supported browsers (Chrome, Firefox, Safari and modern Edge).
  • The scheduler is internally styled using SASS. During the build it generates CSS themes from the SASS files. In most cases you include one of the themes in your app. For more details on styling, see the guides under guides/styling.

Scheduler class structure

  • The scheduler is based on Bryntum Grid, most features and options for the Grid applies to the Scheduler too. In a normal setup you use frozen grid columns to the left and let the scheduler occupy the rest of the available space.
  • For performance reasons scheduled event elements are reused when scrolling, meaning that you should never manipulate such DOM elements directly (do it from eventRenderers etc. instead).

External dependencies

Bryntum Scheduler has very few external dependencies, you can see our current dependencies in the licenses.md file

Copyright © 2009 - 2022, Bryntum

All rights reserved.

License

Last modified on 2022-06-20 10:58:31