SchemaDashboard

The drag-and-drop widget dashboard rendered on the admin's root route.

SchemaAdmin has no default dashboard: pass this component to its dashboard prop to mount one, your own to replace it, or leave the prop unset for an admin without a root page. EnterpriseSchemaAdmin (Dashboard) passes it for you.

Example

import {SchemaDashboard} from 'habarico-enterprise';
import {SchemaAdmin} from 'habarico';

<SchemaAdmin dashboard={SchemaDashboard} {...rest}>
  <SchemaResource name="eshop/product" />
</SchemaAdmin>;

What the user can do

The settings icon switches the dashboard into edit mode, where widgets can be added, configured, moved, resized and removed. Outside edit mode the grid is read-only, so a stray drag cannot rearrange someone's dashboard.

Widgets are laid out on a responsive grid; each carries its own layout (x, y, w, h).

caution

Two widgets may not occupy the same cells. The store rejects an overlapping layout with an error rather than silently dropping one of them — worth knowing when you build a layout in code instead of by dragging.

See also

• Widget types — what can go on the dashboard
• Widget configuration — the add-widget wizard, and how the layout is stored
• Adding a new widget type — registering your own