JavaScript/jQuery LoadPanel Options

|

Function parameters:

event:

Event (jQuery or EventObject)

The event that caused UI component closing. It is a EventObject or a jQuery.Event when you use jQuery.

Return Value:

true if the UI component should be closed; otherwise false.

Default Value: false

container

Specifies the UI component's container.

Type:

|

Default Value: undefined

This property accepts one of the following values:

A CSS selector, or a jQuery selector if you use jQuery

jQuery

index.js

$(function(){
    $("#loadPanelContainer").dxLoadPanel({
        // ...
        container: '#containerElement'
    });
});

Angular

app.component.html

<dx-load-panel ... 
    container="#containerElement"
>
</dx-load-panel>

Vue

App.vue

<template>
    <DxLoadPanel ... 
        container="#containerElement"
    >
    </DxLoadPanel>
</template>
<script>
import { DxLoadPanel } from 'devextreme-vue/load-panel';

export default {
    components: {
        DxLoadPanel
    }
};
</script>

React

App.js

import LoadPanel from 'devextreme-react/load-panel';
// ...
function App() {
    return (
        <LoadPanel ... 
            container="#containerElement"
        >
        </LoadPanel>
    );
}

A jQuery wrapper

jQuery

index.js

$(function(){
    $("#loadPanelContainer").dxLoadPanel({
        // ...
        container: $('#containerElement')
    });
});

A DOM element

jQuery

index.js

$(function(){
    $("#loadPanelContainer").dxLoadPanel({
        // ...
        container: document.getElementById('#containerElement')
    });
});

Angular

app.component.html

app.component.ts

<dx-load-panel ... 
    [container]="containerElement"
>
</dx-load-panel>

// ...
export class AppComponent {
    containerElement: Element;
    constructor() {
        this.containerElement = document.getElementById('#containerElement') as Element;
    }
}

Vue

App.vue

<template>
    <DxLoadPanel ... 
        :container="containerElement"
    >
    </DxLoadPanel>
</template>
<script>
import { DxLoadPanel } from 'devextreme-vue/load-panel';

export default {
    components: {
        DxLoadPanel
    },
    data() {
        return {
            containerElement: null
        }
    },
    mounted() {
        this.containerElement = document.getElementById('containerElement');
    }
};
</script>

React

App.js

import React, { useEffect, useState } from 'react';
import LoadPanel from 'devextreme-react/load-panel';
// ...
function App() {
    const [containerElement, setContainerElement] = useState(null);
    useEffect(() => {
        setContainerElement(document.getElementById('containerElement'));
    }, []);
    return (
        <LoadPanel ... 
            container={containerElement}
        >
        </LoadPanel>
    );
}

The UI component defines the default container on its initialization. This default container can be one of the following (if the element is absent, the component selects the next one):

color swatch container
.dx-viewport
body

If you set this property to a specific element, the shading applies to this element. The LoadPanel calculates its size relative to the element.

copyRootClassesToWrapper

IMPORTANT

Use the wrapperAttr property instead.

Copies your custom CSS classes from the root element to the wrapper element.

Type:

Default Value: false

This property allows you to use CSS for wrapper element configuration. You can customize the shade, resize, and drag zones.

The following markup illustrates relations between wrapper and root elements when you set copyRootClassesToWrapper to true:

HTML

<body>

    <!-- The following element is the root element on which the component is initialized. -->
    <!-- Specify classes to be copied to the wrapper element here. -->
    <div id="loadPanel" class="custom-class" ... ></div>

    <!-- The following element is the wrapper element. -->
    <!-- Custom classes are automatically copied from the root element. -->
    <div class="dx-overlay-wrapper dx-loadpanel-wrapper custom-class" ... > 

        <!-- The following element contains component content. -->
        <div class="dx-overlay-content" ... >
            <!-- ... -->
        </div>
    </div>
</body>

deferRendering

Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.

Type:

Default Value: true

Angular

If you set the deferRendering property to true, wrap the content in the Angular named template.

Vue

If you set the deferRendering property to true, wrap the content in the Vue named template.

delay

The delay in milliseconds after which the load panel is displayed.

Type:

Number

Default Value: 0

elementAttr

Use the wrapperAttr property instead.

Specifies the global attributes to be attached to the UI component's container element.

Type: any

Default Value: {}

jQuery

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

Angular

HTML

TypeScript

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

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

Vue

App.vue

<template>
    <DxLoadPanel ...
        :element-attr="loadPanelAttributes">
    </DxLoadPanel>
</template>

<script>
import DxLoadPanel from 'devextreme-vue/load-panel';

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

React

App.js

import React from 'react';

import LoadPanel from 'devextreme-react/load-panel';

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

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

focusStateEnabled

Specifies whether or not the UI component can be focused.

Type:

Default Value: false

height

