hjw 6c42b6a025 first commit 10 ماه پیش
..
dist 6c42b6a025 first commit 10 ماه پیش
LICENSE 6c42b6a025 first commit 10 ماه پیش
README.md 6c42b6a025 first commit 10 ماه پیش
package.json 6c42b6a025 first commit 10 ماه پیش

README.md

@inquirer/confirm

Simple interactive command line prompt to gather boolean input from users.

Confirm prompt

Special Thanks

[![Graphite](https://github.com/user-attachments/assets/53db40ca-2254-481a-a094-6597f8716e)](https://graphite.dev/?utm_source=npmjs&utm_medium=repo&utm_campaign=inquirerjs)
### [Graphite is the AI developer productivity platform helping teams on GitHub ship higher quality software, faster](https://graphite.dev/?utm_source=npmjs&utm_medium=repo&utm_campaign=inquirerjs)

Installation

npm yarn
```sh npm install @inquirer/prompts ``` ```sh yarn add @inquirer/prompts ```
Or
```sh npm install @inquirer/confirm ``` ```sh yarn add @inquirer/confirm ```

Usage

import { confirm } from '@inquirer/prompts';
// Or
// import confirm from '@inquirer/confirm';

const answer = await confirm({ message: 'Continue?' });

Options

Property Type Required Description
message string yes The question to ask
default boolean no Default answer (true or false)
transformer (boolean) => string no Transform the prompt printed message to a custom string
theme See Theming no Customize look of the prompt.

Theming

You can theme a prompt by passing a theme object option. The theme object only need to includes the keys you wish to modify, we'll fallback on the defaults for the rest.

type Theme = {
  prefix: string | { idle: string; done: string };
  spinner: {
    interval: number;
    frames: string[];
  };
  style: {
    answer: (text: string) => string;
    message: (text: string, status: 'idle' | 'done' | 'loading') => string;
    defaultAnswer: (text: string) => string;
  };
};

License

Copyright (c) 2023 Simon Boudrias (twitter: @vaxilart)
Licensed under the MIT license.