JavaScript/jQuery DeferRendering Options

Default Value: false

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Default Value: {}

jQuery

$(function(){
    $("#deferRenderingContainer").dxDeferRendering({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

HTML

TypeScript

<dx-defer-rendering ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-defer-rendering>

import { DxDeferRenderingModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxDeferRenderingModule
    ],
    // ...
})

Vue

App.vue

<template>
    <DxDeferRendering ...
        :element-attr="deferRenderingAttributes">
    </DxDeferRendering>
</template>

<script>
import DxDeferRendering from 'devextreme-vue/defer-rendering';

export default {
    components: {
        DxDeferRendering
    },
    data() {
        return {
            deferRenderingAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>

React

App.js

import React from 'react';

import DeferRendering from 'devextreme-react/defer-rendering';

class App extends React.Component {
    deferRenderingAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <DeferRendering ...
                elementAttr={this.deferRenderingAttributes}>
            </DeferRendering>
        );
    }
}
export default App;

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Default Value: false

height

Specifies the widget's height.

Type:

Return Value:

The widget's height.

Default Value: undefined

This option accepts a value of one of the following types:

Number
The height in pixels.
String
A CSS-accepted measurement of height. For example, "55px", "80%", "inherit".
Function
A function returning either of the above. For example:
JavaScript
```
height: function() {
    return window.innerHeight / 1.5;
}
```

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Default Value: false

onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.

Type:

Function parameters:

Information about the event.

Object structure:

Name	Type	Description
component	DeferRendering	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	Model data. Available only when using Knockout.

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Model data. Available only when using Knockout.

Default Value: null

onDisposing

A function that is executed before the widget is disposed of.

Type:

Function parameters:

Information about the event.

Object structure:

Name	Type	Description
component	DeferRendering	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	Model data. Available only if you use Knockout.

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Model data. Available only if you use Knockout.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the widget instance.

Type:

Function parameters:

Information about the event.

Object structure:

Name	Type	Description
component	DeferRendering	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function parameters:

Information about the event.

Object structure:

Name	Type	Description
model	Object	Model data. Available only if you use Knockout.
fullName	String	The path to the modified option that includes all parent options.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	DeferRendering	The widget's instance.
name	String	The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.
value	any	The modified option's new value.

Default Value: null

onRendered

A function that is executed when the content is rendered but not yet displayed.

Type:

Function parameters:

Information about the event.

Object structure:

Name	Type	Description
component	DeferRendering	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	Model data. Available only if Knockout is used.

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Model data. Available only if Knockout is used.

Default Value: null

onShown

A function that is executed when the content is displayed and animation is completed.

Type:

Function parameters:

Information about the event.

Object structure:

Name	Type	Description
component	DeferRendering	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	Model data. Available only if Knockout is used.

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Model data. Available only if Knockout is used.

Default Value: null

renderWhen

Specifies when the widget content is rendered.

Type:

Promise<void> (jQuery or native)

Default Value: undefined

The widget content is rendered when this option is set to true, or when a Promise assigned to this option is resolved.

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Default Value: false

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript

DevExpress.config({
    rtlEnabled: true
});

showLoadIndicator

Indicates if a load indicator should be shown until the widget's content is rendered.

Type:

Default Value: false

staggerItemSelector

Specifies a jQuery selector of items that should be rendered using a staggered animation.

Type:

String

Default Value: undefined

Elements with the selector specified by this option will be searched within the widget's content. The found elements will be shown with animation specified by the animation option. If the specified animation is staggered, the elements will be animated one after another with the delay specified within the animation's configuration.

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

visible

Specifies whether the widget is visible.

Type: