Motion and animation components for Ink - beautiful text effects for your CLI
npm install ink-motionAnimation components for Ink CLIs: shimmer, typewriter, fade, wave, flash.
- Drop-in animated text for Ink without hand-rolled timers.
- Consistent timing controls across effects (speed, enabled, onComplete).
- TypeScript-first API with strict types.
- Tiny dependency surface: just Ink + React + Chalk.
``bash`
bun add ink-motion
npm install ink-motion
pnpm add ink-motion
`tsx
import { render } from 'ink'
import { Shimmer, Typewriter } from 'ink-motion'
function App() {
return (
<>
Loading...
bun add ink-motion
)
}
render(
`
- Shimmer — moving highlight band across text
- Typewriter — character-by-character reveal with cursor
- Fade — smooth fade in/out with easing
- Wave — sine wave brightness or vertical shift
- Flash — pulsing neon-like glow
`bash`
git clone https://github.com/JR-G/ink-motion
cd ink-motion
bun install
bun run demo
- Guide: docs/guide.md
- Ink ^5
- React
Bun is used for local scripts and tests.
`bash``
bun install
bun run lint
bun run test
bun run build
MIT