React Load Panel

The LoadPanel is an overlay component used to notify users that a process is in progress. In this demo, you can see how to initialize and configure the component.

DevExtreme Accessibility Compliance

DevExtreme component libraries meet a variety of WCAG and Section 508 compliance standards. To assess this demo's accessibility level, click the Run AXE^® Validation button to launch the AXE^® web accessibility evaluation tool.

All trademarks or registered trademarks are property of their respective owners. AXE^® Terms of Use

The overall accessibility level of your application depends on the LoadPanel features used.

TS JS

Backend API

import React, { useCallback, useState } from 'react'; import { Button } from 'devextreme-react/button'; import { CheckBox, ICheckBoxOptions } from 'devextreme-react/check-box'; import { LoadPanel } from 'devextreme-react/load-panel'; import { employee } from './data.ts'; const position = { of: '#employee' }; const defaultEmployeeInfo: Partial<typeof employee> = {}; export default function App() { const [employeeInfo, setEmployeeInfo] = useState(defaultEmployeeInfo); const [loadPanelVisible, setLoadPanelVisible] = useState(false); const [showIndicator, setShowIndicator] = useState(true); const [shading, setShading] = useState(true); const [showPane, setShowPane] = useState(true); const [hideOnOutsideClick, setHideOnOutsideClick] = useState(false); const hideLoadPanel = useCallback(() => { setLoadPanelVisible(false); setEmployeeInfo(employee); }, [setLoadPanelVisible, setEmployeeInfo]); const onClick = useCallback(() => { setEmployeeInfo({}); setLoadPanelVisible(true); setTimeout(hideLoadPanel, 3000); }, [setEmployeeInfo, setLoadPanelVisible]); const onShowIndicatorChange = useCallback((e: { value: any; }) => { setShowIndicator(e.value); }, [setShowIndicator]) as ICheckBoxOptions['onValueChanged']; const onShadingChange = useCallback((e: { value: any; }) => { setShading(e.value); }, [setShading]) as ICheckBoxOptions['onValueChanged']; const onShowPaneChange = useCallback((e: { value: any; }) => { setShowPane(e.value); }, [setShowPane]) as ICheckBoxOptions['onValueChanged']; const onHideOnOutsideClickChange = useCallback((e: { value: any; }) => { setHideOnOutsideClick(e.value); }, [setHideOnOutsideClick]) as ICheckBoxOptions['onValueChanged']; return ( <React.Fragment> <div className="header">John Heart</div>   <Button text="Load Data" onClick={onClick}></Button> <div id="employee"> <p> Birth date: <b>{employeeInfo.Birth_Date}</b> </p> <p className="address"> Address:<br /> <b>{employeeInfo.City}</b><br /> <span>{employeeInfo.Zipcode}</span> <span>{employeeInfo.Address}</span> </p> <p> Phone: <b>{employeeInfo.Mobile_Phone}</b><br /> Email: <b>{employeeInfo.Email}</b> </p> </div> <LoadPanel shadingColor="rgba(0,0,0,0.4)" position={position} onHiding={hideLoadPanel} visible={loadPanelVisible} showIndicator={showIndicator} shading={shading} showPane={showPane} hideOnOutsideClick={hideOnOutsideClick} /> <div className="options"> <div className="caption">Options</div> <div className="option"> <CheckBox text="With indicator" value={showIndicator} onValueChanged={onShowIndicatorChange} /> </div> <div className="option"> <CheckBox text="With overlay" value={shading} onValueChanged={onShadingChange} /> </div> <div className="option"> <CheckBox text="With pane" value={showPane} onValueChanged={onShowPaneChange} /> </div> <div className="option"> <CheckBox text="Hide on outside click" value={hideOnOutsideClick} onValueChanged={onHideOnOutsideClickChange} /> </div> </div> </React.Fragment> ); }

