This reference includes every export reachable from the npm package public entry points and every declaration member in the inventory. Search names and signatures to find the exact import path and type contract.
export identities / unique exports / reachable contracts / members / CSS variables
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function addDashboardWidget<TData>(state: DashboardLayoutState<TData>, widget: DashboardWidget<TData>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:4
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function applyDashboardLayoutSnapshot<TData>(state: DashboardLayoutState<TData>, snapshot: DashboardLayoutSnapshot): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:18
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function autoArrangeDashboardWidgets<TData>(state: DashboardLayoutState<TData>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:19
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function clampDashboardColumnCount(value: number): DashboardColumnCount;dist/core/columns.d.ts:3
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function clearDashboardWidgets<TData>(state: DashboardLayoutState<TData>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:9
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vuecominsGridLayoutPackage = "comins-grid-layout"dist/core/package.d.ts:1
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function createDashboardLayoutState<TData = unknown>(snapshot: DashboardLayoutStateInput<TData>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:3
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport declare function createDashboardResizeScheduler(callback: (event: DashboardWidgetResizeFrameEvent) => void): DashboardResizeScheduler;dist/browser/resize-scheduler.d.ts:3
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueDASHBOARD_COLUMN_COUNTS: readonly [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]dist/core/columns.d.ts:2
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardColumnCount = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;dist/core/types.d.ts:1
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardColumnLayout = "list" | "compact" | "moveScale" | "move" | "scale" | "none";dist/core/types.d.ts:2
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardColumnLayoutSnapshot = {
widgets: DashboardWidgetLayout[];
previousLayouts: Record<DashboardWidgetId, DashboardWidgetLayout>;
};dist/core/types.d.ts:80
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardDragInPreviewLayout = Pick<DashboardWidgetLayout, "w" | "h" | "minW" | "minH" | "maxW" | "maxH">;dist/core/types.d.ts:59
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardDragOptions = {
handle?: string;
appendTo?: string;
pause?: boolean | number;
scroll?: boolean;
cancel?: string;
};dist/core/types.d.ts:40
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardExternalDropTarget = {
id: string;
selector: string;
};dist/core/types.d.ts:15
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueDashboardGrid: <TData = unknown>(props: DashboardGridProps<TData> & RefAttributes<DashboardGridHandle>) => ReactElement | null_default: typeof __VLS_exportdist/components/DashboardGrid.d.ts:59 · dist/vue/DashboardGrid.vue.d.ts:42
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardGridAdapterOptionOverrides = {
acceptWidgets?: GridStackOptions["acceptWidgets"];
};dist/gridstack/option-mapper.d.ts:17
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardGridCommands<TData = unknown> = {
addWidget: (widget: DashboardWidget<TData>) => void;
insertWidgetAt: (widget: DashboardWidget<TData>, targetLayout: DashboardWidgetLayout, targetSnapshot: DashboardLayoutSnapshot) => void;
updateWidget: (id: DashboardWidgetId, patch: Partial<DashboardWidget<TData>>) => void;
updateWidgetLayout: (id: DashboardWidgetId, patch: Partial<Omit<DashboardWidgetLayout, "id">>) => void;
removeWidget: (id: DashboardWidgetId) => void;
clearWidgets: () => void;
/** @deprecated Use resizeWidget(id, { w, h }). Retains the legacy full-width behavior. */
maximizeWidget: (id: DashboardWidgetId) => void;
/** @deprecated Use resizeWidget(id, { w, h }). Retains the legacy one-row behavior. */
minimizeWidget: (id: DashboardWidgetId) => void;
resizeWidget: (id: DashboardWidgetId, size: Pick<DashboardWidgetLayout, "w" | "h">) => void;
restoreWidget: (id: DashboardWidgetId) => void;
autoArrangeWidgets: () => void;
fitWidgetsToColumns: () => void;
fitWidgetToColumns: (id: DashboardWidgetId) => void;
setColumns: (columns: number) => void;
applyLayoutSnapshot: (snapshot: DashboardLayoutSnapshot) => void;
resetLayout: (snapshot?: DashboardLayoutSnapshot | DashboardStateSnapshotInput<TData>) => void;
restoreLayout: (snapshot: DashboardStateSnapshotInput<TData>) => void;
refreshLayout: () => void;
serializeLayout: () => DashboardLayoutSnapshot;
serializeState: () => DashboardStateSnapshot<TData>;
};dist/core/controller-types.d.ts:7
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardGridConfiguration<TData = unknown> = {
engineOptions?: DashboardGridEngineOptions;
responsive?: DashboardResponsiveOptions;
externalDropTargets?: ReadonlyArray<DashboardExternalDropTarget>;
gridId?: string;
acceptExternalWidgets?: boolean | ((candidate: DashboardWidgetDropCandidate<TData>) => boolean);
gridTransferMode?: DashboardWidgetTransferMode;
};dist/core/configuration.d.ts:5
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare class DashboardGridConfigurationError extends Error {
constructor();
}dist/core/configuration.d.ts:2
comins-grid-layout/vueexport type DashboardGridEmits<TData = unknown> = {
columnsChange: [columns: DashboardColumnCount];
layoutCommit: [snapshot: DashboardLayoutSnapshot];
widgetLayoutChange: [id: string, layout: DashboardWidgetLayout];
widgetResizeFrame: [event: DashboardWidgetResizeFrameEvent];
widgetExternalDrop: [event: DashboardWidgetExternalDropEvent];
widgetDropRequest: [request: DashboardWidgetDropRequest<TData>];
beforeMove: [event: DashboardWidgetInteractionEvent];
move: [event: DashboardWidgetInteractionEvent];
afterMove: [event: DashboardWidgetInteractionEvent];
beforeResize: [event: DashboardWidgetInteractionEvent];
resize: [event: DashboardWidgetInteractionEvent];
afterResize: [event: DashboardWidgetInteractionEvent];
beforeTitleDoubleClick: [event: DashboardWidgetInteractionEvent];
titleDoubleClick: [event: DashboardWidgetInteractionEvent];
afterTitleDoubleClick: [event: DashboardWidgetInteractionEvent];
/** @deprecated Use a custom action calling resizeWidget. */
maximizeWidget: [id: string];
/** @deprecated Use a custom action calling resizeWidget. */
minimizeWidget: [id: string];
restoreWidget: [id: string];
removeWidget: [id: string];
};dist/vue/types.d.ts:25
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardGridEngineOptions = {
cellHeight?: number | string;
margin?: number | string;
float?: boolean;
animate?: boolean;
staticGrid?: boolean;
rtl?: boolean | "auto";
minRow?: number;
maxRow?: number;
sizeToContent?: boolean;
/**
* @deprecated GridStack native lazy loading does not defer React-owned widget content.
* Use DashboardGrid.lazyRenderWidget with DashboardWidget.lazyLoad instead.
* This option remains mapped for 0.2.x compatibility and is planned for removal in 0.3.0.
*/
lazyLoad?: boolean;
dragHandle?: string;
resizeHandles?: string;
alwaysShowResizeHandle?: boolean | "mobile";
nonce?: string;
};dist/core/types.d.ts:19
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport interface DashboardGridHandle {
getGridStack(): GridStack | null;
getColumnCount(): number | null;
getRowCount(): number | null;
getFloat(): boolean | null;
isAreaEmpty(layout: Omit<DashboardWidgetLayout, "id">): boolean | null;
willItFit(layout: Omit<DashboardWidgetLayout, "id">): boolean | null;
refresh(): void;
compact(layout?: CompactOptions, doSort?: boolean): DashboardLayoutSnapshot | null;
commitLayout(): DashboardLayoutSnapshot | null;
}dist/gridstack/adapter.d.ts:39
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardGridOptionInput = DashboardInteractionOptions & {
columns?: number;
engineOptions?: DashboardGridEngineOptions;
responsive?: DashboardResponsiveOptions;
/** @deprecated Use engineOptions.cellHeight. Planned for removal in 0.3.0. */
cellHeight?: GridStackOptions["cellHeight"];
/** @deprecated Use engineOptions.margin. Planned for removal in 0.3.0. */
margin?: GridStackOptions["margin"];
};dist/gridstack/option-mapper.d.ts:4
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardGridProps<TData = unknown> = DashboardInteractionOptions & {
widgets: DashboardWidgetModel<TData>[];
columns?: DashboardColumnCount;
engineOptions?: DashboardGridEngineOptions;
responsive?: DashboardResponsiveOptions;
externalDropTargets?: ReadonlyArray<DashboardExternalDropTarget>;
gridId?: string;
acceptExternalWidgets?: boolean | ((candidate: DashboardWidgetDropCandidate<TData>) => boolean);
gridTransferMode?: DashboardWidgetTransferMode;
className?: string;
refreshKey?: number;
showControls?: boolean;
/** Default title double-click fills the current row's unused columns. */
titleDoubleClickAction?: 'fill' | 'none';
lazyRenderWidget?: boolean;
actionLabels?: Partial<DashboardWidgetActionLabels>;
renderWidget: (widget: DashboardWidgetModel<TData>) => ReactNode;
renderWidgetActions?: (widget: DashboardWidgetModel<TData>) => ReactNode;
onColumnsChange?: (columns: DashboardColumnCount) => void;
onLayoutCommit?: (snapshot: DashboardLayoutSnapshot) => void;
onWidgetLayoutChange?: (id: string, layout: DashboardWidgetModel<TData>["layout"]) => void;
onWidgetResizeFrame?: (event: DashboardWidgetResizeFrameEvent) => void;
onWidgetExternalDrop?: (event: DashboardWidgetExternalDropEvent) => void;
onWidgetDropRequest?: (request: DashboardWidgetDropRequest<TData>) => void;
/** @deprecated Use onBeforeMove. Planned for removal in 0.3.0. */
onWidgetDragStart?: (event: DashboardWidgetInteractionEvent) => void;
/** @deprecated Use onAfterMove. Planned for removal in 0.3.0. */
onWidgetDragStop?: (event: DashboardWidgetInteractionEvent) => void;
/** @deprecated Use onBeforeResize. Planned for removal in 0.3.0. */
onWidgetResizeStart?: (event: DashboardWidgetInteractionEvent) => void;
/** @deprecated Use onAfterResize. Planned for removal in 0.3.0. */
onWidgetResizeStop?: (event: DashboardWidgetInteractionEvent) => void;
onBeforeMove?: (event: DashboardWidgetInteractionEvent) => void;
onMove?: (event: DashboardWidgetInteractionEvent) => void;
onAfterMove?: (event: DashboardWidgetInteractionEvent) => void;
onBeforeResize?: (event: DashboardWidgetInteractionEvent) => void;
onResize?: (event: DashboardWidgetInteractionEvent) => void;
onAfterResize?: (event: DashboardWidgetInteractionEvent) => void;
onBeforeTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;
onTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;
onAfterTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;
/** @deprecated Supply a custom action using resizeWidget. */
onMaximizeWidget?: (id: string) => void;
/** @deprecated Supply a custom action using resizeWidget. */
onMinimizeWidget?: (id: string) => void;
onRestoreWidget?: (id: string) => void;
onRemoveWidget?: (id: string) => void;
/**
* @deprecated This is a title-only legacy alias. Use onTitleDoubleClick.
* Planned for removal in 0.3.0.
*/
onWidgetHeaderDoubleClick?: (id: string) => void;
};export type DashboardGridProps<TData = unknown> = {
widgets: DashboardWidget<TData>[];
columns?: DashboardColumnCount;
editable?: boolean;
movable?: boolean;
resizable?: boolean;
engineOptions?: DashboardGridEngineOptions;
responsive?: DashboardResponsiveOptions;
externalDropTargets?: ReadonlyArray<DashboardExternalDropTarget>;
gridId?: string;
acceptExternalWidgets?: boolean | ((candidate: DashboardWidgetDropCandidate<TData>) => boolean);
gridTransferMode?: DashboardWidgetTransferMode;
refreshKey?: number;
showControls?: boolean;
/** Default title double-click fills the current row's unused columns. */
titleDoubleClickAction?: 'fill' | 'none';
lazyRenderWidget?: boolean;
actionLabels?: Partial<DashboardWidgetActionLabels>;
};dist/components/DashboardGrid.d.ts:6 · dist/vue/types.d.ts:6
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardInteractionOptions = {
editable?: boolean;
movable?: boolean;
resizable?: boolean;
};dist/core/types.d.ts:97
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardLayoutMutationEvent<TData = unknown> = {
kind: DashboardLayoutMutationKind;
widgetIds: DashboardWidgetId[];
columns: DashboardColumnCount;
snapshot: DashboardStateSnapshot<TData>;
};dist/core/types.d.ts:163
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardLayoutMutationKind = "widget:add" | "widget:update" | "widget:remove" | "widgets:clear" | "layout:commit" | "layout:reset" | "layout:restore" | "layout:arrange" | "layout:fill" | "columns:change";dist/core/types.d.ts:162
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardLayoutsByColumn = Partial<Record<DashboardColumnCount, DashboardColumnLayoutSnapshot>>;dist/core/types.d.ts:84
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardLayoutSnapshot = {
columns: DashboardColumnCount;
widgets: DashboardWidgetLayout[];
};dist/core/types.d.ts:76
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardLayoutState<TData = unknown> = {
columns: DashboardColumnCount;
widgets: DashboardWidget<TData>[];
previousLayouts: Record<DashboardWidgetId, DashboardWidgetLayout | undefined>;
layoutsByColumn: DashboardLayoutsByColumn;
refreshVersion: number;
};dist/core/types.d.ts:102
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardResizeScheduler = {
schedule: (event: DashboardWidgetResizeFrameEvent) => void;
cancel: () => void;
};dist/browser/types.d.ts:10
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardResponsiveBreakpoint = {
maxWidth: number;
columns: DashboardColumnCount;
layout?: DashboardColumnLayout;
};dist/core/types.d.ts:3
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardResponsiveOptions = {
columnWidth?: number;
columnMax?: DashboardColumnCount;
breakpoints?: ReadonlyArray<DashboardResponsiveBreakpoint>;
breakpointForWindow?: boolean;
layout?: DashboardColumnLayout;
};dist/core/types.d.ts:8
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardStateSnapshot<TData = unknown> = {
columns: DashboardColumnCount;
widgets: DashboardWidget<TData>[];
previousLayouts: Record<DashboardWidgetId, DashboardWidgetLayout>;
layoutsByColumn: DashboardLayoutsByColumn;
};dist/core/types.d.ts:85
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardStateSnapshotInput<TData = unknown> = {
columns: number;
widgets: DashboardWidget<TData>[];
previousLayouts?: Record<DashboardWidgetId, DashboardWidgetLayout>;
layoutsByColumn?: DashboardLayoutsByColumn;
};dist/core/types.d.ts:91
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidget<TData = unknown> = {
id: DashboardWidgetId;
title?: string;
layout: DashboardWidgetLayout;
data?: TData;
minimized?: boolean;
maximized?: boolean;
locked?: boolean;
movable?: boolean;
resizable?: boolean;
lazyLoad?: boolean;
sizeToContent?: boolean | number;
resizeToContentParent?: string;
};dist/core/types.d.ts:60
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetActionLabels = {
/** @deprecated No default maximize button is rendered. */
maximize: string;
/** @deprecated No default minimize button is rendered. */
minimize: string;
restore: string;
remove: string;
};dist/ui/widget-actions.d.ts:1
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetDropCandidate<TData = unknown> = {
source: {
kind: "palette";
sourceId: string;
} | {
kind: "grid";
gridId: string;
widgetId: DashboardWidgetId;
};
targetGridId: string;
widget: DashboardWidget<TData>;
mode: DashboardWidgetTransferMode;
};dist/core/types.d.ts:135
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetDropRequest<TData = unknown> = DashboardWidgetDropCandidate<TData> & {
operationId: string;
targetLayout: DashboardWidgetLayout;
targetSnapshot: DashboardLayoutSnapshot;
};dist/core/types.d.ts:148
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetExternalDropEvent = {
widgetId: DashboardWidgetId;
targetId: string;
columns: DashboardColumnCount;
layout: DashboardWidgetLayout;
};dist/core/types.d.ts:169
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetId = string;dist/core/types.d.ts:47
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetInsertionResult<TData = unknown> = {
accepted: true;
state: DashboardLayoutState<TData>;
} | {
accepted: false;
reason: Extract<DashboardWidgetTransferRejection, "duplicate-id" | "invalid-layout">;
state: DashboardLayoutState<TData>;
};dist/core/types.d.ts:109
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetInteractionEvent = {
id: DashboardWidgetId;
layout: DashboardWidgetLayout;
};dist/core/types.d.ts:158
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetLayout = {
id: DashboardWidgetId;
x: number;
y: number;
w: number;
h: number;
minW?: number;
minH?: number;
maxW?: number;
maxH?: number;
};dist/core/types.d.ts:48
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetResizeFrameEvent = {
id: DashboardWidgetId;
width: number;
height: number;
};dist/core/types.d.ts:153
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport declare function DashboardWidgetShell<TData = unknown>({ widget, children, showControls, labels, onRestore, onRemove, onHeaderDoubleClick, onBeforeTitleDoubleClick, onTitleDoubleClick, onAfterTitleDoubleClick, renderActions, }: DashboardWidgetShellProps<TData>): import("react").JSX.Element;_default: typeof __VLS_exportdist/components/DashboardWidget.d.ts:26 · dist/vue/DashboardWidgetShell.vue.d.ts:29
comins-grid-layout/vueexport type DashboardWidgetShellEmits = {
/** @deprecated Use a custom action calling resizeWidget. */
maximize: [id: string];
/** @deprecated Use a custom action calling resizeWidget. */
minimize: [id: string];
restore: [id: string];
remove: [id: string];
beforeTitleDoubleClick: [event: DashboardWidgetInteractionEvent];
titleDoubleClick: [event: DashboardWidgetInteractionEvent];
afterTitleDoubleClick: [event: DashboardWidgetInteractionEvent];
};dist/vue/types.d.ts:53
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetShellProps<TData = unknown> = {
widget: DashboardWidgetModel<TData>;
children: ReactNode;
showControls?: boolean;
labels?: DashboardWidgetActionLabels;
/** @deprecated Supply a custom action using resizeWidget. */
onMaximize?: (id: string) => void;
/** @deprecated Supply a custom action using resizeWidget. */
onMinimize?: (id: string) => void;
onRestore?: (id: string) => void;
onRemove?: (id: string) => void;
/**
* @deprecated This is a title-only legacy alias. Use onTitleDoubleClick.
* Removal is deferred to a future release.
*/
onHeaderDoubleClick?: (id: string) => void;
onBeforeTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;
onTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;
onAfterTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;
renderActions?: (widget: DashboardWidgetModel<TData>) => ReactNode;
};export type DashboardWidgetShellProps<TData = unknown> = {
widget: DashboardWidget<TData>;
showControls?: boolean;
labels?: DashboardWidgetActionLabels;
};dist/components/DashboardWidget.d.ts:5 · dist/vue/types.d.ts:48
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetTransferInput<TData = unknown> = {
source: DashboardLayoutState<TData>;
target: DashboardLayoutState<TData>;
widgetId: DashboardWidgetId;
targetLayout: DashboardWidgetLayout;
targetSnapshot: DashboardLayoutSnapshot;
mode: DashboardWidgetTransferMode;
};dist/core/types.d.ts:117
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetTransferMode = "copy" | "move";dist/core/types.d.ts:74
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetTransferRejection = "duplicate-id" | "missing-widget" | "not-transferable" | "invalid-layout";dist/core/types.d.ts:75
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type DashboardWidgetTransferResult<TData = unknown> = {
accepted: true;
source: DashboardLayoutState<TData>;
target: DashboardLayoutState<TData>;
} | {
accepted: false;
reason: DashboardWidgetTransferRejection;
source: DashboardLayoutState<TData>;
target: DashboardLayoutState<TData>;
};dist/core/types.d.ts:125
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function fitDashboardWidgetsToColumns<TData>(state: DashboardLayoutState<TData>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:20
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function fitDashboardWidgetToColumns<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:21
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function insertDashboardWidgetAtLayout<TData>(state: DashboardLayoutState<TData>, widget: DashboardWidget<TData>, targetLayout: DashboardWidgetLayout, targetSnapshot: DashboardLayoutSnapshot): DashboardWidgetInsertionResult<TData>;dist/core/layout-state.d.ts:5
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport declare function mapDashboardGridOptions(options?: DashboardGridOptionInput,
/**
* @deprecated Adapter-owned bridge. Consumers should configure
* DashboardGrid.acceptExternalWidgets. Planned for removal in 0.3.0.
*/
adapterOverrides?: DashboardGridAdapterOptionOverrides): GridStackOptions;dist/gridstack/option-mapper.d.ts:20
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport declare function mapDashboardWidgetOptions<TData>(widget: DashboardWidget<TData>, options: DashboardGridOptionInput): Pick<GridStackWidget, "locked" | "noMove" | "noResize" | "lazyLoad" | "sizeToContent" | "resizeToContentParent">;dist/gridstack/option-mapper.d.ts:26
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function maximizeDashboardWidget<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:11
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function minimizeDashboardWidget<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:13
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function removeDashboardWidget<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:8
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function resizeDashboardWidget<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId, size: Pick<DashboardWidgetLayout, "w" | "h">): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:15
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function restoreDashboardWidget<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:16
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function serializeDashboardLayout<TData>(state: DashboardLayoutState<TData>): DashboardLayoutSnapshot;dist/core/layout-state.d.ts:22
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function serializeDashboardState<TData>(state: DashboardLayoutState<TData>): DashboardStateSnapshot<TData>;dist/core/layout-state.d.ts:23
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function setDashboardColumns<TData>(state: DashboardLayoutState<TData>, columns: number): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:17
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function transferDashboardWidget<TData>(input: DashboardWidgetTransferInput<TData>): DashboardWidgetTransferResult<TData>;dist/core/widget-transfer.d.ts:2
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function updateDashboardWidget<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId, patch: Partial<DashboardWidget<TData>>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:6
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function updateDashboardWidgetLayout<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId, patch: Partial<Omit<DashboardWidgetLayout, "id">>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:7
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport declare function useDashboardDragIn<TData>(options: UseDashboardDragInOptions<TData>): RefCallback<HTMLElement>;export declare function useDashboardDragIn<TData>(options: MaybeRefOrGetter<UseDashboardDragInOptions<TData>>): ShallowRef<HTMLElement | null>;dist/components/use-dashboard-drag-in.d.ts:4 · dist/vue/use-dashboard-drag-in.d.ts:3
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport type UseDashboardDragInOptions<TData> = {
sourceId: string;
previewLayout: DashboardDragInPreviewLayout;
createWidget: () => DashboardWidget<TData>;
dragOptions?: DashboardDragOptions;
disabled?: boolean;
};dist/browser/types.d.ts:3
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport declare function useDashboardGrid<TData = unknown>(options?: UseDashboardGridOptions<TData>): UseDashboardGridResult<TData>;export declare function useDashboardGrid<TData = unknown>(options?: MaybeRefOrGetter<UseDashboardGridOptions<TData>>): UseDashboardGridResult<TData>;dist/react/use-dashboard-grid.d.ts:11 · dist/vue/use-dashboard-grid.d.ts:4
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport type UseDashboardGridOptions<TData = unknown> = {
initialColumns?: number;
initialWidgets?: DashboardWidget<TData>[];
onLayoutMutation?: (event: DashboardLayoutMutationEvent<TData>) => void;
};dist/core/controller-types.d.ts:2
comins-grid-layoutcomins-grid-layout/reactcomins-grid-layout/vueexport type UseDashboardGridResult<TData = unknown> = {
state: DashboardLayoutState<TData>;
widgets: DashboardWidget<TData>[];
columns: DashboardLayoutState<TData>["columns"];
refreshVersion: number;
commands: DashboardGridCommands<TData>;
};export type UseDashboardGridResult<TData = unknown> = {
state: ComputedRef<DashboardLayoutState<TData>>;
widgets: ComputedRef<DashboardWidget<TData>[]>;
columns: ComputedRef<DashboardLayoutState<TData>["columns"]>;
refreshVersion: ComputedRef<number>;
commands: DashboardGridCommands<TData>;
};dist/react/use-dashboard-grid.d.ts:4 · dist/vue/types.d.ts:64
comins-grid-layoutcomins-grid-layout/corecomins-grid-layout/reactcomins-grid-layout/vueexport declare function validateDashboardGridConfiguration<TData>(configuration: DashboardGridConfiguration<TData>): void;dist/core/configuration.d.ts:13
Package-owned declarations and members reachable from public export signatures.
export declare function createDashboardResizeScheduler(callback: (event: DashboardWidgetResizeFrameEvent) => void): DashboardResizeScheduler;dist/browser/resize-scheduler.d.ts:3
export type DashboardResizeScheduler = {
schedule: (event: DashboardWidgetResizeFrameEvent) => void;
cancel: () => void;
};dist/browser/types.d.ts:10
schedule: (event: DashboardWidgetResizeFrameEvent) => void;dist/browser/types.d.ts:11cancel: () => void;dist/browser/types.d.ts:12export type UseDashboardDragInOptions<TData> = {
sourceId: string;
previewLayout: DashboardDragInPreviewLayout;
createWidget: () => DashboardWidget<TData>;
dragOptions?: DashboardDragOptions;
disabled?: boolean;
};dist/browser/types.d.ts:3
sourceId: string;dist/browser/types.d.ts:4previewLayout: DashboardDragInPreviewLayout;dist/browser/types.d.ts:5createWidget: () => DashboardWidget<TData>;dist/browser/types.d.ts:6dragOptions?: DashboardDragOptions;dist/browser/types.d.ts:7disabled?: boolean;dist/browser/types.d.ts:8DashboardGrid: <TData = unknown>(props: DashboardGridProps<TData> & RefAttributes<DashboardGridHandle>) => ReactElement | nulldist/components/DashboardGrid.d.ts:59
export type DashboardGridProps<TData = unknown> = DashboardInteractionOptions & {
widgets: DashboardWidgetModel<TData>[];
columns?: DashboardColumnCount;
engineOptions?: DashboardGridEngineOptions;
responsive?: DashboardResponsiveOptions;
externalDropTargets?: ReadonlyArray<DashboardExternalDropTarget>;
gridId?: string;
acceptExternalWidgets?: boolean | ((candidate: DashboardWidgetDropCandidate<TData>) => boolean);
gridTransferMode?: DashboardWidgetTransferMode;
className?: string;
refreshKey?: number;
showControls?: boolean;
/** Default title double-click fills the current row's unused columns. */
titleDoubleClickAction?: 'fill' | 'none';
lazyRenderWidget?: boolean;
actionLabels?: Partial<DashboardWidgetActionLabels>;
renderWidget: (widget: DashboardWidgetModel<TData>) => ReactNode;
renderWidgetActions?: (widget: DashboardWidgetModel<TData>) => ReactNode;
onColumnsChange?: (columns: DashboardColumnCount) => void;
onLayoutCommit?: (snapshot: DashboardLayoutSnapshot) => void;
onWidgetLayoutChange?: (id: string, layout: DashboardWidgetModel<TData>["layout"]) => void;
onWidgetResizeFrame?: (event: DashboardWidgetResizeFrameEvent) => void;
onWidgetExternalDrop?: (event: DashboardWidgetExternalDropEvent) => void;
onWidgetDropRequest?: (request: DashboardWidgetDropRequest<TData>) => void;
/** @deprecated Use onBeforeMove. Planned for removal in 0.3.0. */
onWidgetDragStart?: (event: DashboardWidgetInteractionEvent) => void;
/** @deprecated Use onAfterMove. Planned for removal in 0.3.0. */
onWidgetDragStop?: (event: DashboardWidgetInteractionEvent) => void;
/** @deprecated Use onBeforeResize. Planned for removal in 0.3.0. */
onWidgetResizeStart?: (event: DashboardWidgetInteractionEvent) => void;
/** @deprecated Use onAfterResize. Planned for removal in 0.3.0. */
onWidgetResizeStop?: (event: DashboardWidgetInteractionEvent) => void;
onBeforeMove?: (event: DashboardWidgetInteractionEvent) => void;
onMove?: (event: DashboardWidgetInteractionEvent) => void;
onAfterMove?: (event: DashboardWidgetInteractionEvent) => void;
onBeforeResize?: (event: DashboardWidgetInteractionEvent) => void;
onResize?: (event: DashboardWidgetInteractionEvent) => void;
onAfterResize?: (event: DashboardWidgetInteractionEvent) => void;
onBeforeTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;
onTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;
onAfterTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;
/** @deprecated Supply a custom action using resizeWidget. */
onMaximizeWidget?: (id: string) => void;
/** @deprecated Supply a custom action using resizeWidget. */
onMinimizeWidget?: (id: string) => void;
onRestoreWidget?: (id: string) => void;
onRemoveWidget?: (id: string) => void;
/**
* @deprecated This is a title-only legacy alias. Use onTitleDoubleClick.
* Planned for removal in 0.3.0.
*/
onWidgetHeaderDoubleClick?: (id: string) => void;
};dist/components/DashboardGrid.d.ts:6
export declare function DashboardWidgetShell<TData = unknown>({ widget, children, showControls, labels, onRestore, onRemove, onHeaderDoubleClick, onBeforeTitleDoubleClick, onTitleDoubleClick, onAfterTitleDoubleClick, renderActions, }: DashboardWidgetShellProps<TData>): import("react").JSX.Element;dist/components/DashboardWidget.d.ts:26
export type DashboardWidgetShellProps<TData = unknown> = {
widget: DashboardWidgetModel<TData>;
children: ReactNode;
showControls?: boolean;
labels?: DashboardWidgetActionLabels;
/** @deprecated Supply a custom action using resizeWidget. */
onMaximize?: (id: string) => void;
/** @deprecated Supply a custom action using resizeWidget. */
onMinimize?: (id: string) => void;
onRestore?: (id: string) => void;
onRemove?: (id: string) => void;
/**
* @deprecated This is a title-only legacy alias. Use onTitleDoubleClick.
* Removal is deferred to a future release.
*/
onHeaderDoubleClick?: (id: string) => void;
onBeforeTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;
onTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;
onAfterTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;
renderActions?: (widget: DashboardWidgetModel<TData>) => ReactNode;
};dist/components/DashboardWidget.d.ts:5
widget: DashboardWidgetModel<TData>;dist/components/DashboardWidget.d.ts:6children: ReactNode;dist/components/DashboardWidget.d.ts:7showControls?: boolean;dist/components/DashboardWidget.d.ts:8labels?: DashboardWidgetActionLabels;dist/components/DashboardWidget.d.ts:9onMaximize?: (id: string) => void;dist/components/DashboardWidget.d.ts:11onMinimize?: (id: string) => void;dist/components/DashboardWidget.d.ts:13onRestore?: (id: string) => void;dist/components/DashboardWidget.d.ts:14onRemove?: (id: string) => void;dist/components/DashboardWidget.d.ts:15onHeaderDoubleClick?: (id: string) => void;dist/components/DashboardWidget.d.ts:20onBeforeTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;dist/components/DashboardWidget.d.ts:21onTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;dist/components/DashboardWidget.d.ts:22onAfterTitleDoubleClick?: (event: DashboardWidgetInteractionEvent) => void;dist/components/DashboardWidget.d.ts:23renderActions?: (widget: DashboardWidgetModel<TData>) => ReactNode;dist/components/DashboardWidget.d.ts:24export declare function useDashboardDragIn<TData>(options: UseDashboardDragInOptions<TData>): RefCallback<HTMLElement>;dist/components/use-dashboard-drag-in.d.ts:4
DASHBOARD_COLUMN_COUNTS: readonly [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]dist/core/columns.d.ts:2
export declare function clampDashboardColumnCount(value: number): DashboardColumnCount;dist/core/columns.d.ts:3
export declare function validateDashboardGridConfiguration<TData>(configuration: DashboardGridConfiguration<TData>): void;dist/core/configuration.d.ts:13
export declare class DashboardGridConfigurationError extends Error {
constructor();
}dist/core/configuration.d.ts:2
constructor();dist/core/configuration.d.ts:3export type DashboardGridConfiguration<TData = unknown> = {
engineOptions?: DashboardGridEngineOptions;
responsive?: DashboardResponsiveOptions;
externalDropTargets?: ReadonlyArray<DashboardExternalDropTarget>;
gridId?: string;
acceptExternalWidgets?: boolean | ((candidate: DashboardWidgetDropCandidate<TData>) => boolean);
gridTransferMode?: DashboardWidgetTransferMode;
};dist/core/configuration.d.ts:5
engineOptions?: DashboardGridEngineOptions;dist/core/configuration.d.ts:6responsive?: DashboardResponsiveOptions;dist/core/configuration.d.ts:7externalDropTargets?: ReadonlyArray<DashboardExternalDropTarget>;dist/core/configuration.d.ts:8gridId?: string;dist/core/configuration.d.ts:9acceptExternalWidgets?: boolean | ((candidate: DashboardWidgetDropCandidate<TData>) => boolean);dist/core/configuration.d.ts:10gridTransferMode?: DashboardWidgetTransferMode;dist/core/configuration.d.ts:11export type UseDashboardGridOptions<TData = unknown> = {
initialColumns?: number;
initialWidgets?: DashboardWidget<TData>[];
onLayoutMutation?: (event: DashboardLayoutMutationEvent<TData>) => void;
};dist/core/controller-types.d.ts:2
initialColumns?: number;dist/core/controller-types.d.ts:3initialWidgets?: DashboardWidget<TData>[];dist/core/controller-types.d.ts:4onLayoutMutation?: (event: DashboardLayoutMutationEvent<TData>) => void;dist/core/controller-types.d.ts:5export type DashboardGridCommands<TData = unknown> = {
addWidget: (widget: DashboardWidget<TData>) => void;
insertWidgetAt: (widget: DashboardWidget<TData>, targetLayout: DashboardWidgetLayout, targetSnapshot: DashboardLayoutSnapshot) => void;
updateWidget: (id: DashboardWidgetId, patch: Partial<DashboardWidget<TData>>) => void;
updateWidgetLayout: (id: DashboardWidgetId, patch: Partial<Omit<DashboardWidgetLayout, "id">>) => void;
removeWidget: (id: DashboardWidgetId) => void;
clearWidgets: () => void;
/** @deprecated Use resizeWidget(id, { w, h }). Retains the legacy full-width behavior. */
maximizeWidget: (id: DashboardWidgetId) => void;
/** @deprecated Use resizeWidget(id, { w, h }). Retains the legacy one-row behavior. */
minimizeWidget: (id: DashboardWidgetId) => void;
resizeWidget: (id: DashboardWidgetId, size: Pick<DashboardWidgetLayout, "w" | "h">) => void;
restoreWidget: (id: DashboardWidgetId) => void;
autoArrangeWidgets: () => void;
fitWidgetsToColumns: () => void;
fitWidgetToColumns: (id: DashboardWidgetId) => void;
setColumns: (columns: number) => void;
applyLayoutSnapshot: (snapshot: DashboardLayoutSnapshot) => void;
resetLayout: (snapshot?: DashboardLayoutSnapshot | DashboardStateSnapshotInput<TData>) => void;
restoreLayout: (snapshot: DashboardStateSnapshotInput<TData>) => void;
refreshLayout: () => void;
serializeLayout: () => DashboardLayoutSnapshot;
serializeState: () => DashboardStateSnapshot<TData>;
};dist/core/controller-types.d.ts:7
addWidget: (widget: DashboardWidget<TData>) => void;dist/core/controller-types.d.ts:8insertWidgetAt: (widget: DashboardWidget<TData>, targetLayout: DashboardWidgetLayout, targetSnapshot: DashboardLayoutSnapshot) => void;dist/core/controller-types.d.ts:9updateWidget: (id: DashboardWidgetId, patch: Partial<DashboardWidget<TData>>) => void;dist/core/controller-types.d.ts:10updateWidgetLayout: (id: DashboardWidgetId, patch: Partial<Omit<DashboardWidgetLayout, "id">>) => void;dist/core/controller-types.d.ts:11removeWidget: (id: DashboardWidgetId) => void;dist/core/controller-types.d.ts:12clearWidgets: () => void;dist/core/controller-types.d.ts:13maximizeWidget: (id: DashboardWidgetId) => void;dist/core/controller-types.d.ts:15minimizeWidget: (id: DashboardWidgetId) => void;dist/core/controller-types.d.ts:17resizeWidget: (id: DashboardWidgetId, size: Pick<DashboardWidgetLayout, "w" | "h">) => void;dist/core/controller-types.d.ts:18restoreWidget: (id: DashboardWidgetId) => void;dist/core/controller-types.d.ts:19autoArrangeWidgets: () => void;dist/core/controller-types.d.ts:20fitWidgetsToColumns: () => void;dist/core/controller-types.d.ts:21fitWidgetToColumns: (id: DashboardWidgetId) => void;dist/core/controller-types.d.ts:22setColumns: (columns: number) => void;dist/core/controller-types.d.ts:23applyLayoutSnapshot: (snapshot: DashboardLayoutSnapshot) => void;dist/core/controller-types.d.ts:24resetLayout: (snapshot?: DashboardLayoutSnapshot | DashboardStateSnapshotInput<TData>) => void;dist/core/controller-types.d.ts:25restoreLayout: (snapshot: DashboardStateSnapshotInput<TData>) => void;dist/core/controller-types.d.ts:26refreshLayout: () => void;dist/core/controller-types.d.ts:27serializeLayout: () => DashboardLayoutSnapshot;dist/core/controller-types.d.ts:28serializeState: () => DashboardStateSnapshot<TData>;dist/core/controller-types.d.ts:29export declare function maximizeDashboardWidget<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:11
export declare function minimizeDashboardWidget<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:13
export declare function resizeDashboardWidget<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId, size: Pick<DashboardWidgetLayout, "w" | "h">): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:15
export declare function restoreDashboardWidget<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:16
export declare function setDashboardColumns<TData>(state: DashboardLayoutState<TData>, columns: number): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:17
export declare function applyDashboardLayoutSnapshot<TData>(state: DashboardLayoutState<TData>, snapshot: DashboardLayoutSnapshot): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:18
export declare function autoArrangeDashboardWidgets<TData>(state: DashboardLayoutState<TData>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:19
type DashboardLayoutStateInput<TData> = DashboardLayoutSnapshot | DashboardStateSnapshotInput<TData>;dist/core/layout-state.d.ts:2
export declare function fitDashboardWidgetsToColumns<TData>(state: DashboardLayoutState<TData>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:20
export declare function fitDashboardWidgetToColumns<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:21
export declare function serializeDashboardLayout<TData>(state: DashboardLayoutState<TData>): DashboardLayoutSnapshot;dist/core/layout-state.d.ts:22
export declare function serializeDashboardState<TData>(state: DashboardLayoutState<TData>): DashboardStateSnapshot<TData>;dist/core/layout-state.d.ts:23
export declare function createDashboardLayoutState<TData = unknown>(snapshot: DashboardLayoutStateInput<TData>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:3
export declare function addDashboardWidget<TData>(state: DashboardLayoutState<TData>, widget: DashboardWidget<TData>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:4
export declare function insertDashboardWidgetAtLayout<TData>(state: DashboardLayoutState<TData>, widget: DashboardWidget<TData>, targetLayout: DashboardWidgetLayout, targetSnapshot: DashboardLayoutSnapshot): DashboardWidgetInsertionResult<TData>;dist/core/layout-state.d.ts:5
export declare function updateDashboardWidget<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId, patch: Partial<DashboardWidget<TData>>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:6
export declare function updateDashboardWidgetLayout<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId, patch: Partial<Omit<DashboardWidgetLayout, "id">>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:7
export declare function removeDashboardWidget<TData>(state: DashboardLayoutState<TData>, id: DashboardWidgetId): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:8
export declare function clearDashboardWidgets<TData>(state: DashboardLayoutState<TData>): DashboardLayoutState<TData>;dist/core/layout-state.d.ts:9
cominsGridLayoutPackage = "comins-grid-layout"dist/core/package.d.ts:1
export type DashboardColumnCount = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;dist/core/types.d.ts:1
export type DashboardLayoutState<TData = unknown> = {
columns: DashboardColumnCount;
widgets: DashboardWidget<TData>[];
previousLayouts: Record<DashboardWidgetId, DashboardWidgetLayout | undefined>;
layoutsByColumn: DashboardLayoutsByColumn;
refreshVersion: number;
};dist/core/types.d.ts:102
columns: DashboardColumnCount;dist/core/types.d.ts:103widgets: DashboardWidget<TData>[];dist/core/types.d.ts:104previousLayouts: Record<DashboardWidgetId, DashboardWidgetLayout | undefined>;dist/core/types.d.ts:105layoutsByColumn: DashboardLayoutsByColumn;dist/core/types.d.ts:106refreshVersion: number;dist/core/types.d.ts:107export type DashboardWidgetInsertionResult<TData = unknown> = {
accepted: true;
state: DashboardLayoutState<TData>;
} | {
accepted: false;
reason: Extract<DashboardWidgetTransferRejection, "duplicate-id" | "invalid-layout">;
state: DashboardLayoutState<TData>;
};dist/core/types.d.ts:109
export type DashboardWidgetTransferInput<TData = unknown> = {
source: DashboardLayoutState<TData>;
target: DashboardLayoutState<TData>;
widgetId: DashboardWidgetId;
targetLayout: DashboardWidgetLayout;
targetSnapshot: DashboardLayoutSnapshot;
mode: DashboardWidgetTransferMode;
};dist/core/types.d.ts:117
source: DashboardLayoutState<TData>;dist/core/types.d.ts:118target: DashboardLayoutState<TData>;dist/core/types.d.ts:119widgetId: DashboardWidgetId;dist/core/types.d.ts:120targetLayout: DashboardWidgetLayout;dist/core/types.d.ts:121targetSnapshot: DashboardLayoutSnapshot;dist/core/types.d.ts:122mode: DashboardWidgetTransferMode;dist/core/types.d.ts:123export type DashboardWidgetTransferResult<TData = unknown> = {
accepted: true;
source: DashboardLayoutState<TData>;
target: DashboardLayoutState<TData>;
} | {
accepted: false;
reason: DashboardWidgetTransferRejection;
source: DashboardLayoutState<TData>;
target: DashboardLayoutState<TData>;
};dist/core/types.d.ts:125
export type DashboardWidgetDropCandidate<TData = unknown> = {
source: {
kind: "palette";
sourceId: string;
} | {
kind: "grid";
gridId: string;
widgetId: DashboardWidgetId;
};
targetGridId: string;
widget: DashboardWidget<TData>;
mode: DashboardWidgetTransferMode;
};dist/core/types.d.ts:135
source: {
kind: "palette";
sourceId: string;
} | {
kind: "grid";
gridId: string;
widgetId: DashboardWidgetId;
};dist/core/types.d.ts:136targetGridId: string;dist/core/types.d.ts:144widget: DashboardWidget<TData>;dist/core/types.d.ts:145mode: DashboardWidgetTransferMode;dist/core/types.d.ts:146export type DashboardWidgetDropRequest<TData = unknown> = DashboardWidgetDropCandidate<TData> & {
operationId: string;
targetLayout: DashboardWidgetLayout;
targetSnapshot: DashboardLayoutSnapshot;
};dist/core/types.d.ts:148
export type DashboardExternalDropTarget = {
id: string;
selector: string;
};dist/core/types.d.ts:15
id: string;dist/core/types.d.ts:16selector: string;dist/core/types.d.ts:17export type DashboardWidgetResizeFrameEvent = {
id: DashboardWidgetId;
width: number;
height: number;
};dist/core/types.d.ts:153
id: DashboardWidgetId;dist/core/types.d.ts:154width: number;dist/core/types.d.ts:155height: number;dist/core/types.d.ts:156export type DashboardWidgetInteractionEvent = {
id: DashboardWidgetId;
layout: DashboardWidgetLayout;
};dist/core/types.d.ts:158
id: DashboardWidgetId;dist/core/types.d.ts:159layout: DashboardWidgetLayout;dist/core/types.d.ts:160export type DashboardLayoutMutationKind = "widget:add" | "widget:update" | "widget:remove" | "widgets:clear" | "layout:commit" | "layout:reset" | "layout:restore" | "layout:arrange" | "layout:fill" | "columns:change";dist/core/types.d.ts:162
export type DashboardLayoutMutationEvent<TData = unknown> = {
kind: DashboardLayoutMutationKind;
widgetIds: DashboardWidgetId[];
columns: DashboardColumnCount;
snapshot: DashboardStateSnapshot<TData>;
};dist/core/types.d.ts:163
kind: DashboardLayoutMutationKind;dist/core/types.d.ts:164widgetIds: DashboardWidgetId[];dist/core/types.d.ts:165columns: DashboardColumnCount;dist/core/types.d.ts:166snapshot: DashboardStateSnapshot<TData>;dist/core/types.d.ts:167export type DashboardWidgetExternalDropEvent = {
widgetId: DashboardWidgetId;
targetId: string;
columns: DashboardColumnCount;
layout: DashboardWidgetLayout;
};dist/core/types.d.ts:169
widgetId: DashboardWidgetId;dist/core/types.d.ts:170targetId: string;dist/core/types.d.ts:171columns: DashboardColumnCount;dist/core/types.d.ts:172layout: DashboardWidgetLayout;dist/core/types.d.ts:173export type DashboardGridEngineOptions = {
cellHeight?: number | string;
margin?: number | string;
float?: boolean;
animate?: boolean;
staticGrid?: boolean;
rtl?: boolean | "auto";
minRow?: number;
maxRow?: number;
sizeToContent?: boolean;
/**
* @deprecated GridStack native lazy loading does not defer React-owned widget content.
* Use DashboardGrid.lazyRenderWidget with DashboardWidget.lazyLoad instead.
* This option remains mapped for 0.2.x compatibility and is planned for removal in 0.3.0.
*/
lazyLoad?: boolean;
dragHandle?: string;
resizeHandles?: string;
alwaysShowResizeHandle?: boolean | "mobile";
nonce?: string;
};dist/core/types.d.ts:19
cellHeight?: number | string;dist/core/types.d.ts:20margin?: number | string;dist/core/types.d.ts:21float?: boolean;dist/core/types.d.ts:22animate?: boolean;dist/core/types.d.ts:23staticGrid?: boolean;dist/core/types.d.ts:24rtl?: boolean | "auto";dist/core/types.d.ts:25minRow?: number;dist/core/types.d.ts:26maxRow?: number;dist/core/types.d.ts:27sizeToContent?: boolean;dist/core/types.d.ts:28lazyLoad?: boolean;dist/core/types.d.ts:34dragHandle?: string;dist/core/types.d.ts:35resizeHandles?: string;dist/core/types.d.ts:36alwaysShowResizeHandle?: boolean | "mobile";dist/core/types.d.ts:37nonce?: string;dist/core/types.d.ts:38export type DashboardColumnLayout = "list" | "compact" | "moveScale" | "move" | "scale" | "none";dist/core/types.d.ts:2
export type DashboardResponsiveBreakpoint = {
maxWidth: number;
columns: DashboardColumnCount;
layout?: DashboardColumnLayout;
};dist/core/types.d.ts:3
maxWidth: number;dist/core/types.d.ts:4columns: DashboardColumnCount;dist/core/types.d.ts:5layout?: DashboardColumnLayout;dist/core/types.d.ts:6export type DashboardDragOptions = {
handle?: string;
appendTo?: string;
pause?: boolean | number;
scroll?: boolean;
cancel?: string;
};dist/core/types.d.ts:40
handle?: string;dist/core/types.d.ts:41appendTo?: string;dist/core/types.d.ts:42pause?: boolean | number;dist/core/types.d.ts:43scroll?: boolean;dist/core/types.d.ts:44cancel?: string;dist/core/types.d.ts:45export type DashboardWidgetId = string;dist/core/types.d.ts:47
export type DashboardWidgetLayout = {
id: DashboardWidgetId;
x: number;
y: number;
w: number;
h: number;
minW?: number;
minH?: number;
maxW?: number;
maxH?: number;
};dist/core/types.d.ts:48
id: DashboardWidgetId;dist/core/types.d.ts:49x: number;dist/core/types.d.ts:50y: number;dist/core/types.d.ts:51w: number;dist/core/types.d.ts:52h: number;dist/core/types.d.ts:53minW?: number;dist/core/types.d.ts:54minH?: number;dist/core/types.d.ts:55maxW?: number;dist/core/types.d.ts:56maxH?: number;dist/core/types.d.ts:57export type DashboardDragInPreviewLayout = Pick<DashboardWidgetLayout, "w" | "h" | "minW" | "minH" | "maxW" | "maxH">;dist/core/types.d.ts:59
export type DashboardWidget<TData = unknown> = {
id: DashboardWidgetId;
title?: string;
layout: DashboardWidgetLayout;
data?: TData;
minimized?: boolean;
maximized?: boolean;
locked?: boolean;
movable?: boolean;
resizable?: boolean;
lazyLoad?: boolean;
sizeToContent?: boolean | number;
resizeToContentParent?: string;
};dist/core/types.d.ts:60
id: DashboardWidgetId;dist/core/types.d.ts:61title?: string;dist/core/types.d.ts:62layout: DashboardWidgetLayout;dist/core/types.d.ts:63data?: TData;dist/core/types.d.ts:64minimized?: boolean;dist/core/types.d.ts:65maximized?: boolean;dist/core/types.d.ts:66locked?: boolean;dist/core/types.d.ts:67movable?: boolean;dist/core/types.d.ts:68resizable?: boolean;dist/core/types.d.ts:69lazyLoad?: boolean;dist/core/types.d.ts:70sizeToContent?: boolean | number;dist/core/types.d.ts:71resizeToContentParent?: string;dist/core/types.d.ts:72export type DashboardWidgetTransferMode = "copy" | "move";dist/core/types.d.ts:74
export type DashboardWidgetTransferRejection = "duplicate-id" | "missing-widget" | "not-transferable" | "invalid-layout";dist/core/types.d.ts:75
export type DashboardLayoutSnapshot = {
columns: DashboardColumnCount;
widgets: DashboardWidgetLayout[];
};dist/core/types.d.ts:76
columns: DashboardColumnCount;dist/core/types.d.ts:77widgets: DashboardWidgetLayout[];dist/core/types.d.ts:78export type DashboardResponsiveOptions = {
columnWidth?: number;
columnMax?: DashboardColumnCount;
breakpoints?: ReadonlyArray<DashboardResponsiveBreakpoint>;
breakpointForWindow?: boolean;
layout?: DashboardColumnLayout;
};dist/core/types.d.ts:8
columnWidth?: number;dist/core/types.d.ts:9columnMax?: DashboardColumnCount;dist/core/types.d.ts:10breakpoints?: ReadonlyArray<DashboardResponsiveBreakpoint>;dist/core/types.d.ts:11breakpointForWindow?: boolean;dist/core/types.d.ts:12layout?: DashboardColumnLayout;dist/core/types.d.ts:13export type DashboardColumnLayoutSnapshot = {
widgets: DashboardWidgetLayout[];
previousLayouts: Record<DashboardWidgetId, DashboardWidgetLayout>;
};dist/core/types.d.ts:80
widgets: DashboardWidgetLayout[];dist/core/types.d.ts:81previousLayouts: Record<DashboardWidgetId, DashboardWidgetLayout>;dist/core/types.d.ts:82export type DashboardLayoutsByColumn = Partial<Record<DashboardColumnCount, DashboardColumnLayoutSnapshot>>;dist/core/types.d.ts:84
export type DashboardStateSnapshot<TData = unknown> = {
columns: DashboardColumnCount;
widgets: DashboardWidget<TData>[];
previousLayouts: Record<DashboardWidgetId, DashboardWidgetLayout>;
layoutsByColumn: DashboardLayoutsByColumn;
};dist/core/types.d.ts:85
columns: DashboardColumnCount;dist/core/types.d.ts:86widgets: DashboardWidget<TData>[];dist/core/types.d.ts:87previousLayouts: Record<DashboardWidgetId, DashboardWidgetLayout>;dist/core/types.d.ts:88layoutsByColumn: DashboardLayoutsByColumn;dist/core/types.d.ts:89export type DashboardStateSnapshotInput<TData = unknown> = {
columns: number;
widgets: DashboardWidget<TData>[];
previousLayouts?: Record<DashboardWidgetId, DashboardWidgetLayout>;
layoutsByColumn?: DashboardLayoutsByColumn;
};dist/core/types.d.ts:91
columns: number;dist/core/types.d.ts:92widgets: DashboardWidget<TData>[];dist/core/types.d.ts:93previousLayouts?: Record<DashboardWidgetId, DashboardWidgetLayout>;dist/core/types.d.ts:94layoutsByColumn?: DashboardLayoutsByColumn;dist/core/types.d.ts:95export type DashboardInteractionOptions = {
editable?: boolean;
movable?: boolean;
resizable?: boolean;
};dist/core/types.d.ts:97
editable?: boolean;dist/core/types.d.ts:98movable?: boolean;dist/core/types.d.ts:99resizable?: boolean;dist/core/types.d.ts:100export declare function transferDashboardWidget<TData>(input: DashboardWidgetTransferInput<TData>): DashboardWidgetTransferResult<TData>;dist/core/widget-transfer.d.ts:2
export interface DashboardGridHandle {
getGridStack(): GridStack | null;
getColumnCount(): number | null;
getRowCount(): number | null;
getFloat(): boolean | null;
isAreaEmpty(layout: Omit<DashboardWidgetLayout, "id">): boolean | null;
willItFit(layout: Omit<DashboardWidgetLayout, "id">): boolean | null;
refresh(): void;
compact(layout?: CompactOptions, doSort?: boolean): DashboardLayoutSnapshot | null;
commitLayout(): DashboardLayoutSnapshot | null;
}dist/gridstack/adapter.d.ts:39
getGridStack(): GridStack | null;dist/gridstack/adapter.d.ts:40getColumnCount(): number | null;dist/gridstack/adapter.d.ts:41getRowCount(): number | null;dist/gridstack/adapter.d.ts:42getFloat(): boolean | null;dist/gridstack/adapter.d.ts:43isAreaEmpty(layout: Omit<DashboardWidgetLayout, "id">): boolean | null;dist/gridstack/adapter.d.ts:44willItFit(layout: Omit<DashboardWidgetLayout, "id">): boolean | null;dist/gridstack/adapter.d.ts:45refresh(): void;dist/gridstack/adapter.d.ts:46compact(layout?: CompactOptions, doSort?: boolean): DashboardLayoutSnapshot | null;dist/gridstack/adapter.d.ts:47commitLayout(): DashboardLayoutSnapshot | null;dist/gridstack/adapter.d.ts:48export type DashboardGridAdapterOptionOverrides = {
acceptWidgets?: GridStackOptions["acceptWidgets"];
};dist/gridstack/option-mapper.d.ts:17
acceptWidgets?: GridStackOptions["acceptWidgets"];dist/gridstack/option-mapper.d.ts:18export declare function mapDashboardGridOptions(options?: DashboardGridOptionInput,
/**
* @deprecated Adapter-owned bridge. Consumers should configure
* DashboardGrid.acceptExternalWidgets. Planned for removal in 0.3.0.
*/
adapterOverrides?: DashboardGridAdapterOptionOverrides): GridStackOptions;dist/gridstack/option-mapper.d.ts:20
export declare function mapDashboardWidgetOptions<TData>(widget: DashboardWidget<TData>, options: DashboardGridOptionInput): Pick<GridStackWidget, "locked" | "noMove" | "noResize" | "lazyLoad" | "sizeToContent" | "resizeToContentParent">;dist/gridstack/option-mapper.d.ts:26
export type DashboardGridOptionInput = DashboardInteractionOptions & {
columns?: number;
engineOptions?: DashboardGridEngineOptions;
responsive?: DashboardResponsiveOptions;
/** @deprecated Use engineOptions.cellHeight. Planned for removal in 0.3.0. */
cellHeight?: GridStackOptions["cellHeight"];
/** @deprecated Use engineOptions.margin. Planned for removal in 0.3.0. */
margin?: GridStackOptions["margin"];
};dist/gridstack/option-mapper.d.ts:4
export declare function useDashboardGrid<TData = unknown>(options?: UseDashboardGridOptions<TData>): UseDashboardGridResult<TData>;dist/react/use-dashboard-grid.d.ts:11
export type UseDashboardGridResult<TData = unknown> = {
state: DashboardLayoutState<TData>;
widgets: DashboardWidget<TData>[];
columns: DashboardLayoutState<TData>["columns"];
refreshVersion: number;
commands: DashboardGridCommands<TData>;
};dist/react/use-dashboard-grid.d.ts:4
state: DashboardLayoutState<TData>;dist/react/use-dashboard-grid.d.ts:5widgets: DashboardWidget<TData>[];dist/react/use-dashboard-grid.d.ts:6columns: DashboardLayoutState<TData>["columns"];dist/react/use-dashboard-grid.d.ts:7refreshVersion: number;dist/react/use-dashboard-grid.d.ts:8commands: DashboardGridCommands<TData>;dist/react/use-dashboard-grid.d.ts:9export type DashboardWidgetActionLabels = {
/** @deprecated No default maximize button is rendered. */
maximize: string;
/** @deprecated No default minimize button is rendered. */
minimize: string;
restore: string;
remove: string;
};dist/ui/widget-actions.d.ts:1
maximize: string;dist/ui/widget-actions.d.ts:3minimize: string;dist/ui/widget-actions.d.ts:5restore: string;dist/ui/widget-actions.d.ts:6remove: string;dist/ui/widget-actions.d.ts:7__VLS_export: <TData = unknown>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
props: import("vue").PublicProps & __VLS_PrettifyLocal<DashboardGridProps<TData> & {
onMove?: ((event: DashboardWidgetInteractionEvent) => any) | undefined;
onResize?: ((event: DashboardWidgetInteractionEvent) => any) | undefined;
onBeforeTitleDoubleClick?: ((event: DashboardWidgetInteractionEvent) => any) | undefined;
onTitleDoubleClick?: ((event: DashboardWidgetInteractionEvent) => any) | undefined;
onAfterTitleDoubleClick?: ((event: DashboardWidgetInteractionEvent) => any) | undefined;
onColumnsChange?: ((columns: DashboardColumnCount) => any) | undefined;
onLayoutCommit?: ((snapshot: DashboardLayoutSnapshot) => any) | undefined;
onWidgetLayoutChange?: ((id: string, layout: DashboardWidgetLayout) => any) | undefined;
onWidgetResizeFrame?: ((event: DashboardWidgetResizeFrameEvent) => any) | undefined;
onWidgetExternalDrop?: ((event: DashboardWidgetExternalDropEvent) => any) | undefined;
onWidgetDropRequest?: ((request: DashboardWidgetDropRequest<TData>) => any) | undefined;
onBeforeMove?: ((event: DashboardWidgetInteractionEvent) => any) | undefined;
onAfterMove?: ((event: DashboardWidgetInteractionEvent) => any) | undefined;
onBeforeResize?: ((event: DashboardWidgetInteractionEvent) => any) | undefined;
onAfterResize?: ((event: DashboardWidgetInteractionEvent) => any) | undefined;
onMaximizeWidget?: ((id: string) => any) | undefined;
onMinimizeWidget?: ((id: string) => any) | undefined;
onRestoreWidget?: ((id: string) => any) | undefined;
onRemoveWidget?: ((id: string) => any) | undefined;
}> & (typeof globalThis extends {
__VLS_PROPS_FALLBACK: infer P;
} ? P : {});
expose: (exposed: import("vue").ShallowUnwrapRef<DashboardGridHandle>) => void;
attrs: any;
slots: {
default?(props: {
widget: DashboardWidget<TData>;
}): unknown;
actions?(props: {
widget: DashboardWidget<TData>;
}): unknown;
};
emit: ((evt: "move", event: DashboardWidgetInteractionEvent) => void) & ((evt: "resize", event: DashboardWidgetInteractionEvent) => void) & ((evt: "beforeTitleDoubleClick", event: DashboardWidgetInteractionEvent) => void) & ((evt: "titleDoubleClick", event: DashboardWidgetInteractionEvent) => void) & ((evt: "afterTitleDoubleClick", event: DashboardWidgetInteractionEvent) => void) & ((evt: "columnsChange", columns: DashboardColumnCount) => void) & ((evt: "layoutCommit", snapshot: DashboardLayoutSnapshot) => void) & ((evt: "widgetLayoutChange", id: string, layout: DashboardWidgetLayout) => void) & ((evt: "widgetResizeFrame", event: DashboardWidgetResizeFrameEvent) => void) & ((evt: "widgetExternalDrop", event: DashboardWidgetExternalDropEvent) => void) & ((evt: "widgetDropRequest", request: DashboardWidgetDropRequest<TData>) => void) & ((evt: "beforeMove", event: DashboardWidgetInteractionEvent) => void) & ((evt: "afterMove", event: DashboardWidgetInteractionEvent) => void) & ((evt: "beforeResize", event: DashboardWidgetInteractionEvent) => void) & ((evt: "afterResize", event: DashboardWidgetInteractionEvent) => void) & ((evt: "maximizeWidget", id: string) => void) & ((evt: "minimizeWidget", id: string) => void) & ((evt: "restoreWidget", id: string) => void) & ((evt: "removeWidget", id: string) => void);
}>) => import("vue").VNode & {
__ctx?: NonNullable<Awaited<typeof __VLS_setup>>;
}dist/vue/DashboardGrid.vue.d.ts:4
_default: typeof __VLS_exportdist/vue/DashboardGrid.vue.d.ts:42
type __VLS_PrettifyLocal<T> = (T extends any ? {
[K in keyof T]: T[K];
} : {
[K in keyof T as K]: T[K];
}) & {};dist/vue/DashboardGrid.vue.d.ts:44
_default: typeof __VLS_exportdist/vue/DashboardWidgetShell.vue.d.ts:29
__VLS_export: <TData = unknown>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
props: import("vue").PublicProps & __VLS_PrettifyLocal<DashboardWidgetShellProps<TData> & {
onRemove?: ((id: string) => any) | undefined;
onMaximize?: ((id: string) => any) | undefined;
onMinimize?: ((id: string) => any) | undefined;
onRestore?: ((id: string) => any) | undefined;
onBeforeTitleDoubleClick?: ((event: DashboardWidgetInteractionEvent) => any) | undefined;
onTitleDoubleClick?: ((event: DashboardWidgetInteractionEvent) => any) | undefined;
onAfterTitleDoubleClick?: ((event: DashboardWidgetInteractionEvent) => any) | undefined;
}> & (typeof globalThis extends {
__VLS_PROPS_FALLBACK: infer P;
} ? P : {});
expose: (exposed: {}) => void;
attrs: any;
slots: {
default?(props: {
widget: DashboardWidget<TData>;
}): unknown;
actions?(props: {
widget: DashboardWidget<TData>;
}): unknown;
};
emit: ((evt: "remove", id: string) => void) & ((evt: "maximize", id: string) => void) & ((evt: "minimize", id: string) => void) & ((evt: "restore", id: string) => void) & ((evt: "beforeTitleDoubleClick", event: DashboardWidgetInteractionEvent) => void) & ((evt: "titleDoubleClick", event: DashboardWidgetInteractionEvent) => void) & ((evt: "afterTitleDoubleClick", event: DashboardWidgetInteractionEvent) => void);
}>) => import("vue").VNode & {
__ctx?: NonNullable<Awaited<typeof __VLS_setup>>;
}dist/vue/DashboardWidgetShell.vue.d.ts:3
type __VLS_PrettifyLocal<T> = (T extends any ? {
[K in keyof T]: T[K];
} : {
[K in keyof T as K]: T[K];
}) & {};dist/vue/DashboardWidgetShell.vue.d.ts:31
export type DashboardGridEmits<TData = unknown> = {
columnsChange: [columns: DashboardColumnCount];
layoutCommit: [snapshot: DashboardLayoutSnapshot];
widgetLayoutChange: [id: string, layout: DashboardWidgetLayout];
widgetResizeFrame: [event: DashboardWidgetResizeFrameEvent];
widgetExternalDrop: [event: DashboardWidgetExternalDropEvent];
widgetDropRequest: [request: DashboardWidgetDropRequest<TData>];
beforeMove: [event: DashboardWidgetInteractionEvent];
move: [event: DashboardWidgetInteractionEvent];
afterMove: [event: DashboardWidgetInteractionEvent];
beforeResize: [event: DashboardWidgetInteractionEvent];
resize: [event: DashboardWidgetInteractionEvent];
afterResize: [event: DashboardWidgetInteractionEvent];
beforeTitleDoubleClick: [event: DashboardWidgetInteractionEvent];
titleDoubleClick: [event: DashboardWidgetInteractionEvent];
afterTitleDoubleClick: [event: DashboardWidgetInteractionEvent];
/** @deprecated Use a custom action calling resizeWidget. */
maximizeWidget: [id: string];
/** @deprecated Use a custom action calling resizeWidget. */
minimizeWidget: [id: string];
restoreWidget: [id: string];
removeWidget: [id: string];
};dist/vue/types.d.ts:25
columnsChange: [columns: DashboardColumnCount];dist/vue/types.d.ts:26layoutCommit: [snapshot: DashboardLayoutSnapshot];dist/vue/types.d.ts:27widgetLayoutChange: [id: string, layout: DashboardWidgetLayout];dist/vue/types.d.ts:28widgetResizeFrame: [event: DashboardWidgetResizeFrameEvent];dist/vue/types.d.ts:29widgetExternalDrop: [event: DashboardWidgetExternalDropEvent];dist/vue/types.d.ts:30widgetDropRequest: [request: DashboardWidgetDropRequest<TData>];dist/vue/types.d.ts:31beforeMove: [event: DashboardWidgetInteractionEvent];dist/vue/types.d.ts:32move: [event: DashboardWidgetInteractionEvent];dist/vue/types.d.ts:33afterMove: [event: DashboardWidgetInteractionEvent];dist/vue/types.d.ts:34beforeResize: [event: DashboardWidgetInteractionEvent];dist/vue/types.d.ts:35resize: [event: DashboardWidgetInteractionEvent];dist/vue/types.d.ts:36afterResize: [event: DashboardWidgetInteractionEvent];dist/vue/types.d.ts:37beforeTitleDoubleClick: [event: DashboardWidgetInteractionEvent];dist/vue/types.d.ts:38titleDoubleClick: [event: DashboardWidgetInteractionEvent];dist/vue/types.d.ts:39afterTitleDoubleClick: [event: DashboardWidgetInteractionEvent];dist/vue/types.d.ts:40maximizeWidget: [id: string];dist/vue/types.d.ts:42minimizeWidget: [id: string];dist/vue/types.d.ts:44restoreWidget: [id: string];dist/vue/types.d.ts:45removeWidget: [id: string];dist/vue/types.d.ts:46export type DashboardWidgetShellProps<TData = unknown> = {
widget: DashboardWidget<TData>;
showControls?: boolean;
labels?: DashboardWidgetActionLabels;
};dist/vue/types.d.ts:48
widget: DashboardWidget<TData>;dist/vue/types.d.ts:49showControls?: boolean;dist/vue/types.d.ts:50labels?: DashboardWidgetActionLabels;dist/vue/types.d.ts:51export type DashboardWidgetShellEmits = {
/** @deprecated Use a custom action calling resizeWidget. */
maximize: [id: string];
/** @deprecated Use a custom action calling resizeWidget. */
minimize: [id: string];
restore: [id: string];
remove: [id: string];
beforeTitleDoubleClick: [event: DashboardWidgetInteractionEvent];
titleDoubleClick: [event: DashboardWidgetInteractionEvent];
afterTitleDoubleClick: [event: DashboardWidgetInteractionEvent];
};dist/vue/types.d.ts:53
maximize: [id: string];dist/vue/types.d.ts:55minimize: [id: string];dist/vue/types.d.ts:57restore: [id: string];dist/vue/types.d.ts:58remove: [id: string];dist/vue/types.d.ts:59beforeTitleDoubleClick: [event: DashboardWidgetInteractionEvent];dist/vue/types.d.ts:60titleDoubleClick: [event: DashboardWidgetInteractionEvent];dist/vue/types.d.ts:61afterTitleDoubleClick: [event: DashboardWidgetInteractionEvent];dist/vue/types.d.ts:62export type DashboardGridProps<TData = unknown> = {
widgets: DashboardWidget<TData>[];
columns?: DashboardColumnCount;
editable?: boolean;
movable?: boolean;
resizable?: boolean;
engineOptions?: DashboardGridEngineOptions;
responsive?: DashboardResponsiveOptions;
externalDropTargets?: ReadonlyArray<DashboardExternalDropTarget>;
gridId?: string;
acceptExternalWidgets?: boolean | ((candidate: DashboardWidgetDropCandidate<TData>) => boolean);
gridTransferMode?: DashboardWidgetTransferMode;
refreshKey?: number;
showControls?: boolean;
/** Default title double-click fills the current row's unused columns. */
titleDoubleClickAction?: 'fill' | 'none';
lazyRenderWidget?: boolean;
actionLabels?: Partial<DashboardWidgetActionLabels>;
};dist/vue/types.d.ts:6
widgets: DashboardWidget<TData>[];dist/vue/types.d.ts:7columns?: DashboardColumnCount;dist/vue/types.d.ts:8editable?: boolean;dist/vue/types.d.ts:9movable?: boolean;dist/vue/types.d.ts:10resizable?: boolean;dist/vue/types.d.ts:11engineOptions?: DashboardGridEngineOptions;dist/vue/types.d.ts:12responsive?: DashboardResponsiveOptions;dist/vue/types.d.ts:13externalDropTargets?: ReadonlyArray<DashboardExternalDropTarget>;dist/vue/types.d.ts:14gridId?: string;dist/vue/types.d.ts:15acceptExternalWidgets?: boolean | ((candidate: DashboardWidgetDropCandidate<TData>) => boolean);dist/vue/types.d.ts:16gridTransferMode?: DashboardWidgetTransferMode;dist/vue/types.d.ts:17refreshKey?: number;dist/vue/types.d.ts:18showControls?: boolean;dist/vue/types.d.ts:19titleDoubleClickAction?: 'fill' | 'none';dist/vue/types.d.ts:21lazyRenderWidget?: boolean;dist/vue/types.d.ts:22actionLabels?: Partial<DashboardWidgetActionLabels>;dist/vue/types.d.ts:23export type UseDashboardGridResult<TData = unknown> = {
state: ComputedRef<DashboardLayoutState<TData>>;
widgets: ComputedRef<DashboardWidget<TData>[]>;
columns: ComputedRef<DashboardLayoutState<TData>["columns"]>;
refreshVersion: ComputedRef<number>;
commands: DashboardGridCommands<TData>;
};dist/vue/types.d.ts:64
state: ComputedRef<DashboardLayoutState<TData>>;dist/vue/types.d.ts:65widgets: ComputedRef<DashboardWidget<TData>[]>;dist/vue/types.d.ts:66columns: ComputedRef<DashboardLayoutState<TData>["columns"]>;dist/vue/types.d.ts:67refreshVersion: ComputedRef<number>;dist/vue/types.d.ts:68commands: DashboardGridCommands<TData>;dist/vue/types.d.ts:69export declare function useDashboardDragIn<TData>(options: MaybeRefOrGetter<UseDashboardDragInOptions<TData>>): ShallowRef<HTMLElement | null>;dist/vue/use-dashboard-drag-in.d.ts:3
export declare function useDashboardGrid<TData = unknown>(options?: MaybeRefOrGetter<UseDashboardGridOptions<TData>>): UseDashboardGridResult<TData>;dist/vue/use-dashboard-grid.d.ts:4
CSS custom properties from the package’s public stylesheet.
comins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.csscomins-grid-layout/styles.cssNo matching entries.