Keyframery

Animated Image Cropper for UI SDK

The selection springs to a new ratio, handles grow while you drag and the zoom settles on a spring.

Part of Keyframery, the open-source animated components for UI SDK

The demo plays by itself. Point at it or press Tab to take over.

Installation

npx shadcn@latest add @keyframery/image-cropper

This adds components/keyframery/image-cropper.tsx and its primitive, components/keyframery/primitives/image-cropper.tsx, to your project, and installs @ui-sdk/react. The motion tokens are added to your global CSS the first time you install a component.

Usage

import {
  ImageCropper,
  ImageCropperFlip,
  ImageCropperGrid,
  ImageCropperHandle,
  ImageCropperImage,
  ImageCropperRotate,
  ImageCropperSelection,
  ImageCropperViewport,
  ImageCropperZoom,
} from "@/components/keyframery/image-cropper"

The parts and props are the same as UI SDK's Image Cropper. For every prop, see the UI SDK image cropper reference.

What moves

MoveWhat you see
SpringThe selection springs to a new box when the ratio or zoom changes, and follows the pointer exactly while dragged.
PopHandles grow when you reach for them.
FadeThe area outside the crop dims, and lightens while you drag.

Timing and springiness follow the motion style you set, so this component moves like the rest of your app.

Swap the import

Already using UI SDK's image cropper with your own styles? Keep your markup and change one line. The primitive adds motion and nothing else.

// Before
import { … } from "@ui-sdk/react/image-cropper"

// After: same parts, same props, now animated
import { … } from "@/components/keyframery/primitives/image-cropper"

Parts

The finished component exports 9 parts:

ImageCropper, ImageCropperFlip, ImageCropperGrid, ImageCropperHandle, ImageCropperImage, ImageCropperRotate, ImageCropperSelection, ImageCropperViewport, ImageCropperZoom

Accessibility

Keyboard, focus and screen-reader behaviour come from UI SDK and are not changed. With reduced motion turned on, nothing in the image cropper moves: changes happen at once or with a short fade. More in Accessibility.

Source

The code that lands in your project. It is yours to change.

Questions

How does the animated Image Cropper for UI SDK move?

Spring: The selection springs to a new box when the ratio or zoom changes, and follows the pointer exactly while dragged. Pop: Handles grow when you reach for them. Fade: The area outside the crop dims, and lightens while you drag.

Do I need Motion or Framer Motion for the animated Image Cropper?

No. Every move is plain CSS, so there is nothing to install besides the component and UI SDK.

Can I keep my own styling and only take the motion?

Yes. Import from @/components/keyframery/primitives/image-cropper instead. It has the same parts and props as @ui-sdk/react/image-cropper and adds motion only.

What happens to the Image Cropper when someone turns on reduced motion?

Nothing moves. State changes happen at once, or with a short fade.

On this page