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).
Here you can try out the Scheduler and some of its main features. For more demos please refer to the example browser.
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
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.
The project has the following folders:
|Distribution folder, contains js bundles, css themes, locales and fonts. More info below.|
|Documentation, open it in a browser (needs to be on a web server) to view guides & API docs.|
|Demos, open it in a browser (needs to be on a web server)|
|Source code, can be included in your ES6+ project using |
|SCSS files to build our themes or your own custom theme.|
|Our complete test suite, including Siesta Lite to allow you to run them in a browser.|
The bundles are located in
/build. Bundle files are:
|Importable npm package|
|UMD-format bundle without transpilation and WebComponents included|
|ES module bundle for usage with modern browsers or in build process|
|ES module bundle for usage with Lightning Web Components|
|Transpiled (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:
The themes are located in
/build. Theme files are:
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>
How to create a simple scheduler (when using umd bundle) with a few resources and events:
- 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.
- 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).
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.
Last modified on 2022-06-20 10:58:31