Dojo is a progressive framework for modern web applications built with TypeScript.
Visit us at dojo.io for documentation, tutorials, cookbooks, and other materials. This repository contains detailed information on the structure of Dojo, while dojo.io is focused on getting started with and learning Dojo.
There are seven sub-packages that form the framework for building a Dojo application:
dojo/core- The foundational code of the Dojo frameworkdojo/has- A feature detection librarydojo/i18n- A set of internationalization toolingdojo/routing- A routing service to build web applications withdojo/shim- Modules that provide fills of ES6+ functionalitydojo/stores- A lightweight state containerdojo/testing- A set of modules to help with testing Dojo
We have additional packages within the Dojo ecosystem to aid in quickly and easily creating Dojo apps:
dojo/interop- Interoperability with other frameworks (currently Dojo 1 Dijits and Redux)dojo/loader- A TypeScript based AMD loaderdojo/themes- Collection of Dojo themes.dojo/widgets- A set of rich UI elements
dojo/cli- Command Line Tooling for Dojo Applicationsdojo/cli-build-app- A CLI command for building Dojo applicationsdojo/cli-build-widget- A CLI command for building widgetsdojo/cli-create-app- Command for creating application boilerplatesdojo/cli-create-theme- Command for scaffolding a widget themedojo/cli-create-widget- Command for creating a widget template and all associated boilerplatedojo/cli-test-intern- Command for testing projects with Intern
There are several packages which are designed to support the Dojo platform. Generally these packages are not directly used by end developers:
dojo/scripts- A package of scripts to aid with Dojo package development.dojo/webpack-contrib- Specialized webpack loaders and plugins used by the Dojo toolchain.
See the v3 migration guide for details on upgrading from version 2.x to version 3.x.
See the v4 migration guide for details on upgrading from version 3.x to version 4.x.
See the v5 migration guide for details on upgrading from version 4.x to version 5.x.
See the v6 migration guide for details on upgrading from version 5.x to version 6.x.
See the v7 migration guide for details on upgrading from version 6.x to version 7.x.
We have added a repository of examples which have been built on Dojo. Those examples are available in the dojo/examples repository and are live at dojo.github.io/examples.
There are several documents that are relevant for contributing to Dojo.
- Contributing Guidelines - Guidelines for contributing code (or documentation) to Dojo
- Code Of Conduct - Guidelines for participation in all Dojo OSS communities.
- Style Guide - The style guide for Dojo for packages that do not use prettier
- tslint.json - The configuration file tslint that is used to validate Dojo code against
While Dojo tries to provide a holistic set of tools to build web applications, there are several key technologies where we feel that Dojo would be better integrating and building upon versus building from the ground up.
In order to ensure that Dojo is a solid set of JavaScript tools and libraries, Dojo is built on TypeScript. This provides us with structural design time typing as well as an effective way to communicate the intent of the Dojo APIs. It also provides us the ability to adopt ES6+ syntax features but make distributables that will be backwards compatible to the target browsers for Dojo.
TypeScript and Dojo both iterate rapidly. In general Dojo strives for maximum compatibility, with a plan to periodically increase the minimum TypeScript version so we can begin relying on newer TypeScript features. Please review this list when using Dojo:
| Dojo version | TypeScript version (minimum) | TypeScript version (maximum) |
|---|---|---|
| 3.0 | 2.6.x | 2.6.x |
| 4.0 | 2.6.x | 3.1.x |
| 5.0 | 2.6.x | 3.2.x |
| 6.0 | 3.4.5 | 3.4.5 |
| 7.0 | 3.4.5 | 3.8.x |
© 2020 OpenJS Foundation & contributors. New BSD license.