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.

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

import { AtSignIcon, GlobeIcon, LockIcon } from "lucide-react";
import { type JSX, useId, useRef, useState } from "react";
import { z } from "zod";
import {
  DebouncedInput,
  Input,
  OnBlurredInput,
} from "../../components/ui/input";
import { RANDOM_ID_ATTR } from "../../core/dom/ui-element-constants";
import { cn } from "../../utils/cn";
import type { IPlugin, IPluginProps, Setter } from "../types";
import { Labeled } from "./common/labeled";

type T = string;

type InputType = "text" | "password" | "email" | "url";

interface Data {
  placeholder: string;
  label: string | null;
  kind: InputType;
  maxLength?: number;
  minLength?: number;
  disabled?: boolean;
  debounce?: boolean | number;
  fullWidth: boolean;
  passwordHasValue?: boolean;
}

// Matches the masked dots.
const MASK_PLACEHOLDER = "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022";

export class TextInputPlugin implements IPlugin<T, Data> {
  public tagName = "marimo-text";

  public validator = z.object({
    initialValue: z.string(),
    placeholder: z.string(),
    label: z.string().nullable(),
    kind: z.enum(["text", "password", "email", "url"]).default("text"),
    maxLength: z.number().optional(),
    minLength: z.number().optional(),
    fullWidth: z.boolean().default(false),
    disabled: z.boolean().optional(),
    debounce: z.optional(z.union([z.boolean(), z.number()])),
    passwordHasValue: z.boolean().optional(),
  });

  public render(props: IPluginProps<T, Data>): JSX.Element {
    // Force remount on cell re-run so masked state resets cleanly
    const remountKey =
      props.data.kind === "password"
        ? props.host
            .closest(`[${RANDOM_ID_ATTR}]`)
            ?.getAttribute(RANDOM_ID_ATTR)
        : undefined;
    return (
      <TextComponent
        key={remountKey ?? undefined}
        {...props.data}
        value={props.value}
        setValue={props.setValue}
      />
    );
  }
}

interface TextComponentProps extends Data {
  value: T;
  setValue: Setter<T>;
}

const TextComponent = (props: TextComponentProps) => {
  const inputId = useId();
  // Before first real keystroke: show masked placeholder, suppress setValue.
  // After first keystroke: normal password field.
  const initiallyMasked =
    props.kind === "password" && props.passwordHasValue === true;
  const [masked, setMasked] = useState(initiallyMasked);
  const hasTyped = useRef(false);

  const value = masked ? "" : props.value;
  const placeholder = masked ? MASK_PLACEHOLDER : props.placeholder;
  const setValue: Setter<T> = masked
    ? (v) => {
        if (!hasTyped.current) {
          return;
        }
        setMasked(false);
        props.setValue(v);
      }
    : props.setValue;
  // Capture-phase handler sets the ref synchronously before child onChange
  const onInputCapture = masked
    ? () => {
        hasTyped.current = true;
      }
    : undefined;

  const [valueOnBlur, setValueOnBlur] = useState(props.value);
  const valueToValidate = valueOnBlur == null ? value : valueOnBlur;
  const isValid = validate(props.kind, valueToValidate);

  const icon: Record<InputType, JSX.Element | null> = {
    text: null,
    password: <LockIcon size={16} />,
    email: <AtSignIcon size={16} />,
    url: <GlobeIcon size={16} />,
  };

  const endAdornment = props.maxLength ? (
    <span className="text-muted-foreground text-xs font-medium">
      {value.length}/{props.maxLength}
    </span>
  ) : null;

  const inputClassName = cn({
    "border-destructive": !isValid,
    "w-full": props.fullWidth,
  });

  let input: JSX.Element;

  if (props.debounce === true) {
    input = (
      <OnBlurredInput
        id={inputId}
        data-testid="marimo-plugin-text-input"
        type={props.kind}
        icon={icon[props.kind]}
        placeholder={placeholder}
        maxLength={props.maxLength}
        minLength={props.minLength}
        required={props.minLength != null && props.minLength > 0}
        disabled={props.disabled}
        className={inputClassName}
        endAdornment={endAdornment}
        value={value}
        onValueChange={setValue}
        onInputCapture={onInputCapture}
      />
    );
  } else if (typeof props.debounce === "number") {
    input = (
      <DebouncedInput
        id={inputId}
        data-testid="marimo-plugin-text-input"
        type={props.kind}
        icon={icon[props.kind]}
        placeholder={placeholder}
        maxLength={props.maxLength}
        minLength={props.minLength}
        required={props.minLength != null && props.minLength > 0}
        disabled={props.disabled}
        className={inputClassName}
        endAdornment={endAdornment}
        value={value}
        onValueChange={setValue}
        onBlur={(event) => setValueOnBlur(event.currentTarget.value)}
        delay={props.debounce}
        onInputCapture={onInputCapture}
      />
    );
  } else {
    input = (
      <Input
        id={inputId}
        data-testid="marimo-plugin-text-input"
        type={props.kind}
        icon={icon[props.kind]}
        placeholder={placeholder}
        maxLength={props.maxLength}
        minLength={props.minLength}
        required={props.minLength != null && props.minLength > 0}
        disabled={props.disabled}
        className={inputClassName}
        endAdornment={endAdornment}
        value={value}
        onInput={(event) => setValue(event.currentTarget.value)}
        onBlur={(event) => setValueOnBlur(event.currentTarget.value)}
        onInputCapture={onInputCapture}
      />
    );
  }

  return (
    <Labeled
      controlId={inputId}
      label={props.label}
      fullWidth={props.fullWidth}
    >
      {input}
    </Labeled>
  );
};

function validate(kind: InputType, value: string): boolean {
  // We don't validate required-ness to empty is valid
  if (!value) {
    return true;
  }

  // We only validate email and url types
  switch (kind) {
    case "email":
      return z.string().email().safeParse(value).success;
    case "url":
      return z.string().url().safeParse(value).success;
    default:
      return true;
  }
}