Switch

A state atom whose appearance (checked, unchecked) is a pure function of the state prop. Pass a state directly or drive it from the Remotion timeline via useCurrentState. The component reads no frame — only the state value you give it.

Installation

$ pnpm dlx shadcn@latest add @remocn/switch

States

SwitchState is:

type SwitchState =
  | "unchecked"  // track = theme.input, thumb at left
  | "checked"    // track fills primary, thumb slides to the right

checked fills the track with primary and slides the thumb to the right edge. unchecked renders an inactive track with the theme input color and positions the thumb at the left.

Snap usage

Pass state directly — the component snaps instantly to that visual. Useful for static previews or when you drive state from your own logic:

import { Switch } from "@/components/remocn/switch";

export const Scene = () => <Switch state="checked" />;

To drive state from the timeline, use useCurrentState:

import { useCurrentState } from "@/lib/remocn-ui";
import { Switch } from "@/components/remocn/switch";

export const Scene = () => {
  const state = useCurrentState(
    [
      { at: 18, state: "checked" },
      { at: 78, state: "unchecked" },
    ],
    "unchecked",
  );

  return <Switch label="Enable notifications" state={state} />;
};

Each at is a Sequence-local authored frame. State persists between steps: checked at frame 18 keeps the switch on until unchecked fires at frame 78. See Concepts for the full useCurrentState API.

Smooth transitions

State changes via state snap with no cross-fade. For animated transitions, use useSwitchTransition from the copied use-switch-transition.ts file. It reads the frame, interpolates between state presets, and returns a resolved SwitchStyle — pass it to the style prop:

import { Switch } from "@/components/remocn/switch";
import { useSwitchTransition } from "@/components/remocn/use-switch-transition";

export const Scene = () => {
  const style = useSwitchTransition([
    { at: 18, state: "checked", duration: 14 },
    { at: 78, state: "unchecked", duration: 12 },
  ]);
  return <Switch label="Enable notifications" style={style} />;
};

The duration field on each step overrides the file's DEFAULT_DURATION for that specific transition. To globally tune timing and easing, edit use-switch-transition.ts directly in your project — that file is yours (shadcn "own your code" philosophy).

style takes precedence over state when both are provided.

Props