import React, { useCallback, useState } from 'react'; import { Button } from 'devextreme-react/button'; import { CheckBox } from 'devextreme-react/check-box'; import { LoadPanel } from 'devextreme-react/load-panel'; import { employee } from './data.js'; const position = { of: '#employee' }; const defaultEmployeeInfo = {}; export default function App() { const [employeeInfo, setEmployeeInfo] = useState(defaultEmployeeInfo); const [loadPanelVisible, setLoadPanelVisible] = useState(false); const [showIndicator, setShowIndicator] = useState(true); const [shading, setShading] = useState(true); const [showPane, setShowPane] = useState(true); const [hideOnOutsideClick, setHideOnOutsideClick] = useState(false); const hideLoadPanel = useCallback(() => { setLoadPanelVisible(false); setEmployeeInfo(employee); }, [setLoadPanelVisible, setEmployeeInfo]); const onClick = useCallback(() => { setEmployeeInfo({}); setLoadPanelVisible(true); setTimeout(hideLoadPanel, 3000); }, [setEmployeeInfo, setLoadPanelVisible]); const onShowIndicatorChange = useCallback( (e) => { setShowIndicator(e.value); }, [setShowIndicator], ); const onShadingChange = useCallback( (e) => { setShading(e.value); }, [setShading], ); const onShowPaneChange = useCallback( (e) => { setShowPane(e.value); }, [setShowPane], ); const onHideOnOutsideClickChange = useCallback( (e) => { setHideOnOutsideClick(e.value); }, [setHideOnOutsideClick], ); return ( <React.Fragment> <div className="header">John Heart</div>   <Button text="Load Data" onClick={onClick} ></Button> <div id="employee"> <p> Birth date: <b>{employeeInfo.Birth_Date}</b> </p> <p className="address"> Address: <br /> <b>{employeeInfo.City}</b> <br /> <span>{employeeInfo.Zipcode}</span> <span>{employeeInfo.Address}</span> </p> <p> Phone: <b>{employeeInfo.Mobile_Phone}</b> <br /> Email: <b>{employeeInfo.Email}</b> </p> </div> <LoadPanel shadingColor="rgba(0,0,0,0.4)" position={position} onHiding={hideLoadPanel} visible={loadPanelVisible} showIndicator={showIndicator} shading={shading} showPane={showPane} hideOnOutsideClick={hideOnOutsideClick} /> <div className="options"> <div className="caption">Options</div> <div className="option"> <CheckBox text="With indicator" value={showIndicator} onValueChanged={onShowIndicatorChange} /> </div> <div className="option"> <CheckBox text="With overlay" value={shading} onValueChanged={onShadingChange} /> </div> <div className="option"> <CheckBox text="With pane" value={showPane} onValueChanged={onShowPaneChange} /> </div> <div className="option"> <CheckBox text="Hide on outside click" value={hideOnOutsideClick} onValueChanged={onHideOnOutsideClickChange} /> </div> </div> </React.Fragment> ); }

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );

export const employee = { Full_Name: 'John Heart', Title: 'CEO', Birth_Date: '03/16/1964', Prefix: 'Mr.', Address: '351 S Hill St.', City: 'Los Angeles', Zipcode: 90013, Email: 'jheart@dx-email.com', Skype: 'jheart_DX_skype', Home_Phone: '(213) 555-9208', Mobile_Phone: '(213) 555-9392', };

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));

<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/25.1.7/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://cdn.jsdelivr.net/npm/core-js@2.6.12/client/shim.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>

.header { font-size: 34px; display: inline-block; vertical-align: middle; padding: 10px; margin: 0; } #employee { margin: 20px 0; -webkit-touch-callout: none; user-select: none; border-top: 1px solid lightgray; border-bottom: 1px solid lightgray; } #employee > p { padding: 10px 20px; margin: 0; } .address { height: 60px; } .options { padding: 20px; background-color: rgba(191, 191, 191, 0.15); margin-top: 20px; } .caption { font-size: 18px; font-weight: 500; } .option { margin-top: 10px; }

Show and Hide the Indicator and Pane

LoadPanel elements (a message and an animated load indicator) are displayed on a pane. If you want to hide it, set the showPane property to false. You can also disable the showIndicator property to hide the animated load indicator. In this case, the LoadPanel displays only the message. In this demo, you can use the "With indicator" and "With pane" checkboxes to change the visibility of the load indicator and pane.

Configure the Background Shade

When LoadPanel is displayed, it shades the background. Use the shadingColor property to specify the color of the shade. You can also specify the element that should be shaded. For this, assign the element's CSS selector to the container property. If you do not want to shade the background, disable the shading property. In this demo, you can uncheck the "With overlay" checkbox to do it.

Show and Hide LoadPanel

To change the LoadPanel visibility in code, use the visible property. Alternatively, you can call the show() and hide() or toggle(showing) methods.

Users can hide LoadPanel when they click outside it if you enable the hideOnOutsideClick property. Use the "Hide on outside click" checkbox to control this functionality in this demo.

LoadPanel also allows you to handle the show and hide events. Use the onShowing and onHiding functions to handle the events before they occur and possibily cancel them. Use the onShown and onHidden functions to perform required actions after the events are raised.