Spinner

An animated terminal spinner. Supports four distinct animation styles and integrates with the InkUI theme system.

Live Preview

Spinner · dots
⠋ Deploying to production...
⠸ Installing dependencies...
⠦ Running build...

~/my-cli — node v22● running

Installation

npx inkui add spinner

Usage

import { Spinner } from './components/ui/spinner';
 
export default function App() {
  return <Spinner label="Loading data..." />;
}

Examples

Basic

<Spinner label="Loading..." />

Animation styles

<Spinner type="dots"   label="Resolving packages..." />
<Spinner type="line"   label="Compiling..."           />
<Spinner type="arc"    label="Uploading..."           />
<Spinner type="bounce" label="Connecting..."          />

Custom interval

<Spinner label="Thinking..." interval={120} />

With theme

import { lightTheme } from '@inkui-cli/core';
 
<Spinner label="Loading..." theme={lightTheme} />

Props

Prop	Type	Default	Description
`label`	`string`	`''`	Text shown after the spinner frame
`type`	`'dots' \| 'line' \| 'arc' \| 'bounce'`	`'dots'`	Animation style
`interval`	`number`	`80`	Frame interval in milliseconds
`theme`	`InkUITheme`	`darkTheme`	Color theme

On this page