Skip to main content

Function: useLoadedWorkspace()

useLoadedWorkspace(onLoad, deps): LoadedWorkspace

Defined in: src/workspace/workspaceProvider.tsx:560

React hook to perform asynchronous initialization of the workspace.

This function could be used to setup data provider, fetch initial data or import existing diagram layout.

The command history is automatically reset when the initialization is done.

Example:

const workspace = React.useState(() => Reactodia.createWorkspace({...}));
const {onMount} = Reactodia.useLoadedWorkspace(async ({context, signal}) => {
// ...
});
return (
<Reactodia.WorkspaceProvider
workspace={workspace}
onMount={onMount}>
...
</Reactodia.Workspace>
);

Parameters​

ParameterType

onLoad

(params) => Promise<void>

deps

unknown[]

Returns​

LoadedWorkspace