Specifies the UI component's height.

Type:

|

|

Return Value:

|

The UI component's height.

Default Value: 90, 60 (Material)

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

Number
The height in pixels.
String
A CSS-accepted measurement of height. For example, "55px", "20vh", "80%", "inherit".
Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.

The LoadPanel calculates its height relative to one of the elements in the following priority: container => position.of => window.

hideOnOutsideClick

Specifies whether to hide the UI component if a user clicks outside it.

Type:

|

Function parameters:

event:

Event (jQuery or EventObject)

The event that caused UI component hiding. It is a EventObject or a jQuery.Event when you use jQuery.

Return Value:

true if the UI component should be hidden; otherwise false.

Default Value: false

The function passed to this property enables you to specify a custom condition for UI component hiding. For instance, you can prevent hiding until a user clicks a certain element.

jQuery

JavaScript

$(function () {
    $("#loadPanelContainer").dxLoadPanel({
        // ...
        hideOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});

Angular

TypeScript

HTML

import { DxLoadPanelModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
    hideOnOutsideClick(e) {
        return e.target === document.getElementById("someElement");
    }
}
@NgModule({
     imports: [
         // ...
         DxLoadPanelModule
     ],
     // ...
 })

<dx-load-panel ...
    [hideOnOutsideClick]="hideOnOutsideClick">
</dx-load-panel>

Vue

App.vue

<template>
    <DxLoadPanel ....
        :hide-on-outside-click="hideOnOutsideClick">
    </DxLoadPanel>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxLoadPanel from 'devextreme-vue/load-panel';

export default {
    components: {
        DxLoadPanel
    },
    methods: {
        hideOnOutsideClick (e) {
            return e.target === document.getElementById("someElement");
        }
    }
}
</script>

React

App.js

import React from 'react';
import 'devextreme/dist/css/dx.light.css';

import LoadPanel from 'devextreme-react/load-panel';

const hideOnOutsideClick = (e) => {
    return e.target === document.getElementById("someElement");
};

export default function App() {
    return (
        <LoadPanel ...
            hideOnOutsideClick={hideOnOutsideClick}>
        </LoadPanel>
    );
}

The hideOnOutsideClick function is called when a user clicks the UI component or outside it.

Popup Demo

hideOnParentScroll

Specifies whether to hide the LoadPanel when users scroll one of its parent elements.

Type:

Default Value: false

hint

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

Type:

Default Value: undefined

hoverStateEnabled

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

Type:

Default Value: false

indicatorSrc

A URL pointing to an image to be used as a load indicator.

Type:

Default Value: ''

maxHeight

Specifies the maximum height the UI component can reach while resizing.

Type:

|

|

Return Value:

|

The maximum height.

Default Value: 60 (Material)

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

Number
The height in pixels.
String
A CSS-accepted measurement of height. For example, "55px", "20vh", "80%", "inherit".
Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.

maxWidth

Specifies the maximum width the UI component can reach while resizing.

Type:

|

|

Return Value:

|

The maximum width.

Default Value: 60 (Material)

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

Number
The width in pixels.
String
A CSS-accepted measurement of width. For example, "55px", "20vw", "80%", "auto", "inherit".
Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.

message

Specifies the text displayed in the load panel. Ignored in the Material Design theme.

Type:

Default Value: 'Loading ...', '' (Material)

minHeight

Specifies the minimum height the UI component can reach while resizing.

Type:

|

|

Return Value:

|

The minimum height.

Default Value: null

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

Number
The height in pixels.
String
A CSS-accepted measurement of height. For example, "55px", "20vh", "80%", "inherit".
Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.

minWidth

Specifies the minimum width the UI component can reach while resizing.

Type:

|

|

Return Value:

|

The minimum width.

Default Value: null

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

Number
The width in pixels.
String
A CSS-accepted measurement of width. For example, "55px", "20vw", "80%", "auto", "inherit".
Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.

onContentReady

A function that is executed when the UI component is rendered and each time the component is repainted.

Type:

Function parameters:

e:

ContentReadyEvent

Information about the event.

Object structure:

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

Name

Type

Description

model

any

The model data. Available only if you use Knockout.

element

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

component

The UI component's instance.

Default Value: null

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function parameters:

e:

DisposingEvent

Information about the event.

Object structure:

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

Name

Type

Description

model

any

The model data. Available only if you use Knockout.

element

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

component

The UI component's instance.

Default Value: null

onHidden

A function that is executed after the UI component is hidden.

Type:

Function parameters:

e:

HiddenEvent

Information about the event.

Object structure:

Name

Type

Description

model

any

Model data. Available only if Knockout is used.

element

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

component

The UI component's instance.

Default Value: null

onHiding

A function that is executed before the UI component is hidden.

Type:

Function parameters:

e:

HidingEvent

Information about the event.

Object structure:

Name	Type	Description
model	any	Model data. Available only if Knockout is used.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	LoadPanel	The UI component's instance.
cancel	Boolean	Set this field to true if you want the LoadPanel to remain visible.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

Type:

Function parameters:

e:

InitializedEvent

Information about the event.

Object structure:

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

Name

Type

Description

element

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

component

The UI component's instance.

Default Value: null

Angular

app.component.html

app.component.ts

<dx-load-panel ...
    (onInitialized)="saveInstance($event)">
</dx-load-panel>

import { Component } from "@angular/core";
import LoadPanel from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    loadPanelInstance: LoadPanel;
    saveInstance (e) {
        this.loadPanelInstance = e.component;
    }
}

Vue

App.vue (Options API)

App.vue (Composition API)

<template>
    <div>
        <DxLoadPanel ...
            @initialized="saveInstance">
        </DxLoadPanel>
    </div>
</template>

<script>
import DxLoadPanel from 'devextreme-vue/load-panel';

export default {
    components: {
        DxLoadPanel
    },
    data: function() {
        return {
            loadPanelInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.loadPanelInstance = e.component;
        }
    }
};
</script>

<template>
    <div>
        <DxLoadPanel ...
            @initialized="saveInstance">
        </DxLoadPanel>
    </div>
</template>

<script setup>
import DxLoadPanel from 'devextreme-vue/load-panel';

let loadPanelInstance = null;

const saveInstance = (e) => {
    loadPanelInstance = e.component;
}
</script>

React

App.js

import LoadPanel from 'devextreme-react/load-panel';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.loadPanelInstance = e.component;
    }

    render() {
        return (
            <div>
                <LoadPanel onInitialized={this.saveInstance} />
            </div>
        );
    }
}

