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.

14.1 KB
Raw Blame
/* Copyright 2026 Marimo. All rights reserved. */
"use no memo";

import type { Table } from "@tanstack/react-table";
import { useVirtualizer } from "@tanstack/react-virtual";
import {
  ChevronDown,
  ChevronLeft,
  ChevronRight,
  ChevronsLeft,
  ChevronsRight,
} from "lucide-react";
import React from "react";
import { useLocale } from "react-aria";
import { Button } from "@/components/ui/button";
import {
  Command,
  CommandEmpty,
  CommandInput,
  CommandItem,
  CommandList,
} from "@/components/ui/command";
import {
  DropdownMenu,
  DropdownMenuContent,
  DropdownMenuItem,
  DropdownMenuLabel,
  DropdownMenuTrigger,
} from "@/components/ui/dropdown-menu";
import {
  Popover,
  PopoverContent,
  PopoverTrigger,
} from "@/components/ui/popover";
import { Tooltip } from "@/components/ui/tooltip";
import { cn } from "@/utils/cn";
import { Events } from "@/utils/events";
import { prettyNumber } from "@/utils/numbers";
import { PluralWord } from "@/utils/pluralize";

interface DataTablePaginationProps<TData> {
  table: Table<TData>;
  tableLoading?: boolean;
  hasNextPage?: boolean;
  showPageSizeSelector?: boolean;
}

export const DataTablePagination = <TData,>({
  table,
  tableLoading,
  hasNextPage,
  showPageSizeSelector,
}: DataTablePaginationProps<TData>) => {
  const { locale } = useLocale();

  const totalPages = table.getPageCount();
  const hasKnownTotal = totalPages !== -1;
  const pageNumber = table.getState().pagination.pageIndex + 1;
  const currentPage = hasKnownTotal
    ? Math.min(pageNumber, totalPages)
    : pageNumber;

  const pageSize = table.getState().pagination.pageSize;

  const handlePageChange = (pageChangeFn: () => void) => {
    // Frequent page changes can reset the page index, so we wait until the previous change has completed
    if (!tableLoading) {
      pageChangeFn();
    }
  };

  // Ensure unique page sizes
  const pageSizeSet = new Set([5, 10, 25, 50, 100, pageSize]);
  const pageSizes = [...pageSizeSet].toSorted((a, b) => a - b);

  const renderPageSizeSelector = () => {
    return (
      <div className="flex items-center text-xs whitespace-nowrap mr-1 print:hidden">
        <DropdownMenu>
          <DropdownMenuTrigger asChild={true}>
            <button
              type="button"
              className="border rounded justify-between pl-1.5 pr-0.5 h-6 text-xs items-center hover:bg-accent inline-flex gap-0.5"
            >
              {pageSize} / page
              <ChevronDown className="h-3 w-3 opacity-50 mb-px" />
            </button>
          </DropdownMenuTrigger>
          <DropdownMenuContent align="center" sideOffset={6}>
            <DropdownMenuLabel className="text-xs text-muted-foreground">
              Rows per page
            </DropdownMenuLabel>
            {[...pageSizes].map((size) => (
              <DropdownMenuItem
                key={size}
                className={cn(
                  "text-xs cursor-pointer",
                  size === pageSize && "font-semibold bg-accent",
                )}
                onSelect={() => table.setPageSize(size)}
                onMouseDown={Events.preventFocus}
              >
                {size}
              </DropdownMenuItem>
            ))}
          </DropdownMenuContent>
        </DropdownMenu>
      </div>
    );
  };

  return (
    <div className="flex flex-col lg:flex-row items-center gap-0.5 lg:gap-1 px-2">
      <div className="order-2 lg:order-first">
        {showPageSizeSelector && renderPageSizeSelector()}
      </div>
      <div className="order-1 lg:order-last flex items-center print:hidden">
        <Tooltip content="First page">
          <Button
            size="xs"
            variant="text"
            data-testid="first-page-button"
            aria-label="First page"
            className="hidden h-6 w-5 p-0 lg:flex"
            onClick={() => handlePageChange(() => table.setPageIndex(0))}
            onMouseDown={Events.preventFocus}
            disabled={!table.getCanPreviousPage()}
          >
            <ChevronsLeft className="h-4 w-4" />
          </Button>
        </Tooltip>
        <Tooltip content="Previous page">
          <Button
            size="xs"
            variant="text"
            data-testid="previous-page-button"
            aria-label="Previous page"
            className="h-6 w-5 p-0"
            onClick={() => handlePageChange(() => table.previousPage())}
            onMouseDown={Events.preventFocus}
            disabled={!table.getCanPreviousPage()}
          >
            <ChevronLeft className="h-4 w-4" />
          </Button>
        </Tooltip>
        <div className="flex items-center justify-center text-xs font-medium gap-1">
          <span>Page</span>
          {hasKnownTotal ? (
            <>
              <PageSelector
                currentPage={currentPage}
                totalPages={totalPages}
                onPageChange={(page) =>
                  handlePageChange(() => table.setPageIndex(page))
                }
              />
              <span className="shrink-0">
                of {prettyNumber(totalPages, locale)}
              </span>
            </>
          ) : (
            <span>{prettyNumber(currentPage, locale)}</span>
          )}
        </div>
        <Tooltip content="Next page">
          <Button
            size="xs"
            variant="text"
            data-testid="next-page-button"
            aria-label="Next page"
            className="h-6 w-5 p-0"
            onClick={() => handlePageChange(() => table.nextPage())}
            onMouseDown={Events.preventFocus}
            disabled={tableLoading || !(hasNextPage ?? table.getCanNextPage())}
          >
            <ChevronRight className="h-4 w-4" />
          </Button>
        </Tooltip>
        {hasKnownTotal && (
          <Tooltip content="Last page">
            <Button
              size="xs"
              variant="text"
              data-testid="last-page-button"
              aria-label="Last page"
              className="hidden h-6 w-5 p-0 lg:flex"
              onClick={() =>
                handlePageChange(() =>
                  table.setPageIndex(table.getPageCount() - 1),
                )
              }
              onMouseDown={Events.preventFocus}
              disabled={!table.getCanNextPage()}
            >
              <ChevronsRight className="h-4 w-4" />
            </Button>
          </Tooltip>
        )}
      </div>
    </div>
  );
};

