DashboardFloatingActions

Definition

export interface DashboardFloatingActions extends FloatingActionBaseProps {
    type: FloatingActionSectionType.Dashboard;
    /** Current dashboard widgets */
    widgets: IWidgetInstance[];
    /** Current dashboard layouts */
    layouts: ResponsiveLayouts;
    /** toggles the edit button */
    enableEdit: boolean;
    /** toggles the add button */
    enableAdd: boolean;
    /** Control when add button is visible */
    addButtonVisibility?: FloatingActionButtonVisibility;
    /** Callback to handle widget drawer changes (unified event handler) */
    onChangeWidgetDrawer: (event: WidgetDrawerChangeEvent) => Promise<boolean>;
    /** Restrict widgets to grid boundaries (affects new widget positioning) */
    isBounded?: boolean;
    /** Maximum number of columns in current breakpoint */
    maxColumns?: number;
    /** Widget drawer configuration */
    widgetDrawerConfig?: WidgetDrawerConfig;
    /** Optional callback to receive control methods for programmatic control */
    onRegister?: (controls: DashboardFloatingActionsControls) => void;
}

Usage

Last updated