A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.
Python artificial-intelligencedagdata-sciencedata-visualizationdataflowdeveloper-toolsmachine-learningnotebookspipelinepythonreactivesqlweb-app
/* Copyright 2026 Marimo. All rights reserved. */
import { z } from "zod";
import type { CellId } from "@/core/cells/ids";
import { Logger } from "@/utils/Logger";
import { Maps } from "@/utils/maps";
import type { ICellRendererPlugin } from "../types";
import { GridLayoutRenderer } from "./grid-layout";
import type {
GridLayout,
GridLayoutCellSide,
SerializedGridLayout,
SerializedGridLayoutCell,
} from "./types";
/**
* Plugin definition for the grid layout.
*/
export const GridLayoutPlugin: ICellRendererPlugin<
SerializedGridLayout,
GridLayout
> = {
type: "grid",
name: "Grid",
validator: z.looseObject({
columns: z.number().min(1),
rowHeight: z.number().min(1),
maxWidth: z
.number()
.nullish()
.transform((value) => value ?? undefined)
.catch(undefined),
bordered: z.boolean().optional().catch(undefined),
cells: z.array(
z
.looseObject({
position: z
.tuple([z.number(), z.number(), z.number(), z.number()])
.nullable()
.catch(null),
scrollable: z.boolean().optional().catch(undefined),
side: z
.enum(["top", "bottom", "left", "right"])
.optional()
.catch(undefined),
})
.catch({ position: null }),
),
}),
deserializeLayout: (serialized, cells): GridLayout => {
if (serialized.cells.length === 0) {
return {
columns: serialized.columns,
rowHeight: serialized.rowHeight,
scrollableCells: new Set(),
cellSide: new Map(),
cells: [],
};
}
if (serialized.cells.length !== cells.length) {
Logger.warn(
"Number of cells in layout does not match number of cells in notebook",
);
}
const scrollableCells = new Set<CellId>();
const cellSide = new Map<CellId, GridLayoutCellSide>();
const cellLayouts = serialized.cells.flatMap((cellLayout, idx) => {
const position = cellLayout.position;
if (!position) {
return [];
}
const cell = cells[idx];
if (!cell) {
return [];
}
if (cellLayout.scrollable) {
scrollableCells.add(cell.id);
}
if (cellLayout.side) {
cellSide.set(cell.id, cellLayout.side);
}
return {
i: cell.id,
x: position[0],
y: position[1],
w: position[2],
h: position[3],
};
});
return {
// Grid config
columns: serialized.columns,
rowHeight: serialized.rowHeight,
maxWidth: serialized.maxWidth,
bordered: serialized.bordered,
// Cell config
cells: cellLayouts,
cellSide: cellSide,
scrollableCells: scrollableCells,
};
},
serializeLayout: (layout, cells): SerializedGridLayout => {
const layoutsByKey = Maps.keyBy(layout.cells, (cell) => cell.i);
const serializedCells: SerializedGridLayoutCell[] = cells.map((cell) => {
const cellLayout = layoutsByKey.get(cell.id);
if (!cellLayout) {
return {
position: null,
};
}
const out: SerializedGridLayoutCell = {
position: [cellLayout.x, cellLayout.y, cellLayout.w, cellLayout.h],
};
if (layout.scrollableCells.has(cell.id)) {
out.scrollable = true;
}
if (layout.cellSide.has(cell.id)) {
out.side = layout.cellSide.get(cell.id);
}
return out;
});
return {
// Grid config
columns: layout.columns,
rowHeight: layout.rowHeight,
maxWidth: layout.maxWidth,
bordered: layout.bordered,
// Cell config
cells: serializedCells,
};
},
Component: GridLayoutRenderer,
getInitialLayout: () => ({
// Grid config
columns: 24,
rowHeight: 20,
maxWidth: 1400,
bordered: true,
// Cell config
scrollableCells: new Set(),
cellSide: new Map(),
cells: [],
}),
};