const PAGE_ITEM_HEIGHT = 32;

/**
 * Compute contiguous ranges of page numbers whose string starts with `prefix`,
 * without scanning every page. O(log10(totalPages)).
 *
 * For prefix "5", totalPages=500: [[5,5], [50,59], [500,500]]
 */
export function matchingPageRanges(
  prefix: string,
  totalPages: number,
): [number, number][] {
  const n = Number.parseInt(prefix, 10);
  if (Number.isNaN(n) || n <= 0 || String(n) !== prefix) {
    return [];
  }

  const ranges: [number, number][] = [];
  let power = 1;
  while (n * power <= totalPages) {
    const start = n * power;
    const end = Math.min((n + 1) * power - 1, totalPages);
    ranges.push([start, end]);
    power *= 10;
  }
  return ranges;
}

interface PageMapping {
  count: number;
  pageAtIndex: (index: number) => number;
  indexOfPage: (page: number) => number;
}

function createPageMapping(search: string, totalPages: number): PageMapping {
  if (search === "") {
    return {
      count: totalPages,
      pageAtIndex: (i) => i + 1,
      indexOfPage: (p) => p - 1,
    };
  }

  const ranges = matchingPageRanges(search, totalPages);
  let count = 0;
  for (const [s, e] of ranges) {
    count += e - s + 1;
  }

  return {
    count,
    pageAtIndex: (i) => {
      let offset = 0;
      for (const [start, end] of ranges) {
        const size = end - start + 1;
        if (i < offset + size) {
          return start + (i - offset);
        }
        offset += size;
      }
      return -1;
    },
    indexOfPage: (p) => {
      let offset = 0;
      for (const [start, end] of ranges) {
        if (p >= start && p <= end) {
          return offset + (p - start);
        }
        offset += end - start + 1;
      }
      return -1;
    },
  };
}

