Switch the whole set between Calm, Springy, Snappy and Playful motion with one setting.
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/motion-styleThis adds components/keyframery/motion-style.tsx and its primitive, components/keyframery/primitives/motion-style.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 { MotionStyleSwitcher } from "@/components/keyframery/motion-style"The parts and props are the same as UI SDK's preferences. For every prop, see the UI SDK preferences reference.
What moves
| Move | What you see |
|---|---|
| Stretch | The switcher's key stretches between the four styles. |
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 preferences with your own styles? Keep your markup and change one line. The primitive adds motion and nothing else.
// Before
import { … } from "@ui-sdk/react/preferences"
// After: same parts, same props, now animated
import { … } from "@/components/keyframery/primitives/motion-style"Parts
The finished component exports one part:
MotionStyleSwitcher
Accessibility
Keyboard, focus and screen-reader behaviour come from UI SDK and are not changed. With reduced motion turned on, nothing in the motion style 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.
"use client"
/* Styled motion style switcher: a segmented control whose key stretches between the four styles.
It mounts MotionStyle itself, so dropping it anywhere applies the choice to <html>. */
import * as React from "react"
import {
MotionStyle,
motionStyle,
type MotionStylePreference,
motionStyles,
type MotionStyleValue,
usePreference,
} from "@/components/keyframery/primitives/motion-style"
import { SegmentedControl, SegmentedControlItem } from "@/components/keyframery/segmented-control"
const labels: Record<MotionStyleValue, string> = {
calm: "Calm",
springy: "Springy",
snappy: "Snappy",
playful: "Playful",
}
function MotionStyleSwitcher({
preference = motionStyle,
"aria-label": ariaLabel = "Motion style",
...props
}: Omit<React.ComponentProps<typeof SegmentedControl>, "value" | "defaultValue" | "onValueChange" | "children"> & {
preference?: MotionStylePreference
}) {
const { value } = usePreference(preference)
return (
<MotionStyle preference={preference}>
<SegmentedControl
aria-label={ariaLabel}
value={value}
onValueChange={(next, details) => {
if (next) preference.set(next as MotionStyleValue, { reason: "press", event: details.event })
}}
{...props}
>
{motionStyles.map((style) => (
<SegmentedControlItem key={style} value={style}>
{labels[style]}
</SegmentedControlItem>
))}
</SegmentedControl>
</MotionStyle>
)
}
export { createMotionStyle, MotionStyle, motionStyle, motionStyles, type MotionStyleValue } from "@/components/keyframery/primitives/motion-style"
export { MotionStyleSwitcher }"use client"
/* Keyframery's four motion styles, on top of `@ui-sdk/react/preferences`.
Every Keyframery duration is written as calc(Nms * var(--kf-speed, 1)) and every easing reads
--ease-house, --ease-spring or --ease-pop, so one `data-motion` attribute changes how the whole set
moves: calm (slower, no bounce), springy (the default), snappy (fast, crisp) and playful (more spring).
`motionStyle` is the preference: global (on <html>, so popups at the end of <body> follow it too)
and saved in localStorage. Mount `MotionStyle` once to apply it. `createMotionStyle({ global: false })`
makes a scoped one: its attribute goes on the MotionStyle element (display: contents) and only the
content inside follows it. */
import { createLocalStorage, createPreference } from "@ui-sdk/core"
import { Preferences } from "@ui-sdk/react/preferences"
import * as React from "react"
export * from "@ui-sdk/react/preferences"
const motionStyles = ["calm", "springy", "snappy", "playful"] as const
type MotionStyleValue = (typeof motionStyles)[number]
function createMotionStyle({
global = true,
storageKey = "kf-motion-style",
}: {
/** Put the attribute on <html> (default) or only on the MotionStyle element. */
global?: boolean
/** The localStorage key; null keeps the choice for this visit only. */
storageKey?: string | null
} = {}) {
return createPreference({
values: motionStyles,
defaultValue: "springy",
attribute: "data-motion",
global,
storage: storageKey ? createLocalStorage(storageKey) : undefined,
})
}
type MotionStylePreference = ReturnType<typeof createMotionStyle>
const motionStyle = createMotionStyle()
/* The springy reset (a springy area inside a calm page) lives in the motion tokens, with the other styles. */
function MotionStyle({
preference = motionStyle,
...props
}: Omit<React.ComponentProps<typeof Preferences>, "preferences"> & { preference?: MotionStylePreference }) {
return (
<Preferences preferences={[preference]} {...props} />
)
}
export { createMotionStyle, MotionStyle, motionStyle, type MotionStylePreference, motionStyles, type MotionStyleValue }Questions
How does the animated Motion Style for UI SDK move?
Stretch: The switcher's key stretches between the four styles.
Do I need Motion or Framer Motion for the animated Motion Style?
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/motion-style instead. It has the same parts and props as @ui-sdk/react/preferences and adds motion only.
What happens to the Motion Style when someone turns on reduced motion?
Nothing moves. State changes happen at once, or with a short fade.