Confirm

A y/N confirmation prompt using Ink's useInput. Shows a blinking cursor while waiting. Resolves with a static confirmation line after the user answers.

Live Preview

Confirm · y/N prompt
? Delete 3 files? (y/N) █

~/my-cli — node v22● running

Installation

npx inkui add confirm

Usage

import { Confirm } from './components/ui/confirm';
 
<Confirm
  message="Delete 47 files from dist/?"
  defaultValue={false}
  onConfirm={() => runDelete()}
  onCancel={() => console.log('Cancelled')}
/>

Examples

Destructive confirmation (default No)

<Confirm
  message="Deploy to production?"
  defaultValue={false}
  onConfirm={deploy}
  onCancel={() => setStep('cancelled')}
/>
// Output: ? Deploy to production? (y/N) █

Safe action (default Yes)

<Confirm
  message="Save changes before exiting?"
  defaultValue={true}
  onConfirm={save}
  onCancel={discardAndExit}
/>
// Output: ? Save changes before exiting? (Y/n) █

Key bindings

Key	Action
`y` / `Y`	Confirm
`n` / `N` / `Esc`	Cancel
`Enter`	Use `defaultValue`

Props

Prop	Type	Default	Description
`message`	`string`	—	Question to display (required)
`defaultValue`	`boolean`	`false`	`true` = Y default, `false` = N default
`onConfirm`	`() => void`	—	Called on confirmation (required)
`onCancel`	`() => void`	`undefined`	Called on cancellation
`theme`	`InkUITheme`	`darkTheme`	Color theme

Installation

Usage

Examples

Destructive confirmation (default No)

Safe action (default Yes)

Key bindings

Props

On this page