Configuring the Loading Screen

View as Markdown

Summary

  • The Loading Screen is displayed while AdapTable is being initialised
  • This screen is fully configurable to match different requirements

The Loading Screen appears while AdapTable is being initialised and everything is being correctly set up.

Note

  • AdapTable shows the loading screen at the start of Adaptable.init, and hides it when initialisation finishes
  • In other words, it is only removed after state is loaded and AG Grid is ready

The Loading Screen is configured in loadingScreenOptions on User Interface Options.

showLoadingScreen

Default: true
boolean
Display the Loading Screen while AdapTable initialises

loadingScreenDelay

Default: 200
number
Milliseconds to wait before the dialog appears

loadingScreenTitle

Default: Initialising Grid
string
Title text in the Loading Screen

loadingScreenText

Default: Retrieving your settings and setting up the grid...
string
Body text in the Loading Screen
Configuring Loading Screen
Fork
  • loadingScreenTitle and loadingScreenText are set to custom strings
  • loadingScreenDelay is 200 (dialog appears 200ms after init starts)
  • Note: we have configured stateOptions.loadState to wait 2.5 seconds so initialisation takes long enough for the loading screen to remain visible
Try It Out
  • Refresh the demo (or open it in a new tab) to run Adaptable.init again and see the loading dialog
  • Change loadingScreenDelay to 2000 and refresh — the dialog appears later; if init finishes first, you may see nothing (delay is "wait before show", not "minimum display time")
Loading demo…

FAQ

Why do I not see the Loading Screen? On a fast machine, the loading screen may only flash briefly, if at all. To see it reliably, slow down stateOptions.loadState (as in demo above) or load a particularly large persisted state.