Skip to content
sfmskywalker edited this page Nov 10, 2014 · 5 revisions

Feature Overview

  1. Ajax Widget <IDeliverable.Widgets.Ajax>
  2. Widgets Container <IDeliverable.Widgets>
  3. Widget Output Cache <IDeliverable.Widgets.OutputCache>

Ajax Widget <IDeliverable.Widgets.Ajax>

The Ajax Widget feature is an Orchard module that provides a content part called AjaxifyPart. To ajaxify your widgets and content items, follow these 4 simple steps:

How to use

  1. Enable the AJAX Widgets feature from the Modules section;
  2. Go to Content Definition -> Edit the content type you wish to add ajaxify support for and add the AjaxifyPart. Note: this works for any content type:, including widget types;
  3. To ajaxify a content item or widget, simply go to its editor and check the newly added "Ajaxify" checkbox;
  4. That's it! If you now visit your site, widgets and contents for which you checke the Ajaxify checkbox will load asynchronously.

Output Cache and Donut Caching

To use this module to implement donut caching on output-cached pages, perform the following steps:

  1. Go to Settings -> Cache (assuming you have the Outpout Cache feature enabled);
  2. Scroll down a little until you see the AJAX Widgets caption and its route (AjaxifyContent/{id}). To have your widgets and contents served by this route not being cached, specify an integer value in the Duration field. A value of 0 means that the ajaxified widgets and contents will never be cached. Any other value will cause the ajaxified content to be cached for that number of seconds.

Widgets Container <IDeliverable.Widgets>

The Widgets Container feature adds a new content part to the system called WidgetContainerPart. When you attach this part to your content type, you will be able to associate widgets with this content item. This way you won't have to create a widget layer per content item URL, which can greatly improve maintenance.

Widget Output Cache <IDeliverable.Widgets.OutputCache>

This feature enables output caching on a per-widget level. To use this feature, do the following:

  1. Enable the Widget Output Cache feature. This will add the OutputCachePart to the system.
  2. Go to Content Type Definition and edit the widget type you'd like to attach the OutputCachePart, for example Menu Widget, and attach that part.
  3. Go to Widgets and edit the widgets you wish to enable output caching for. You'll see a checkbox labeled "Enable Output Cache ".
  4. Done.