Skip to content

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.

2.3 KB
Raw Blame
/* Copyright 2026 Marimo. All rights reserved. */

import { useIntersectionObserver } from "@uidotdev/usehooks";
import { Loader2Icon } from "lucide-react";
import type { JSX } from "react";
import { z } from "zod";
import { useAsyncData } from "@/hooks/useAsyncData";
import { createPlugin } from "@/plugins/core/builder";
import { rpc } from "@/plugins/core/rpc";
import { renderHTML } from "../core/RenderHTML";
import { ErrorBanner } from "../impl/common/error-banner";

interface Data {
  showLoadingIndicator: boolean;
}

// oxlint-disable-next-line typescript/consistent-type-definitions
type PluginFunctions = {
  load: (req: {}) => Promise<{
    html: string;
  }>;
};

// Whether it has been loaded
type S = boolean;

export const LazyPlugin = createPlugin<S>("marimo-lazy")
  .withData(
    z.object({
      showLoadingIndicator: z.boolean().default(false),
    }),
  )
  .withFunctions<PluginFunctions>({
    load: rpc.input(z.object({})).output(
      z.object({
        html: z.string(),
      }),
    ),
  })
  .renderer((props) => (
    <LazyComponent
      value={props.value}
      setValue={props.setValue}
      {...props.data}
      {...props.functions}
    />
  ));

interface Props extends PluginFunctions, Data {
  value: boolean;
  setValue: (value: S) => void;
}

const LazyComponent = ({
  load,
  showLoadingIndicator,
  value,
  setValue,
}: Props): JSX.Element => {
  const [ref, entry] = useIntersectionObserver({
    threshold: 0,
    root: null,
    rootMargin: "0px",
  });

  if (entry?.isIntersecting && !value) {
    setValue(true);
  }

  // For each re-render, we have to make a waterfall request
  // We could improve performance if the BE was able to know if the same
  // mo.lazy has already been loaded, and when re-rendering it would
  // include the 'lazy' content by default (unlazily)
  const { data, error, isPending } = useAsyncData(
    (ctx) => {
      if (!value) {
        ctx.previous();
        return Promise.resolve(undefined);
      }
      return load({});
    },
    [value],
  );

  if (error) {
    return <ErrorBanner error={error} />;
  }

  return (
    <div ref={ref} className="min-h-4">
      {isPending && showLoadingIndicator ? (
        <Loader2Icon className="w-12 h-12 animate-spin text-primary my-4 mx-4" />
      ) : (
        data && renderHTML({ html: data.html })
      )}
    </div>
  );
};