Welcome to the Durandal Docs!

This is a branching off point for digging into the various aspects of Durandal. Here you will find information pertaining to how the framework is put together as well as how it is used to build apps.

Articles

• Introduction
• Starter Kit Overview
• Getting Set Up
  • With Mimosa (Recommended for Node/Ruby/PHP)
  • With NuGet (Recommended for .NET)
  • With the Visual Studio MVC Project Template
  • Manual Setup
• Understanding the Samples
• Common Tasks
  • Creating a Module
  • Creating a View
  • Using Composition
  • Adding a Splash Screen
  • Showing Message Boxes and Modals
  • Debugging
  • Creating a Widget
  • Creating a Transition
  • Leveraging Publish/Subscribe
  • Interacting with the DOM
  • Hooking Lifecycle Callbacks
  • Setting Up Routing
  • Customizing the Configuration
• Build and Deploy
  • Optimizing on .NET
  • Optimizing with Mimosa
  • Using Durandal with Almond
• Integration
  • With Q
  • With Dojo
  • With KendoUI
• Producing Native Apps
  • Phone and Tablet Apps with PhoneGap
  • Desktop Apps with Node-Webkit
  • Windows 8
• Tools
  • dFiddle

Module Reference

Durandal is distributed as a set of AMD modules intended to work with RequireJS. Below is a list of the modules that make up the framework. For a brief overview, read Understanding Durandal's Modules.

• App
• Composition
• Events
• HTTP
• Modal Dialog
• Message Box
• System
• View Locator
• View Engine
• View Model Binder
• View Model
• Widget

Plugin Reference

In addition to the core framework, below you will find some plugins to extend the out-of-the-box functionality.

• Router

Community

In addition to the official documentation and plugins, below you will find some great community contributions.

• Transition Helper - Tons of transition animations for Durandal's composition mechanism.
• knockout-delegatedEvents - A KO plugin that makes delegated events easy, without resorting to manual jQuery code.
• Knockout Utility Signatures - A brief gist showing all the KO utility functions and their signatures.
• TypeScript Definition File - Enables type hinting and compile checking for TypeScript project using Durandal.
• Authentication Sample - A .NET community authentication sample.