export const PageSelector = ({
  currentPage,
  totalPages,
  onPageChange,
}: {
  currentPage: number;
  totalPages: number;
  onPageChange: (page: number) => void;
}) => {
  const [open, setOpen] = React.useState(false);
  const [search, setSearch] = React.useState("");

  const mapping = React.useMemo(
    () => createPageMapping(search, totalPages),
    [search, totalPages],
  );

  const handleSelect = (page: number) => {
    onPageChange(page - 1);
    setSearch("");
    setOpen(false);
  };

  const listHeight = Math.min(mapping.count * PAGE_ITEM_HEIGHT, 240);

  return (
    <Popover
      open={totalPages > 1 ? open : false}
      onOpenChange={(next) => {
        setOpen(next);
        if (!next) {
          setSearch("");
        }
      }}
    >
      <PopoverTrigger asChild={true} disabled={totalPages <= 1}>
        <button
          type="button"
          className={cn(
            "border rounded justify-between pl-1.5 pr-0.5 h-6 min-w-9 text-xs items-center inline-flex gap-0.5",
            totalPages > 1
              ? "hover:bg-accent cursor-pointer"
              : "opacity-50 cursor-default",
          )}
          data-testid="page-select"
          aria-label={`Choose page, current page ${currentPage} of ${totalPages}`}
          disabled={totalPages <= 1}
        >
          {currentPage}
          <ChevronDown className="h-3 w-3 opacity-50 mb-px" />
        </button>
      </PopoverTrigger>
      <PopoverContent
        className="w-36 p-0"
        align="center"
        sideOffset={6}
        aria-label="Choose page"
      >
        <Command
          label="Search pages"
          shouldFilter={false}
          value={String(currentPage)}
        >
          <CommandInput
            placeholder={`Page (1–${totalPages})`}
            rootClassName="px-2 h-8"
            className="text-xs h-8"
            autoFocus={true}
            icon={null}
            value={search}
            onValueChange={setSearch}
            onKeyDown={(e) => {
              // Allow navigation/editing keys, block non-numeric input
              const allowed = [
                "Backspace",
                "Delete",
                "ArrowLeft",
                "ArrowRight",
                "ArrowUp",
                "ArrowDown",
                "Tab",
                "Enter",
                "Escape",
              ];
              if (!allowed.includes(e.key) && !/^\d$/.test(e.key)) {
                e.preventDefault();
              }
            }}
          />
          <CommandList className="max-h-60 overflow-hidden">
            {mapping.count === 0 ? (
              <CommandEmpty className="py-2 text-center text-xs text-muted-foreground">
                No matching page
              </CommandEmpty>
            ) : (
              <VirtualizedPageList
                mapping={mapping}
                currentPage={currentPage}
                listHeight={listHeight}
                onSelect={handleSelect}
              />
            )}
          </CommandList>
        </Command>
      </PopoverContent>
    </Popover>
  );
};

const VirtualizedPageList = ({
  mapping,
  currentPage,
  listHeight,
  onSelect,
}: {
  mapping: PageMapping;
  currentPage: number;
  listHeight: number;
  onSelect: (page: number) => void;
}) => {
  const parentRef = React.useRef<HTMLDivElement>(null);

  const currentIndex = mapping.indexOfPage(currentPage);

  const virtualizer = useVirtualizer({
    count: mapping.count,
    getScrollElement: () => parentRef.current,
    estimateSize: () => PAGE_ITEM_HEIGHT,
    overscan: 10,
    initialOffset:
      currentIndex > 0
        ? Math.max(0, currentIndex * PAGE_ITEM_HEIGHT - listHeight / 2)
        : 0,
  });

  // Scroll to top when filtered results change (user is searching)
  const prevCount = React.useRef(mapping.count);
  React.useEffect(() => {
    if (mapping.count !== prevCount.current) {
      virtualizer.scrollToIndex(0);
      prevCount.current = mapping.count;
    }
  }, [mapping.count, virtualizer]);

  return (
    <div ref={parentRef} style={{ height: listHeight, overflow: "auto" }}>
      <div
        style={{
          height: virtualizer.getTotalSize(),
          width: "100%",
          position: "relative",
        }}
      >
        {virtualizer.getVirtualItems().map((virtualItem) => {
          const page = mapping.pageAtIndex(virtualItem.index);
          return (
            <CommandItem
              key={page}
              value={String(page)}
              data-testid="page-option"
              aria-selected={page === currentPage}
              className={cn(
                "text-xs cursor-pointer",
                page === currentPage && "font-semibold bg-accent",
              )}
              style={{
                position: "absolute",
                top: 0,
                left: 0,
                width: "100%",
                height: virtualItem.size,
                transform: `translateY(${virtualItem.start}px)`,
              }}
              onSelect={() => onSelect(page)}
              onMouseDown={Events.preventFocus}
            >
              {page}
            </CommandItem>
          );
        })}
      </div>
    </div>
  );
};

export function prettifyRowCount(rowCount: number, locale: string): string {
  return `${prettyNumber(rowCount, locale)} ${new PluralWord("row").pluralize(rowCount)}`;
}

export const prettifyRowColumnCount = ({
  numRows,
  totalColumns,
  hiddenColumns,
  locale,
}: {
  numRows: number | "too_many";
  totalColumns: number;
  hiddenColumns?: number;
  locale: string;
}): { rowsAndColumns: string; hiddenSuffix: string | null } => {
  const rowsLabel =
    numRows === "too_many" ? "Unknown" : prettifyRowCount(numRows, locale);

  const hidden = hiddenColumns ?? 0;
  const visibleColumns = totalColumns - hidden;

  const columnsLabel =
    hidden > 0
      ? `${prettyNumber(visibleColumns, locale)} visible`
      : `${prettyNumber(totalColumns, locale)} ${new PluralWord("column").pluralize(totalColumns)}`;

  return {
    rowsAndColumns: [rowsLabel, columnsLabel].join(", "),
    hiddenSuffix:
      hidden > 0 ? `(${prettyNumber(hidden, locale)} hidden)` : null,
  };
};