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.

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

import React, { type JSX, type PropsWithChildren, useEffect } from "react";
import {
  Keyboard,
  Navigation,
  Pagination,
  Virtual,
  Zoom,
} from "swiper/modules";
import { Swiper, type SwiperRef, SwiperSlide } from "swiper/react";
import { Button } from "@/components/ui/button";
import { useEventListener } from "@/hooks/useEventListener";
import { useIframeCapabilities } from "@/hooks/useIframeCapabilities";
import { cn } from "@/utils/cn";

import "./swiper-slides.css";
import "./slides.css";

interface SlidesComponentProps {
  className?: string;
  forceKeyboardNavigation?: boolean;
  index?: string | null;
  height?: string | number | null;
  wrapAround?: boolean;
  activeIndex?: number | null;
  onActiveIndexChange?: (index: number) => void;
}

const SlidesComponent = ({
  className,
  children,
  height,
  forceKeyboardNavigation = false,
  wrapAround = false,
  activeIndex,
  onActiveIndexChange,
}: PropsWithChildren<SlidesComponentProps>): JSX.Element => {
  const el = React.useRef<SwiperRef>(null);
  const [isFullscreen, setIsFullscreen] = React.useState(false);
  const { hasFullscreen } = useIframeCapabilities();

  useEffect(() => {
    if (activeIndex != null && el.current?.swiper.realIndex !== activeIndex) {
      if (wrapAround) {
        el.current?.swiper.slideToLoop(activeIndex);
      } else {
        el.current?.swiper.slideTo(activeIndex);
      }
    }
  }, [activeIndex, wrapAround]);

  useEventListener(document, "fullscreenchange", () => {
    if (document.fullscreenElement) {
      el.current?.swiper.keyboard.enable();
    } else {
      el.current?.swiper.keyboard.disable();
    }
    setIsFullscreen(!!document.fullscreenElement);
  });

  useEffect(() => {
    requestAnimationFrame(() => {
      window.dispatchEvent(new Event("resize"));
    });
  }, [isFullscreen]);

  const modules = wrapAround // virtual is incompatible with loop
    ? [Keyboard, Pagination, Zoom, Navigation]
    : [Virtual, Keyboard, Pagination, Zoom, Navigation];

  return (
    <Swiper
      ref={el}
      className={cn(
        "relative w-full border rounded bg-background mo-slides-theme prose-slides",
        className,
      )}
      spaceBetween={50}
      style={{
        height: isFullscreen ? "100%" : height || "650px",
      }}
      slidesPerView={1}
      modules={modules}
      zoom={{
        maxRatio: 5,
      }}
      // touch controls interfere with UI elements
      simulateTouch={false}
      keyboard={{
        // Only enable keyboard controls when in fullscreen
        enabled: isFullscreen || forceKeyboardNavigation,
      }}
      navigation={true}
      pagination={{
        clickable: true,
      }}
      virtual={!wrapAround} // virtual is incompatible with loop, turn off if loop is on
      // Instant swipes, which make sequences of slides
      // that overlay content more legible
      speed={1}
      loop={wrapAround}
      onSlideChange={(swiper) => onActiveIndexChange?.(swiper.realIndex)}
    >
      {React.Children.map(children, (child, index) => {
        if (child == null) {
          return null;
        }
        return (
          <SwiperSlide key={index}>
            <div
              onKeyDown={(e) => {
                // If the target is from a marimo element, stop propagation
                if (
                  e.target instanceof HTMLElement &&
                  e.target.tagName.toLocaleLowerCase().startsWith("marimo-")
                ) {
                  e.stopPropagation();
                }
              }}
              className={cn(
                "h-full w-full flex box-border overflow-y-auto overflow-x-hidden",
                isFullscreen ? "p-20" : "p-6 pb-12",
              )}
            >
              <div className="mo-slide-content">{child}</div>
            </div>
          </SwiperSlide>
        );
      })}
      {hasFullscreen && (
        <Button
          variant="link"
          size="sm"
          data-testid="marimo-plugin-slides-fullscreen"
          onClick={async () => {
            if (!el.current) {
              return;
            }
            const domEl = el.current as unknown as HTMLElement;

            if (document.fullscreenElement) {
              await document.exitFullscreen();
              setIsFullscreen(false);
            } else {
              await domEl.requestFullscreen();
              setIsFullscreen(true);
            }
          }}
          className="absolute bottom-0 right-0 z-10 mx-1 mb-0"
        >
          {isFullscreen ? "Exit Fullscreen" : "Fullscreen"}
        </Button>
      )}
    </Swiper>
  );
};

export default SlidesComponent;