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 framework
dojo/has- A feature detection library
dojo/i18n- A set of internationalization tooling
dojo/routing- A routing service to build web applications with
dojo/shim- Modules that provide fills of ES6+ functionality
dojo/stores- A lightweight state container
dojo/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 loader
dojo/themes- Collection of Dojo themes.
dojo/widgets- A set of rich UI elements
dojo/cli- Command Line Tooling for Dojo Applications
dojo/cli-build-app- A CLI command for building Dojo applications
dojo/cli-build-widget- A CLI command for building widgets
dojo/cli-create-app- Command for creating application boilerplates
dojo/cli-create-theme- Command for scaffolding a widget theme
dojo/cli-create-widget- Command for creating a widget template and all associated boilerplate
dojo/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.
Version 2.x to 3.x Migration Guide
See the v3 migration guide for details on upgrading from version 2.x to version 3.x.
Version 3.x to 4.x Migration Guide
See the v4 migration guide for details on upgrading from version 3.x to version 4.x.
Version 4.x to 5.x Migration Guide
See the v5 migration guide for details on upgrading from version 4.x to version 5.x.
Guidelines and Style Guide
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.
TypeScript and Dojo Compatibility Matrix
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)|