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.5 KB
Raw Blame
/* Copyright 2026 Marimo. All rights reserved. */
import type { Extension } from "@codemirror/state";
import { EditorView, keymap, placeholder } from "@codemirror/view";
import { isEditorReadonly } from "../readonly/extension";

/**
 * A placeholder that will be shown when the editor is empty and support
 * auto-complete on right arrow or Tab.
 */
export function smartPlaceholderExtension(text: string): Extension[] {
  return [
    placeholder(text),
    keymap.of([
      {
        key: "ArrowRight",
        preventDefault: true,
        run: (cm) => acceptPlaceholder(cm, text),
      },
      {
        key: "Tab",
        preventDefault: true,
        run: (cm) => acceptPlaceholder(cm, text),
      },
    ]),
  ];
}

function acceptPlaceholder(cm: EditorView, text: string) {
  if (isEditorReadonly(cm.state)) {
    return false;
  }

  // if empty, insert the placeholder
  const docLength = cm.state.doc.length;
  if (docLength === 0) {
    cm.dispatch({
      changes: {
        from: 0,
        to: docLength,
        insert: text,
      },
      selection: {
        head: text.length,
        anchor: text.length,
      },
    });
    return true;
  }
  return false;
}

/**
 * Create a placeholder with a clickable link.
 */
export function clickablePlaceholderExtension(opts: {
  beforeText: string;
  linkText: string;
  afterText: string;
  onClick: (ev: EditorView) => void;
}): Extension[] {
  const { beforeText, linkText, afterText, onClick } = opts;

  // Create a placeholder
  // Needs to be a function to keep event listeners
  // See https://github.com/codemirror/dev/issues/1457
  const createPlaceholder = (ev: EditorView) => {
    const placeholderText = document.createElement("span");
    placeholderText.append(document.createTextNode(beforeText));
    const link = document.createElement("span");
    link.textContent = linkText;
    link.classList.add("cm-clickable-placeholder");
    link.onclick = (evt) => {
      evt.stopPropagation();
      onClick(ev);
    };
    placeholderText.append(link);
    placeholderText.append(document.createTextNode(afterText));
    return placeholderText;
  };

  return [
    placeholder(createPlaceholder),
    EditorView.theme({
      ".cm-placeholder": {
        color: "var(--slate-8)",
      },
      ".cm-clickable-placeholder": {
        cursor: "pointer !important",
        pointerEvents: "auto",
        color: "var(--slate-9)",
        textDecoration: "underline",
        textUnderlineOffset: "0.2em",
      },
      ".cm-clickable-placeholder:hover": {
        color: "var(--sky-11)",
      },
    }),
  ];
}