React LoadPanel Props

See Also

Set this object to null or undefined to disable animations.

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.

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".

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

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.

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

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>

<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>

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

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".

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".

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".

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".

<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;
    }
}

<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>

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>
        );
    }
}

See Also

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

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

<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 { }  

<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> 

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}
        />        
    ); 
} 

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.

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
});

DataGrid Demo Navigation UI Demo Editors Demo

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.

This property supports the following colors:

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

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.

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".

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

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

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

import { Component } from '@angular/core';
// ...
@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

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 { }

<template>
    <DxLoadPanel ...
        :wrapper-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>

import React, { useMemo } from 'react';

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

function App() {
    const loadPanelAttributes = useMemo(() => {
        return {
            id: 'elementId',
            class: 'class-name'
        }
    }, []);

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

The code above specifies the id and class attributes for the wrapper element and produces markup similar to this:

<body>
    <!-- The following is the wrapper element. -->
    <!-- It is nested inside an element defined by the `container` property (`<body>` by default). -->
    <div id="elementId" class="dx-overlay-wrapper dx-loadpanel-wrapper class-name" ... > 

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

<div id="myLoadPanel" class="myClass"></div>

<dx-load-panel ... class="myClass">
</dx-load-panel>

<LoadPanel ... className="myClass" />

@(Html.DevExtreme().LoadPanel()...
    .OnInitialized("(e) => e.element.addClass('myClass')")
)

    @(Html.DevExtreme().LoadPanel()...
    .OnInitialized("(e) => e.element.addClass('myClass')")
)