Vue LoadPanel Props
closeOnOutsideClick
Event (jQuery or EventObject)
The event that caused UI component closing. It is a dxEvent or a jQuery.Event when you use jQuery.
The function passed to this property enables you to specify a custom condition for UI component closing. For instance, you can prevent closing until a user clicks a certain element.
jQuery
$(function () { $("#loadPanelContainer").dxLoadPanel({ // ... closeOnOutsideClick: function(e) { return e.target === $("#someElement").get()[0]; } }); });
Angular
import { DxLoadPanelModule } from "devextreme-angular"; // ... export class AppComponent { // ... closeOnOutsideClick(e) { return e.target === document.getElementById("someElement"); } } @NgModule({ imports: [ // ... DxLoadPanelModule ], // ... })
<dx-load-panel ... [closeOnOutsideClick]="closeOnOutsideClick"> </dx-load-panel>
Vue
<template> <DxLoadPanel .... :close-on-outside-click="closeOnOutsideClick"> </DxLoadPanel> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxLoadPanel from 'devextreme-vue/load-panel'; export default { components: { DxLoadPanel }, methods: { closeOnOutsideClick (e) { return e.target === document.getElementById("someElement"); } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import LoadPanel from 'devextreme-react/load-panel'; const closeOnOutsideClick = (e) => { return e.target === document.getElementById("someElement"); }; export default function App() { return ( <LoadPanel ... closeOnOutsideClick={closeOnOutsideClick}> </LoadPanel> ); }
The closeOnOutsideClick function is called when a user clicks the UI component or outside it.
container
The default container is defined during the UI component's initialization. It is the viewport, or the body element if the viewport is not found, or the parent element if the previous two are absent.
The specified container is shaded when the LoadPanel is visible; the LoadPanel inherits styles from the container and is scrolled with it.
deferRendering
Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#loadPanelContainer").dxLoadPanel({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-load-panel ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-load-panel>
import { DxLoadPanelModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxLoadPanelModule ], // ... })
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
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;
height
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"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
maxHeight
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"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
maxWidth
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"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
message
Specifies the text displayed in the load panel. Ignored in the Material Design theme.
minHeight
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"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
minWidth
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"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
onContentReady
A function that is executed when the UI component's content is ready and each time the content is changed.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only when using Knockout. |
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if you use Knockout. |
onHidden
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onHiding
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel overlay hiding. |
|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onInitialized
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onOptionChanged
Name | Type | Description |
---|---|---|
model |
Model data. Available only if you use Knockout. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
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. |
|
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
value | any |
The modified property's new value. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#loadPanelContainer").dxLoadPanel({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<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
<template> <DxLoadPanel ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.common.css'; 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
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; 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
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onShown
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
position
This property accepts one of the following:
Position configuration object
An object that specifies the UI component's position.String
A shortcut listed in the accepted values. Positions the UI component relative to the window.Function
A function that returns one of the above. Use it to position the UI component based on a condition.
rtlEnabled
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.
DevExpress.config({ rtlEnabled: true });
shadingColor
Specifies the shading color. Applies only if shading is enabled.
This property supports the following colors:
- Hexadecimal colors
- RGB colors
- RGBA colors
- Predefined/cross-browser color names
- Predefined SVG colors
- Paint server address
showIndicator
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.
width
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"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
If you have technical questions, please create a support ticket in the DevExpress Support Center.