Stepper
Multi-step flow with an active ring that glides between step markers, connectors that fill as steps complete, panels that slide in from the direction of travel while the container morphs to each panel's height, and an async per-step guard that shakes the marker when it refuses. Linear or free navigation, controlled/uncontrolled, reduced-motion safe.
Preview
Install
Add it with the shadcn CLI, or copy the source manually.
shadcn init? You are set. Theme setupInstall dependencies
npm i clsx lucide-react motion tailwind-mergeAdd util files
// Shared motion tokens. Easing curves mirror the CSS custom properties in
// globals.css; springs are the canonical physics used across components.
// Strong custom variants — defaults like `ease-in`/`ease-out` feel weak.
export const EASE_OUT = [0.16, 1, 0.3, 1] as const;
export const EASE_IN_OUT = [0.77, 0, 0.175, 1] as const;
export const EASE_DRAWER = [0.32, 0.72, 0, 1] as const;
/** CSS string form of EASE_OUT for inline style transitions. */
export const EASE_OUT_CSS = "cubic-bezier(0.16, 1, 0.3, 1)";
/** Press feedback on buttons and other tappable surfaces. */
export const SPRING_PRESS = {
type: "spring",
stiffness: 500,
damping: 30,
mass: 0.6,
} as const;
/** Content swaps — label/icon slots trading places inside a control. */
export const SPRING_SWAP = {
type: "spring",
stiffness: 460,
damping: 30,
mass: 0.55,
} as const;
/** Overlay panel entrances — modals and sheets summoned by pointer. */
export const SPRING_PANEL = {
type: "spring",
stiffness: 420,
damping: 40,
mass: 0.5,
} as const;
/** Shared-layout glides — pills, indicators and panels morphing between positions. */
export const SPRING_LAYOUT = {
type: "spring",
stiffness: 360,
damping: 32,
mass: 0.6,
} as const;
/** Cursor-follow physics for decorative mouse tracking (magnetic, tilt, dock). */
export const SPRING_MOUSE = {
stiffness: 200,
damping: 15,
mass: 0.3,
} as const;
/** Dragged handles and fills (sliders) — critically damped `useSpring` config,
* so the value follows the pointer butterily and never rebounds off an end. */
export const SPRING_GLIDE = {
stiffness: 700,
damping: 50,
mass: 0.5,
} as const;
import { clsx, type ClassValue } from "clsx"
import { twMerge } from "tailwind-merge"
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs))
}
"use client";
import { useEffect, useState } from "react";
/**
* Returns true only on devices that have a true hover (mouse / trackpad).
* Touch devices fire phantom `:hover` on tap that sticks until tap-elsewhere
* — gate hover-only effects (scale lifts, magnetic pulls) behind this.
*/
export function useHoverCapable() {
const [canHover, setCanHover] = useState(false);
useEffect(() => {
if (typeof window === "undefined" || !window.matchMedia) return;
const mq = window.matchMedia("(hover: hover) and (pointer: fine)");
const update = () => setCanHover(mq.matches);
update();
mq.addEventListener?.("change", update);
return () => mq.removeEventListener?.("change", update);
}, []);
return canHover;
}
// Shared touch primitives. iOS and iPadOS run their own gestures on top of the
// page — the long-press selection callout and the selection it drags in with
// it — and they win: once the platform claims a touch it cancels ours
// mid-gesture, so a press-and-hold or a drag simply dies. Surfaces that own
// their gesture have to opt out.
//
// What the two classes below cover, precisely:
// - `-webkit-touch-callout: none` stops iOS's long-press callout. WebKit-only:
// it is not a property other engines have, so it is inert everywhere else.
// - `user-select: none` stops the long-press selection on every engine,
// Android included, and stops a drag from painting a selection under the
// cursor. It is inherited, so it reaches every descendant — which is why the
// two classes differ only in whether they apply it unconditionally.
// What neither covers:
// - Chrome for Android's long-press menu on a link or an image. No CSS
// suppresses it; a gesture surface that wraps one needs its own
// `onContextMenu` with `preventDefault()`.
// - The native drag of an `<img>` or `<a>` descendant. `-webkit-user-drag` is
// not inherited and plain divs and buttons are not drag sources, so setting
// it on the surface does nothing — the child itself needs `draggable={false}`.
/**
* Classes for a surface that *is* the control: a thumb, a drum, a stage, a
* handle, a hold button. Selection is suppressed on every input, because a
* drag that highlights the control's own label is wrong on a mouse too.
* Compose with `touch-none` when the surface also owns the scroll axis — leave
* it off when the page must still scroll from there.
*/
export const TOUCH_GESTURE_CLASS = "select-none [-webkit-touch-callout:none]";
/**
* The same opt-out for a gesture surface that wraps content the consumer owns:
* a scroller, a context-menu trigger, a sheet header, a list row. Selection is
* suppressed only where the platform runs its own press gestures — a coarse
* pointer — so a mouse user can still select and copy that content. If the
* gesture itself would paint a selection under the cursor, add `select-none`
* for the duration of the gesture rather than reaching for
* `TOUCH_GESTURE_CLASS`.
*
* `pointer: coarse` describes the *primary* pointer and nothing else, so a
* hybrid machine reads it wrong in both directions: a tablet with a mouse
* plugged in keeps touch as primary and loses mouse selection, and a laptop
* with a touchscreen keeps the mouse as primary and leaves selection live
* under a finger. No media query can answer per interaction — the query is
* about the device, and the question is about the gesture in progress. The
* default stays here because it is right on the machines that are one thing or
* the other, and losing a selection is a nuisance; where the miss costs a
* *gesture* instead, the surface pairs it with `holdSelection` on the press.
*/
export const TOUCH_GESTURE_CONTENT_CLASS =
"[-webkit-touch-callout:none] pointer-coarse:select-none";
/**
* Grow a small control's *hit area* to at least 44×44px (WCAG 2.5.5, Apple
* HIG) on a coarse pointer, without changing what it looks like or the space
* it takes in layout. An invisible `::after` box, centered on the control and
* `max(100%, 2.75rem)` on each axis, catches the taps: a 32px icon button
* reaches 6px past each edge, a wide 40px button only grows vertically, and a
* control already 44px or larger is left as it is. Hit-testing a pseudo
* element lands on its owner, so handlers, focus and `:active` all behave.
*
* Mouse and trackpad rendering is untouched — nothing here applies outside
* `pointer: coarse`. Requirements on the element it goes on:
* - It must be the containing block: add `relative` (and keep it mergeable, so
* a consumer's `absolute` still wins through `cn`).
* - It must not clip itself (`overflow-hidden`), or the overhang is clipped
* away along with its hit area.
* - It must render children: `<input>` and other void elements have no
* `::after`. Put it on the wrapper or label instead.
* - It must not already use `::after` for something visible.
*
* Centered 44px means two 32px buttons with a 4px gap overlap by 8px; the
* later one wins that strip, which still ends well short of the earlier
* button's visual center. Below a ~32px pitch the later neighbour starts
* eating into that center — use `TOUCH_TARGET_Y_CLASS` for such dense rows.
*
* The overhang is real geometry: inside a scroll container it counts as
* scrollable overflow, so a control flush against a scroller's edge can add a
* few pixels of scroll on touch screens. Give such a scroller a little padding
* on that side.
*/
export const TOUCH_TARGET_CLASS =
"pointer-coarse:after:absolute pointer-coarse:after:top-1/2 pointer-coarse:after:left-1/2 pointer-coarse:after:size-[max(100%,2.75rem)] pointer-coarse:after:-translate-x-1/2 pointer-coarse:after:-translate-y-1/2 pointer-coarse:after:content-['']";
/**
* `TOUCH_TARGET_CLASS` on the vertical axis only, for controls packed tighter
* than ~32px apart in a row (pagination dots, dense swatches), where growing
* sideways would hand most of each control to its neighbour. Same rules.
*/
export const TOUCH_TARGET_Y_CLASS =
"pointer-coarse:after:absolute pointer-coarse:after:inset-x-0 pointer-coarse:after:top-1/2 pointer-coarse:after:h-[max(100%,2.75rem)] pointer-coarse:after:-translate-y-1/2 pointer-coarse:after:content-['']";
/**
* Suppress selection on `element` for as long as a gesture is running on it,
* whatever the primary pointer of the machine happens to be. Returns the
* release. Inline, so it wins over the class above and is gone again the
* moment the gesture ends.
*
* For the press gestures a native selection would otherwise steal — a
* long-press that opens a menu. Elsewhere prefer the classes: a surface that
* takes selection away for the whole session is a surface whose text nobody
* can copy.
*/
export function holdSelection(element: HTMLElement) {
element.style.setProperty("user-select", "none");
element.style.setProperty("-webkit-user-select", "none");
return () => {
element.style.removeProperty("user-select");
element.style.removeProperty("-webkit-user-select");
};
}
/**
* Pointer capture, best effort. WebKit throws `NotFoundError` when the pointer
* is already gone by the time the handler runs — routine on iOS, where the
* system can claim the touch first — and an uncaught throw takes the rest of
* the handler, the gesture included, down with it. Touch pointers carry
* implicit capture anyway, so losing it is never fatal.
*/
export function capturePointer(element: Element, pointerId: number) {
try {
element.setPointerCapture(pointerId);
} catch {
// Pointer is no longer active — implicit capture still applies on touch.
}
}
/** Release a capture taken with `capturePointer`, ignoring a stale pointer. */
export function releasePointer(element: Element, pointerId: number) {
try {
if (element.hasPointerCapture(pointerId)) {
element.releasePointerCapture(pointerId);
}
} catch {
// Capture was already dropped by the browser.
}
}
/**
* Whether this event came from a pointer that is *hovering*: not a touch, and
* not currently pressed. Which input the user is holding right now is not
* something a device capability can answer — a touchscreen laptop hovers and
* taps, and iPadOS reports a fine hovering pointer for a finger — so both
* paths stay live and each handler branches on the event it was given.
*
* A pen resting on the glass is making contact, not hovering: `buttons` is the
* tell, and it sends a pen tap down the same route a finger takes.
*
* This answers what an *enter* asks. A leave is the other half of a pair and
* has to be read against the enter that started it — `useHoverGesture` in
* `lib/hooks/use-hover-gesture` does that, and hover surfaces should use it
* rather than asking this question twice.
*/
export const isHoveringPointer = (event: {
pointerType: string;
buttons: number;
}) => event.pointerType !== "touch" && event.buttons === 0;
Copy the source code
"use client";
// karaui.kamisama-v0.my.id/components/motion/stepper
import { Check } from "lucide-react";
import {
AnimatePresence,
motion,
useAnimationControls,
useReducedMotion,
} from "motion/react";
import {
Children,
createContext,
type ReactNode,
useCallback,
useContext,
useEffect,
useId,
useMemo,
useRef,
useState,
} from "react";
import { Button, type ButtonProps } from "@/components/motion/button";
import { EASE_OUT, SPRING_LAYOUT, SPRING_SWAP } from "@/lib/ease";
import { cn } from "@/lib/utils";
export type StepperStep = {
id: string;
title: string;
description?: string;
};
/** Return false (or a promise of false) to keep the user on the current step. */
export type StepperGuard = (index: number) => boolean | Promise<boolean>;
export interface StepperProps {
steps: StepperStep[];
/** Controlled active step index. */
value?: number;
/** Uncontrolled initial step index. Default 0. */
defaultValue?: number;
onValueChange?: (index: number) => void;
/** Runs before leaving a step forward (Next, or jumping ahead). */
canAdvance?: StepperGuard;
/** Called when Next is pressed on the last step and its guard passes. */
onComplete?: () => void | Promise<void>;
/**
* Linear (default): the indicator only jumps back, or forward to steps
* already reached. Non-linear: any step, still guarded by `canAdvance`.
*/
linear?: boolean;
children: ReactNode;
className?: string;
}
type StepperContextValue = {
steps: StepperStep[];
value: number;
count: number;
direction: 1 | -1;
reached: number;
completed: ReadonlySet<number>;
errorStep: number | null;
errorTick: number;
pending: boolean;
linear: boolean;
isFirst: boolean;
isLast: boolean;
baseId: string;
next: () => Promise<boolean>;
previous: () => void;
goTo: (index: number) => Promise<boolean>;
};
const StepperContext = createContext<StepperContextValue | null>(null);
/** Step state and navigation for custom controls inside `<Stepper>`. */
export function useStepper() {
const ctx = useContext(StepperContext);
if (!ctx) throw new Error("useStepper must be used within <Stepper>");
return ctx;
}
const clamp = (n: number, max: number) => Math.min(Math.max(n, 0), max);
/**
* Multi-step flow: an indicator whose active ring glides between steps and
* whose connectors fill as you advance, panels that slide in from the
* direction of travel while the container morphs to each panel's height, and
* a guard per step that shakes the indicator when it refuses. Controlled or
* uncontrolled; reduced-motion safe.
*/
export function Stepper({
steps,
value: controlledValue,
defaultValue = 0,
onValueChange,
canAdvance,
onComplete,
linear = true,
children,
className,
}: StepperProps) {
const count = steps.length;
const baseId = useId();
const [internalValue, setInternalValue] = useState(() =>
clamp(defaultValue, count - 1),
);
const value = clamp(controlledValue ?? internalValue, count - 1);
const [direction, setDirection] = useState<1 | -1>(1);
const [reached, setReached] = useState(value);
const [completed, setCompleted] = useState<ReadonlySet<number>>(
() => new Set(),
);
const [errorStep, setErrorStep] = useState<number | null>(null);
// Bumped on every refusal so the same step can shake twice in a row.
const [errorTick, setErrorTick] = useState(0);
const [pending, setPending] = useState(false);
// A controlled jump past `reached` (e.g. restoring a draft) still counts.
useEffect(() => setReached((r) => Math.max(r, value)), [value]);
const commit = useCallback(
(index: number) => {
setDirection(index > value ? 1 : -1);
setErrorStep(null);
if (controlledValue === undefined) setInternalValue(index);
onValueChange?.(index);
},
[value, controlledValue, onValueChange],
);
const guard = useCallback(
async (index: number) => {
if (!canAdvance) return true;
setPending(true);
try {
return await canAdvance(index);
} finally {
setPending(false);
}
},
[canAdvance],
);
const refuse = useCallback((index: number) => {
setErrorStep(index);
setErrorTick((t) => t + 1);
}, []);
const markDone = useCallback((from: number, to: number) => {
setCompleted((prev) => {
const next = new Set(prev);
for (let i = from; i < to; i++) next.add(i);
return next;
});
}, []);
const goTo = useCallback(
async (target: number) => {
const index = clamp(target, count - 1);
if (index === value || pending) return false;
if (index < value) {
commit(index);
return true;
}
// Linear: forward only to steps already reached, or the very next one.
if (linear && index > Math.max(reached, value + 1)) return false;
// Every step being skipped over must pass its guard, in order.
for (let i = value; i < index; i++) {
if (!(await guard(i))) {
refuse(i);
if (i !== value) commit(i);
return false;
}
}
markDone(value, index);
setReached((r) => Math.max(r, index));
commit(index);
return true;
},
[count, value, pending, linear, reached, guard, refuse, markDone, commit],
);
const next = useCallback(async () => {
if (pending) return false;
if (value < count - 1) return goTo(value + 1);
if (!(await guard(value))) {
refuse(value);
return false;
}
markDone(value, value + 1);
setErrorStep(null);
setPending(true);
try {
await onComplete?.();
} finally {
setPending(false);
}
return true;
}, [pending, value, count, goTo, guard, refuse, markDone, onComplete]);
const previous = useCallback(() => {
if (value > 0 && !pending) commit(value - 1);
}, [value, pending, commit]);
const ctx = useMemo<StepperContextValue>(
() => ({
steps,
value,
count,
direction,
reached,
completed,
errorStep,
errorTick,
pending,
linear,
isFirst: value === 0,
isLast: value === count - 1,
baseId,
next,
previous,
goTo,
}),
[
steps,
value,
count,
direction,
reached,
completed,
errorStep,
errorTick,
pending,
linear,
baseId,
next,
previous,
goTo,
],
);
return (
<StepperContext.Provider value={ctx}>
<div className={cn("flex w-full flex-col gap-6", className)}>
{children}
</div>
</StepperContext.Provider>
);
}
// ── indicator ──────────────────────────────────────────────────────────────
export interface StepperIndicatorProps {
/** Show each step's title under its marker. Default true. */
showTitles?: boolean;
className?: string;
}
/** Numbered markers joined by connectors that fill as steps complete. */
export function StepperIndicator({
showTitles = true,
className,
}: StepperIndicatorProps) {
const {
steps,
value,
reached,
completed,
errorStep,
errorTick,
linear,
baseId,
goTo,
} = useStepper();
const reduce = useReducedMotion();
return (
<ol className={cn("flex w-full items-start", className)}>
{steps.map((step, i) => {
const active = i === value;
const done = completed.has(i) && !active;
const error = errorStep === i;
const reachable = !linear || i <= reached;
const state = error
? "error"
: done
? "completed"
: active
? "current"
: "upcoming";
return (
<li
key={step.id}
// Equal columns keep the markers centered and make each connector
// span exactly one column width, center to center.
className="relative flex min-w-0 flex-1 flex-col items-center gap-2"
>
{i < steps.length - 1 && (
// Connector from this marker's center to the next one's.
<span
aria-hidden
className="absolute top-4 left-[calc(50%+1.25rem)] right-[calc(-50%+1.25rem)] h-0.5 -translate-y-1/2 overflow-hidden rounded-full bg-border"
>
<motion.span
className="absolute inset-0 origin-left bg-primary"
initial={false}
animate={{ scaleX: completed.has(i) ? 1 : 0 }}
transition={
reduce
? { duration: 0 }
: { duration: 0.36, ease: EASE_OUT }
}
/>
</span>
)}
<StepMarker
index={i}
state={state}
shakeKey={error ? errorTick : 0}
disabled={!reachable || active}
label={`Step ${i + 1} of ${steps.length}: ${step.title}${
done ? ", completed" : error ? ", needs attention" : ""
}`}
current={active}
controls={`${baseId}-panel`}
onSelect={() => goTo(i)}
layoutGroup={baseId}
/>
{showTitles && (
<span
aria-hidden
className={cn(
"max-w-28 truncate px-1 text-center text-xs transition-colors",
active || done ? "text-foreground" : "text-muted-foreground",
error && "text-destructive",
)}
>
{step.title}
</span>
)}
</li>
);
})}
</ol>
);
}
function StepMarker({
index,
state,
shakeKey,
disabled,
label,
current,
controls,
onSelect,
layoutGroup,
}: {
index: number;
state: "upcoming" | "current" | "completed" | "error";
shakeKey: number;
disabled: boolean;
label: string;
current: boolean;
controls: string;
onSelect: () => void;
layoutGroup: string;
}) {
const reduce = useReducedMotion();
const shake = useAnimationControls();
useEffect(() => {
if (!shakeKey || reduce) return;
shake.start({
x: [0, -5, 5, -3, 3, 0],
transition: { duration: 0.4, ease: EASE_OUT },
});
}, [shakeKey, reduce, shake]);
return (
<motion.button
type="button"
animate={shake}
disabled={disabled}
aria-label={label}
aria-current={current ? "step" : undefined}
aria-controls={current ? controls : undefined}
onClick={onSelect}
className={cn(
"relative isolate flex size-8 shrink-0 items-center justify-center rounded-full border text-xs font-medium tabular-nums outline-none transition-colors focus-visible:ring-2 focus-visible:ring-ring disabled:cursor-default",
state === "completed" &&
"border-primary bg-primary text-primary-foreground",
state === "current" && "border-transparent text-foreground",
state === "upcoming" && "border-border bg-card text-muted-foreground",
state === "error" &&
"border-destructive bg-destructive/10 text-destructive",
!disabled && state !== "current" && "hover:border-primary/60",
)}
>
{state === "current" && (
<motion.span
aria-hidden
// The ring glides from marker to marker as the active step changes.
layoutId={`${layoutGroup}-ring`}
transition={reduce ? { duration: 0 } : SPRING_LAYOUT}
className="absolute -inset-px -z-10 rounded-full border-2 border-primary bg-card"
/>
)}
<AnimatePresence mode="popLayout" initial={false}>
{state === "completed" ? (
<motion.span
key="check"
initial={reduce ? { opacity: 0 } : { opacity: 0, scale: 0.4 }}
animate={{ opacity: 1, scale: 1 }}
exit={{ opacity: 0, transition: { duration: 0.1 } }}
transition={SPRING_SWAP}
>
<Check className="size-4" strokeWidth={2.5} />
</motion.span>
) : (
<motion.span
key="number"
initial={reduce ? { opacity: 0 } : { opacity: 0, scale: 0.6 }}
animate={{ opacity: 1, scale: 1 }}
exit={{ opacity: 0, transition: { duration: 0.1 } }}
transition={SPRING_SWAP}
>
{index + 1}
</motion.span>
)}
</AnimatePresence>
</motion.button>
);
}
// ── panels ─────────────────────────────────────────────────────────────────
export interface StepperPanelsProps {
/** One child per step, in step order. */
children: ReactNode;
className?: string;
}
/**
* Shows the active step's child. Panels slide in from the direction of
* travel and the container morphs to each panel's height. Focus moves to the
* new panel after navigation so keyboard and screen-reader users land on it.
*/
export function StepperPanels({ children, className }: StepperPanelsProps) {
const { value, direction, steps, baseId } = useStepper();
const reduce = useReducedMotion();
const panels = Children.toArray(children);
const containerRef = useRef<HTMLDivElement>(null);
const shownStep = useRef(value);
useEffect(() => {
// Only move focus in response to navigation, never on first render.
if (shownStep.current === value) return;
shownStep.current = value;
// The exiting panel is still mounted mid-transition, so look the entering
// one up by its step instead of trusting a shared ref.
containerRef.current
?.querySelector<HTMLElement>(`[data-step="${value}"]`)
?.focus({ preventScroll: true });
}, [value]);
const offset = reduce ? 0 : 24;
return (
<motion.div
layout
ref={containerRef}
transition={reduce ? { duration: 0 } : SPRING_LAYOUT}
className={cn("relative overflow-hidden", className)}
>
<AnimatePresence mode="popLayout" initial={false} custom={direction}>
<motion.div
key={value}
data-step={value}
id={`${baseId}-panel`}
role="group"
aria-label={`Step ${value + 1}: ${steps[value]?.title ?? ""}`}
tabIndex={-1}
layout="position"
custom={direction}
variants={{
enter: (dir: number) => ({
opacity: 0,
x: dir * offset,
filter: reduce ? "blur(0px)" : "blur(4px)",
}),
center: {
opacity: 1,
x: 0,
filter: "blur(0px)",
transition: { duration: 0.26, ease: EASE_OUT },
},
exit: (dir: number) => ({
opacity: 0,
x: dir * -offset,
filter: reduce ? "blur(0px)" : "blur(4px)",
transition: { duration: 0.16, ease: EASE_OUT },
}),
}}
initial="enter"
animate="center"
exit="exit"
className="outline-none"
>
{panels[value]}
</motion.div>
</AnimatePresence>
</motion.div>
);
}
// ── controls ───────────────────────────────────────────────────────────────
export interface StepperPreviousProps extends Omit<ButtonProps, "onClick"> {
children?: ReactNode;
}
/** Goes back one step. Hidden from layout on the first step. */
export function StepperPrevious({
children = "Back",
className,
variant = "ghost",
...props
}: StepperPreviousProps) {
const { isFirst, pending, previous } = useStepper();
return (
<Button
type="button"
variant={variant}
disabled={isFirst || pending}
onClick={previous}
className={cn(isFirst && "invisible", className)}
{...props}
>
{children}
</Button>
);
}
export interface StepperNextProps extends Omit<ButtonProps, "onClick"> {
children?: ReactNode;
/** Label on the last step. Default "Finish". */
finishLabel?: ReactNode;
}
/** Advances through the step guard; on the last step it runs `onComplete`. */
export function StepperNext({
children = "Continue",
finishLabel = "Finish",
...props
}: StepperNextProps) {
const { isLast, pending, next } = useStepper();
return (
<Button
type="button"
disabled={pending}
aria-busy={pending || undefined}
onClick={() => void next()}
{...props}
>
{isLast ? finishLabel : children}
</Button>
);
}
export type {
ButtonLinkProps,
ButtonProps,
ButtonSize,
ButtonVariant,
} from "./base";
export { Button, ButtonLink } from "./base";
export type { MagneticButtonProps } from "./magnetic";
export { MagneticButton } from "./magnetic";
export type { ButtonState, StatefulButtonProps } from "./stateful";
export { StatefulButton } from "./stateful";
"use client";
import {
AnimatePresence,
type HTMLMotionProps,
motion,
useReducedMotion,
} from "motion/react";
import {
forwardRef,
type PointerEvent,
type ReactNode,
useCallback,
useRef,
useState,
} from "react";
import { EASE_OUT, SPRING_PRESS } from "@/lib/ease";
import { useHoverCapable } from "@/lib/hooks/use-hover-capable";
import { TOUCH_TARGET_CLASS } from "@/lib/touch";
import { cn } from "@/lib/utils";
export type ButtonVariant = "primary" | "secondary" | "ghost" | "outline";
export type ButtonSize = "sm" | "md" | "lg" | "icon";
export interface ButtonProps extends Omit<
HTMLMotionProps<"button">,
"children"
> {
variant?: ButtonVariant;
size?: ButtonSize;
pressScale?: number;
/** Spawn a Material-style ripple from the press point. Off by default. */
ripple?: boolean;
children?: ReactNode;
}
export interface ButtonLinkProps extends Omit<
HTMLMotionProps<"a">,
"children"
> {
variant?: ButtonVariant;
size?: ButtonSize;
pressScale?: number;
children?: ReactNode;
}
type Ripple = { id: number; x: number; y: number; size: number };
const VARIANT_CLASS: Record<ButtonVariant, string> = {
primary: "bg-primary text-primary-foreground hover:bg-primary/90",
secondary: "border border-border bg-card text-foreground hover:border-border",
ghost: "text-muted-foreground hover:text-foreground hover:bg-primary/5",
outline:
"border border-border bg-transparent text-foreground hover:bg-primary/5",
};
const SIZE_CLASS: Record<ButtonSize, string> = {
sm: "h-8 px-3 text-xs gap-1.5 rounded-full",
md: "h-10 px-5 text-sm gap-2 rounded-full",
lg: "h-12 px-6 text-base gap-2 rounded-full",
icon: "h-8 w-8 rounded-lg",
};
export const Button = forwardRef<HTMLButtonElement, ButtonProps>(
function Button(
{
variant = "primary",
size = "md",
pressScale = 0.93,
ripple = false,
className,
children,
onPointerDown,
...rest
},
ref,
) {
const reduce = useReducedMotion();
const canHover = useHoverCapable();
const [ripples, setRipples] = useState<Ripple[]>([]);
const nextId = useRef(0);
const handlePointerDown = useCallback(
(event: PointerEvent<HTMLButtonElement>) => {
if (ripple && !reduce) {
const rect = event.currentTarget.getBoundingClientRect();
const size = Math.max(rect.width, rect.height) * 2;
const id = nextId.current++;
setRipples((prev) => [
...prev,
{
id,
x: event.clientX - rect.left,
y: event.clientY - rect.top,
size,
},
]);
}
onPointerDown?.(event);
},
[ripple, reduce, onPointerDown],
);
return (
<motion.button
ref={ref}
type="button"
whileTap={reduce ? undefined : { scale: pressScale }}
whileHover={reduce || !canHover ? undefined : { scale: 1.02 }}
transition={SPRING_PRESS}
onPointerDown={handlePointerDown}
className={cn(
"relative inline-flex items-center justify-center font-medium select-none",
"transition-colors",
"disabled:pointer-events-none disabled:opacity-50",
// The ripple layer clips itself, so on a touch screen the button can
// stop clipping and let its enlarged hit area overhang.
ripple && "overflow-hidden pointer-coarse:overflow-visible",
TOUCH_TARGET_CLASS,
VARIANT_CLASS[variant],
SIZE_CLASS[size],
className,
)}
{...rest}
>
{ripple && !reduce ? (
<span className="pointer-events-none absolute inset-0 overflow-hidden rounded-[inherit]">
<AnimatePresence>
{ripples.map((r) => (
<motion.span
key={r.id}
className="absolute rounded-full bg-current"
style={{
left: r.x,
top: r.y,
width: r.size,
height: r.size,
x: "-50%",
y: "-50%",
}}
initial={{ scale: 0.05, opacity: 0.3 }}
animate={{ scale: 1, opacity: 0 }}
exit={{ opacity: 0 }}
transition={{ duration: 1.6, ease: EASE_OUT }}
onAnimationComplete={() =>
setRipples((prev) => prev.filter((x) => x.id !== r.id))
}
/>
))}
</AnimatePresence>
</span>
) : null}
{children}
</motion.button>
);
},
);
export const ButtonLink = forwardRef<HTMLAnchorElement, ButtonLinkProps>(
function ButtonLink(
{
variant = "primary",
size = "md",
pressScale = 0.93,
className,
children,
...rest
},
ref,
) {
const reduce = useReducedMotion();
const canHover = useHoverCapable();
return (
<motion.a
ref={ref}
whileTap={reduce ? undefined : { scale: pressScale }}
whileHover={reduce || !canHover ? undefined : { scale: 1.02 }}
transition={SPRING_PRESS}
className={cn(
"relative inline-flex items-center justify-center font-medium select-none",
"transition-colors",
TOUCH_TARGET_CLASS,
VARIANT_CLASS[variant],
SIZE_CLASS[size],
className,
)}
{...rest}
>
{children}
</motion.a>
);
},
);
"use client";
import { forwardRef } from "react";
import { Magnetic } from "../magnetic";
import { Button, type ButtonProps } from "./base";
export interface MagneticButtonProps extends ButtonProps {
/** Magnetic pull strength. Default 0.25. */
strength?: number;
/** Class applied to the magnetic wrapper. */
magneticClassName?: string;
}
export const MagneticButton = forwardRef<HTMLButtonElement, MagneticButtonProps>(function MagneticButton(
{ strength = 0.25, magneticClassName, children, ...rest },
ref,
) {
return (
<Magnetic strength={strength} className={magneticClassName}>
<Button ref={ref} {...rest}>
{children}
</Button>
</Magnetic>
);
});
"use client";
import { Check, Loader2, X } from "lucide-react";
import {
AnimatePresence,
motion,
useReducedMotion,
type Variants,
} from "motion/react";
import {
forwardRef,
type ReactNode,
useLayoutEffect,
useRef,
useState,
} from "react";
import { EASE_OUT, SPRING_SWAP } from "@/lib/ease";
import { Button, type ButtonProps } from "./base";
export type ButtonState = "idle" | "loading" | "success" | "error";
export interface StatefulButtonProps extends Omit<ButtonProps, "children"> {
state?: ButtonState;
children: ReactNode;
loadingText?: ReactNode;
successText?: ReactNode;
errorText?: ReactNode;
icon?: ReactNode;
}
const CASCADE_STAGGER = 0.025;
const ROLL_BLUR = "blur(6px)";
const CASCADE_LETTER_VARIANTS: Variants = {
initial: { opacity: 0, y: "105%", filter: ROLL_BLUR },
animate: (delay: number = 0) => ({
opacity: 1,
y: "0%",
filter: "blur(0px)",
transition: { ...SPRING_SWAP, delay },
}),
exit: (delay: number = 0) => ({
opacity: 0,
y: "-105%",
filter: ROLL_BLUR,
transition: { duration: 0.16, ease: EASE_OUT, delay: delay * 0.5 },
}),
};
const ICON_VARIANTS: Variants = {
// Width collapses too, so the icon adds/removes its own space smoothly
// instead of popping the row width in a single frame.
initial: { opacity: 0, width: 0, scale: 0.7, filter: ROLL_BLUR },
animate: {
opacity: 1,
width: "1.5rem",
scale: 1,
filter: "blur(0px)",
transition: SPRING_SWAP,
},
exit: {
opacity: 0,
width: 0,
scale: 0.7,
filter: ROLL_BLUR,
transition: { duration: 0.16, ease: EASE_OUT },
},
};
function IconSlot({ keyId, children }: { keyId: string; children: ReactNode }) {
const reduce = useReducedMotion();
return (
<motion.span
key={keyId}
variants={ICON_VARIANTS}
initial={reduce ? { opacity: 0 } : "initial"}
animate={reduce ? { opacity: 1 } : "animate"}
exit={reduce ? { opacity: 0 } : "exit"}
transition={reduce ? { duration: 0.15 } : undefined}
className="inline-grid shrink-0 place-items-center overflow-hidden"
>
{children}
</motion.span>
);
}
function TextSlot({
value,
children,
}: {
value: string;
children: ReactNode;
}) {
const reduce = useReducedMotion();
const measureRef = useRef<HTMLSpanElement>(null);
const [width, setWidth] = useState<number>();
const label = typeof children === "string" ? children : null;
const cascade = label !== null && !reduce;
// Measure strings with the same per-letter layout as the cascade. Measuring
// the whole string preserves kerning, which can make it narrower than the
// inline-block letters and clip the final glyph during the width animation.
useLayoutEffect(() => {
const nextWidth = measureRef.current?.offsetWidth;
if (!nextWidth) return;
setWidth((current) => (current === nextWidth ? current : nextWidth));
});
return (
<motion.span
initial={false}
animate={{ width }}
transition={reduce ? { duration: 0 } : SPRING_SWAP}
className="relative inline-block overflow-hidden whitespace-nowrap align-bottom"
>
<span
ref={measureRef}
aria-hidden
className="invisible inline-block whitespace-nowrap"
>
{cascade
? label.split("").map((char, index) => (
<span
// biome-ignore lint/suspicious/noArrayIndexKey: position is the slot identity.
key={index}
className="inline-block whitespace-pre"
>
{char}
</span>
))
: children}
</span>
{cascade ? (
<>
<span className="sr-only">{label}</span>
<AnimatePresence initial={false}>
<motion.span
key={`cascade-${value}`}
aria-hidden
initial="initial"
animate="animate"
exit="exit"
className="absolute left-0 top-0 inline-block whitespace-pre"
>
{label.split("").map((char, index) => (
<motion.span
// biome-ignore lint/suspicious/noArrayIndexKey: position is the slot identity.
key={index}
custom={index * CASCADE_STAGGER}
variants={CASCADE_LETTER_VARIANTS}
className="inline-block whitespace-pre will-change-[opacity,filter,transform]"
>
{char}
</motion.span>
))}
</motion.span>
</AnimatePresence>
</>
) : (
<AnimatePresence initial={false}>
<motion.span
key={`text-${value}`}
initial={reduce ? { opacity: 0 } : { opacity: 0, y: 14, filter: ROLL_BLUR }}
animate={reduce ? { opacity: 1 } : { opacity: 1, y: 0, filter: "blur(0px)" }}
exit={reduce ? { opacity: 0 } : { opacity: 0, y: -14, filter: ROLL_BLUR }}
transition={reduce ? { duration: 0.15 } : SPRING_SWAP}
className="absolute left-0 top-0 inline-block will-change-[opacity,filter,transform]"
>
{children}
</motion.span>
</AnimatePresence>
)}
</motion.span>
);
}
export const StatefulButton = forwardRef<HTMLButtonElement, StatefulButtonProps>(function StatefulButton(
{
state = "idle",
children,
loadingText = "Loading",
successText = "Done",
errorText = "Try again",
icon,
disabled,
...rest
},
ref,
) {
const isBusy = state === "loading";
const stateText =
state === "loading"
? loadingText
: state === "success"
? successText
: state === "error"
? errorText
: children;
const textKey =
typeof stateText === "string" ? `${state}-${stateText}` : state;
return (
<Button ref={ref} disabled={disabled || isBusy} aria-busy={isBusy} whileHover={undefined} {...rest}>
<span
aria-live="polite"
className="relative inline-flex items-center justify-center overflow-hidden"
>
<AnimatePresence initial={false}>
{state === "loading" ? (
<IconSlot keyId="loading-icon">
<Loader2 className="h-4 w-4 animate-spin" />
</IconSlot>
) : null}
{state === "success" ? (
<IconSlot keyId="success-icon">
<Check className="h-4 w-4" />
</IconSlot>
) : null}
{state === "error" ? (
<IconSlot keyId="error-icon">
<X className="h-4 w-4" />
</IconSlot>
) : null}
</AnimatePresence>
<TextSlot value={textKey}>{stateText}</TextSlot>
<AnimatePresence initial={false}>
{state === "idle" && icon ? (
<IconSlot keyId="idle-icon">{icon}</IconSlot>
) : null}
</AnimatePresence>
</span>
</Button>
);
});
"use client";
import { motion, useMotionValue, useReducedMotion, useSpring } from "motion/react";
import { useRef, type ReactNode } from "react";
import { SPRING_MOUSE } from "@/lib/ease";
import { useHoverCapable } from "@/lib/hooks/use-hover-capable";
import { cn } from "@/lib/utils";
export interface MagneticProps {
children: ReactNode;
strength?: number;
className?: string;
}
export function Magnetic({ children, strength = 0.35, className }: MagneticProps) {
const ref = useRef<HTMLDivElement>(null);
const reduce = useReducedMotion();
const canHover = useHoverCapable();
// Decorative cursor-follow: skip on touch (phantom hover) and reduced motion.
const enabled = !reduce && canHover;
const x = useMotionValue(0);
const y = useMotionValue(0);
const sx = useSpring(x, SPRING_MOUSE);
const sy = useSpring(y, SPRING_MOUSE);
const onMove = (e: React.MouseEvent<HTMLDivElement>) => {
const el = ref.current;
if (!el || !enabled) return;
const rect = el.getBoundingClientRect();
x.set((e.clientX - rect.left - rect.width / 2) * strength);
y.set((e.clientY - rect.top - rect.height / 2) * strength);
};
const onLeave = () => {
x.set(0);
y.set(0);
};
return (
<motion.div
ref={ref}
onMouseMove={onMove}
onMouseLeave={onLeave}
style={{ x: sx, y: sy }}
className={cn("inline-block", className)}
>
{children}
</motion.div>
);
}
"use client";
import {
AnimatePresence,
animate,
motion,
useReducedMotion,
} from "motion/react";
import {
forwardRef,
useEffect,
useId,
useRef,
useState,
type InputHTMLAttributes,
type ReactNode,
} from "react";
import { cn } from "@/lib/utils";
export type InputClassNames = {
root?: string;
label?: string;
field?: string;
input?: string;
leftIcon?: string;
rightIcon?: string;
successIcon?: string;
errorMessage?: string;
};
export interface InputProps extends Omit<
InputHTMLAttributes<HTMLInputElement>,
"value" | "defaultValue" | "onChange"
> {
label?: string;
value?: string;
defaultValue?: string;
onChange?: (value: string) => void;
/** Truthy error triggers a shake, red border and (if a string) a message. */
error?: string | boolean;
success?: boolean;
leftIcon?: ReactNode;
rightIcon?: ReactNode;
className?: string;
classNames?: InputClassNames;
}
export const Input = forwardRef<HTMLInputElement, InputProps>(function Input(
{
label,
value: valueProp,
defaultValue,
onChange,
onFocus,
onBlur,
error,
success,
leftIcon,
rightIcon,
className,
classNames,
disabled,
id: idProp,
type,
...rest
},
ref,
) {
const reactId = useId();
const id = idProp ?? reactId;
const reduce = useReducedMotion();
const controlled = valueProp !== undefined;
const [internal, setInternal] = useState(defaultValue ?? "");
const value = controlled ? (valueProp ?? "") : internal;
const [focused, setFocused] = useState(false);
const fieldRef = useRef<HTMLDivElement>(null);
const hasError = Boolean(error);
const errorMessage = typeof error === "string" ? error : null;
// Right edge shows the success check, otherwise the caller's right icon.
const rightSlot = success ? null : rightIcon;
// Shake the field when an error appears.
useEffect(() => {
if (!fieldRef.current || reduce || !hasError) return;
animate(
fieldRef.current,
{ x: [0, -6, 6, -4, 4, -2, 0] },
{ duration: 0.45 },
);
}, [hasError, reduce]);
const handleChange = (next: string) => {
if (!controlled) setInternal(next);
onChange?.(next);
};
return (
<div
className={cn("flex flex-col gap-1.5", className, classNames?.root)}
>
{label ? (
<label
htmlFor={id}
className={cn(
"px-1 text-sm font-medium text-foreground",
classNames?.label,
)}
>
{label}
</label>
) : null}
<div
ref={fieldRef}
data-state={
hasError
? "error"
: success
? "success"
: focused
? "focused"
: "idle"
}
className={cn(
"relative h-11 overflow-hidden rounded-full border transition-colors duration-200",
"border-border",
focused && !hasError && "border-foreground/40 ring-2 ring-ring/40",
hasError && "border-destructive ring-2 ring-destructive/25",
disabled && "opacity-60",
classNames?.field,
)}
>
{leftIcon ? (
<span
className={cn(
"pointer-events-none absolute left-3 top-1/2 flex -translate-y-1/2 items-center text-muted-foreground [&_svg]:h-4 [&_svg]:w-4",
classNames?.leftIcon,
)}
>
{leftIcon}
</span>
) : null}
<input
ref={ref}
id={id}
type={type}
value={value}
disabled={disabled}
aria-invalid={hasError || undefined}
aria-describedby={errorMessage ? `${id}-error` : undefined}
{...rest}
onChange={(e) => handleChange(e.target.value)}
onFocus={(event) => {
setFocused(true);
onFocus?.(event);
}}
onBlur={(event) => {
setFocused(false);
onBlur?.(event);
}}
className={cn(
"peer h-full w-full bg-transparent text-base leading-6 text-foreground caret-foreground outline-none",
"placeholder:text-muted-foreground/60",
leftIcon ? "pl-10" : "pl-3.5",
rightSlot || success ? "pr-10" : "pr-3.5",
disabled && "cursor-not-allowed",
classNames?.input,
)}
/>
{success ? (
<motion.svg
viewBox="0 0 24 24"
fill="none"
className={cn(
"absolute right-3.5 top-1/2 h-5 w-5 -translate-y-1/2 text-(--color-success)",
classNames?.successIcon,
)}
>
<motion.path
d="M5 12.5l4.5 4.5L19 7.5"
stroke="currentColor"
strokeWidth={2.5}
strokeLinecap="round"
strokeLinejoin="round"
initial={reduce ? { pathLength: 1 } : { pathLength: 0 }}
animate={{ pathLength: 1 }}
transition={{ duration: 0.35, ease: "easeOut" }}
/>
</motion.svg>
) : rightSlot ? (
<span
className={cn(
"absolute right-0 top-0 flex h-full items-center text-muted-foreground [&_button]:grid [&_button]:size-11 [&_button]:place-items-center [&_svg]:h-4 [&_svg]:w-4",
classNames?.rightIcon,
)}
>
{rightSlot}
</span>
) : null}
</div>
<AnimatePresence initial={false}>
{errorMessage ? (
<motion.p
id={`${id}-error`}
role="alert"
initial={
reduce
? { opacity: 0 }
: { opacity: 0, y: -4, filter: "blur(4px)" }
}
animate={{ opacity: 1, y: 0, filter: "blur(0px)" }}
exit={
reduce
? { opacity: 0 }
: { opacity: 0, y: -4, filter: "blur(4px)" }
}
transition={{ duration: 0.2 }}
className={cn(
"px-1 text-xs text-destructive",
classNames?.errorMessage,
)}
>
{errorMessage}
</motion.p>
) : null}
</AnimatePresence>
</div>
);
});
@karaui not found? Add it to components.json
{
"registries": {
"@karaui": "https://karaui.kamisama-v0.my.id/r/{name}.json"
}
}@karaui is in shadcn's public registry directory, so the latest CLI needs no setup. On an older CLI, merge this into the existing file once and every @karaui/… install resolves.
API Reference
Stepper
stepsStepperStep[]—value?numberControlled active step index.
—defaultValue?numberUncontrolled initial step index. Default 0.
0onValueChange?((index: number) => void)—canAdvance?StepperGuardRuns before leaving a step forward (Next, or jumping ahead).
—onComplete?(() => void | Promise<void>)Called when Next is pressed on the last step and its guard passes.
—linear?booleanLinear (default): the indicator only jumps back, or forward to steps already reached. Non-linear: any step, still guarded by `canAdvance`.
trueclassName?string—StepperIndicator
showTitles?booleanShow each step's title under its marker. Default true.
trueclassName?string—StepperPanels
childrenReactNodeOne child per step, in step order.
—className?string—StepperPrevious
className?string—variant?"primary" | "secondary" | "ghost" | "outline"ghostsize?"sm" | "md" | "lg" | "icon"—pressScale?number—ripple?booleanSpawn a Material-style ripple from the press point. Off by default.
—StepperNext
finishLabel?ReactNodeLabel on the last step. Default "Finish".
FinishclassName?string—variant?"primary" | "secondary" | "ghost" | "outline"—size?"sm" | "md" | "lg" | "icon"—pressScale?number—ripple?booleanSpawn a Material-style ripple from the press point. Off by default.
—Updated