jQuery

Get a UI component Instance in jQuery

Angular

Get a UI component Instance in Angular

Vue

Get a UI component Instance in Vue

React

Get a UI component Instance in React

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function parameters:

e:

OptionChangedEvent

Information about the event.

Object structure:

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

Default Value: null

The following example shows how to subscribe to component property changes:

jQuery

index.js

$(function() {
    $("#loadPanelContainer").dxLoadPanel({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

Angular

app.component.html

app.component.ts

app.module.ts

<dx-load-panel ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-load-panel>

import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxLoadPanelModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxLoadPanelModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }

Vue

App.vue

<template> 
    <DxLoadPanel ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxLoadPanel from 'devextreme-vue/load-panel'; 

export default { 
    components: { 
        DxLoadPanel
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script>

React

App.js

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import LoadPanel from 'devextreme-react/load-panel'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <LoadPanel ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
}

onShowing

A function that is executed before the UI component is displayed.

Type:

Function parameters:

e:

ShowingEvent

Information about the event.

Object structure:

Name	Type	Description
model	any	Model data. Available only if Knockout is used.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	LoadPanel	The UI component's instance.
cancel	Boolean	Set this field to true if you want to prevent the LoadPanel from being displayed.

Default Value: null

onShown

A function that is executed after the UI component is displayed.

Type:

Function parameters:

e:

ShownEvent

Information about the event.

Object structure:

Name

Type

Description

model

any

Model data. Available only if Knockout is used.

element

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

component

The UI component's instance.

Default Value: null

position

Positions the UI component.

Type:

PositionAlignment

|

PositionConfig

|

Default Value: { my: 'center', at: 'center', of: window }

Raised Events: onPositioned

If you do not specify the container property and set the position.of to a specific element, the shading applies to this element. The LoadPanel calculates its size relative to the element.

rtlEnabled

Switches the UI component to a right-to-left representation.

Type:

DataGrid Demo Navigation UI Demo Editors Demo

Default Value: false

When this property is set to true, the UI component 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
});

shading

Specifies whether to shade the background when the UI component is active.

Type:

Default Value: true

Shading applies to the first specified element in the following sequence: container => position.of => window

If this property is set to true, the LoadPanel is displayed in modal mode, and users cannot interact with other UI components.

shadingColor

Specifies the shading color. Applies only if shading is enabled.

Type:

Default Value: 'transparent', '' (Android, iOS)

This property supports the following colors:

Hexadecimal colors
RGB colors
RGBA colors
Predefined/cross-browser color names
Predefined SVG colors
Paint server address

showIndicator

A Boolean value specifying whether or not to show a load indicator.

Type:

Default Value: true

If this property is set to true, a message is displayed and a load indicator turns in a circle while the view's content is loaded. Set this property to false to display only the text message. This can help avoid problems with animation used for the load indicator when running on a slow device.

showPane

A Boolean value specifying whether or not to show the pane behind the load indicator.

Type:

Default Value: true

visible

A Boolean value specifying whether or not the UI component is visible.

Type: