Skip to main content
Module

x/cliffy/prompt/mod.ts>CheckboxOptions

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...
Extremely Popular
Latest
interface CheckboxOptions
implements GenericListOptions<TValue, Array<TValue>, Array<TValue>>
import { type CheckboxOptions } from "https://deno.land/x/cliffy@v1.0.0-rc.4/prompt/mod.ts";

Checkbox prompt options.

Properties

optional
keys: CheckboxKeys

Keymap to assign key names to prompt actions.

options: Array<
| Extract<TValue, string | number>
| Extract<WidenType<TValue>, string | number>
| GenericListSeparatorOption
>

An array of child options.

optional
confirmSubmit: boolean

If enabled, the user needs to press enter twice to submit. Default is true.

optional
check: string

Change check icon. Default is green(Figures.TICK).

optional
uncheck: string

Change uncheck icon. Default is red(Figures.CROSS).

optional
partialCheck: string

Change partial check icon. Default is green(Figures.RADIO_ON).

optional
minOptions: number

The minimum allowed options to select. Default is 0.

optional
maxOptions: number

The maximum allowed options to select. Default is Infinity.