load(functionToLoad)

Loads CMS data asynchronously.

CMS data (like any Obj, Widget or Binary) needs to be loaded from the cloud service before it can be used. When rendering content inside a React component, all CMS data is loaded automatically if your component is wrapped with Scrivito.provideComponent or Scrivito.connect.

Sometimes, however, you may want to access CMS data outside of rendering, for example inside an event handler like onClick, or in a server-side script. This is where Scrivito.load comes in: It loads CMS data and allows you to work asynchronously with the loaded data.

If you wrap a function with Scrivito.load, it executes the passed-in function and loads all the required data. Once all data has been loaded, Scrivito.load resolves with the value returned by your function.

Here is a simple example:

The example code loads the ID of Obj.root and prints the ID to the browser console.

The function passed in to Scrivito.load may be simple, like in the example: It loads just a single piece of data. Of course, Scrivito.load can also be used to load large amounts of data. Also, the passed-in function may perform more complex computations.

In order to load all the required data, Scrivito.load may have to execute the passed-in function multiple times. Therefore, the function must be “pure” (free of side effects). It must only read data. It must not modify data, interact with the browser, or trigger network requests. This is why, in the example above, the call to console.log is not made inside Scrivito.load but after awaiting the returned promise.

Again, please note that you don’t need to use this method when rendering content inside a React component provided that you wrap your component with Scrivito.provideComponent or Scrivito.connect.

Params

  • functionToLoad (Function) – The data to be loaded. Please make sure that this function is pure, meaning that it does not perform I/O and is free of side effects.

Returns

A promise that resolves with the value returned by the function passed-in.