EmbeddedDashobardComponentProps

Props for the EmbeddedDashboard component

Definition

export interface EmbeddedDashobardComponentProps {
    /**
     * List of dashboard IDs to try loading in priority order.
     * The component will use the first ID that has a record in the database.
     *
     * Example: For an equipment details page:
     * - First check equipment-specific: "ibms/equipment/<equipmentKey>"
     * - Then check type-specific: "ibms/equipment/<equipmentType>"
     * - Finally fallback to generic: "ibms/equipment"
     *
     * Pass as: ["ibms/equipment/1", "ibms/equipment/fcu", "ibms/equipment"]
     */
    ids: string[];

    /**
     * Default configuration to use when no database record exists for any of the IDs.
     * Typically loaded from a JSON file.
     * When saving, will create a new record using the last (most generic) ID from the ids array.
     */
    defaultConfiguration?: ResponsiveWidgetLayoutConfiguration;

    /**
     * Enable edit/configure mode for the dashboard
     */
    allowToConfigure?: boolean;

    /**
     * Enable per-user-group dashboard layouts
     */
    enableUserGroupLayouts?: boolean;

    /**
     * Enable responsive breakpoint selection
     */
    enableResponsiveLayouts?: boolean;
}

Usage

Last updated