Skip to content
MIZU.

HistoryControls

Undo and redo a bounded edit history, including the branch created by a new change.

View .md

Live — this one is real

Usage

tsx
"use client";

import { HistoryControls, useHistory, InlineEdit, Stack } from "mizu-ui";

export function Example() {
  const history = useHistory("First draft");
  return (
    <Stack gap={16}>
      <InlineEdit
        label="Draft name"
        value={history.value}
        onValueChange={history.set}
      />
      <HistoryControls
        canUndo={history.canUndo}
        canRedo={history.canRedo}
        onUndo={history.undo}
        onRedo={history.redo}
      />
    </Stack>
  );
}

It starts with "use client" because it keeps state or passes functions to components, so it pastes into a Next.js page as it is. Other React setups ignore the directive.

Source & setup

Add this component to your project with the shadcn CLI. The command copies its source into your configured UI directory, with base.css, Mizu’s tokens, and the stylesheets that hold its rules. Each rule lives in one stylesheet, so components you add together never repeat CSS. In a project without a components.json, run npx shadcn@latest init 0xuser64bit/mizu/preset first: plain init installs shadcn’s theme into your global CSS. Then load the fonts.

sh
npx shadcn@latest add 0xuser64bit/mizu/history-controls 0xuser64bit/mizu/inline-edit 0xuser64bit/mizu/stack

The example also uses InlineEdit and Stack, so the command adds them too.

Every component imports from its own path, its name in kebab case. To paste the example, replace its mizu-ui import with:

tsx
import { HistoryControls, useHistory } from "@/components/ui/mizu/history-controls";
import { InlineEdit } from "@/components/ui/mizu/inline-edit";
import { Stack } from "@/components/ui/mizu/stack";

For npm imports, import mizu-ui/styles.css once. Fonts are optional via mizu-ui/fonts.css. Override --mizu-* tokens or use className for local styling. Uses native React and CSS; install the package peers for root imports. A Client Component: its source starts with “use client”.

Inspect interaction/HistoryControls.tsx

Source is included in the npm package under src/interaction/HistoryControls.tsx.

Open full source ↗

Props

PropTypeDefaultDescription
useHistory(initial, limit?)hook—Value, set, undo, redo, reset and availability; bounded to 50 past entries by default.
canUndo / canRedoboolean—Availability from your history.
onUndo / onRedofunction—Actual history operations.

Accessibility

Named button group with explicit disabled boundaries. Store immutable values; Object.is suppresses unchanged edits. A new edit clears the redo branch.

Motion

State changes belong to the edited content.

Works alongside

ComboboxMultiSelectInlineEditRangeSelector