jQuery DeferRendering API
The DeferRendering is a widget that waits for its content to be ready before rendering it. While the content is getting ready, the DeferRendering displays a loading indicator.
DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.
The following code shows how to create the DeferRendering widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.
jQuery
<div id="deferRendering">
<!-- Widget content -->
</div>
var readyToRender = $.Deferred();
// Here goes a function that resolves the "readyToRender" Deferred object at a specific moment
// ...
$(function () {
$("#deferRendering").dxDeferRendering({
renderWhen: readyToRender.promise();
});
});Angular
<dx-defer-rendering
[renderWhen]="modelReady"
>
<!-- Widget content -->
</dx-defer-rendering>
var modelIsReady = $.Deferred();
// Here goes a function that resolves the "readyToRender" Deferred object at a specific moment
// ...
export class AppComponent
modelReady = modelIsReady.promise();
}AngularJS
<div ng-controller="DemoController">
<div dx-defer-rendering="{
renderWhen: modelIsReady
}">
<!-- Widget content -->
</div>
</div>var modelIsReady = $.Deferred();
// Here goes a function that resolves the "readyToRender" Deferred object at a specific moment
// ...
angular.module('DemoApp', ['dx'])
.controller("DemoController", function ($scope) {
$scope.modelIsReady = modelIsReady.promise();
});Knockout
<div data-bind="dxDeferRendering: {
renderWhen: modelIsReady
}">
<!-- Widget content -->
</div>
var modelIsReady = $.Deferred();
// Here goes a function that resolves the "readyToRender" Deferred object at a specific moment
// ...
var viewModel = {
modelIsReady: modelIsReady.promise()
};
ko.applyBindings(viewModel);See Also
Configuration
| Name | Description |
|---|---|
| accessKey |
Specifies the shortcut key that sets focus on the widget. |
| activeStateEnabled |
Specifies whether or not the widget changes its state when interacting with a user. |
| animation |
Specifies the animation to be used to show the rendered content. |
| disabled |
Specifies whether the widget responds to user interaction. |
| elementAttr |
Specifies the attributes to be attached to the widget's root element. |
| focusStateEnabled |
Specifies whether the widget can be focused using keyboard navigation. |
| height |
Specifies the widget's height. |
| hint |
Specifies text for a hint that appears when a user pauses on the widget. |
| hoverStateEnabled |
Specifies whether the widget changes its state when a user pauses on it. |
| onContentReady |
A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes. |
| onDisposing |
A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. |
| onInitialized |
A handler for the initialized event. Executed only once, after the widget is initialized. |
| onOptionChanged |
A handler for the optionChanged event. Executed after an option of the widget is changed. |
| onRendered |
Specifies a callback function that is called when the widget's content has finished rendering but is not yet shown. |
| onShown |
Specifies a callback function that is called when widget content is shown and animation has completed. |
| renderWhen |
Specifies when the widget content is rendered. |
| rtlEnabled |
Switches the widget to a right-to-left representation. |
| showLoadIndicator |
Indicates if a load indicator should be shown until the widget's content is rendered. |
| staggerItemSelector |
Specifies a jQuery selector of items that should be rendered using a staggered animation. |
| tabIndex |
Specifies the number of the element when the Tab key is used for navigating. |
| visible |
Specifies whether the widget is visible. |
| width |
Specifies the widget's width. |
Methods
| Name | Description |
|---|---|
| beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
| defaultOptions(rule) |
Specifies the device-dependent default configuration options for this component. |
| dispose() |
Disposes of all the resources allocated to the DeferRendering instance. |
| element() |
Gets the root widget element. |
| endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
| focus() |
Sets focus on the widget. |
| getInstance(element) |
Gets the instance of a widget found using its DOM node. |
| instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
| off(eventName) |
Detaches all event handlers from a single event. |
| off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) |
Subscribes to an event. |
| on(events) |
Subscribes to events. |
| option() |
Gets all widget options. |
| option(optionName) |
Gets the value of a single option. |
| option(optionName, optionValue) |
Updates the value of a single option. |
| option(options) |
Updates the values of several options. |
| registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
| repaint() |
Repaints the widget. Call it if you made modifications that changed the widget's state to invalid. |
Events
| Name | Description |
|---|---|
| contentReady |
Raised when the widget's content is ready. |
| disposing |
Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. |
| initialized |
Raised only once, after the widget is initialized. |
| optionChanged |
Raised after a widget option is changed. |
| rendered |
Fires when the widget's content has finished rendering but is not yet shown. |
| shown |
Fires when widget content is shown and animation has completed. |