Skip to main content
Module

x/cliffy/mod.ts>Checkbox

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...
c4spar/deno-cliffy
Extremely Popular
Go to Latest
class Checkbox
extends GenericList<string[], string[], CheckboxSettings>
import { Checkbox } from "https://deno.land/x/cliffy@v0.24.2/mod.ts";

Checkbox prompt representation.

Methods

protected
checkValue(): void

Check selected option.

protected
format(value: string[]): string

Format output value.

protected
getListItem(item: CheckboxOptionSettings, isSelected?: boolean): string

Render checkbox option.

protected
getValue(): string[]

Get value of checked options.

protected
handleEvent(event: KeyCode): Promise<void>

Handle user input event.

protected
transform(value: string[]): string[]

Map input value to output value.

protected
validate(value: string[]): boolean | string

Validate input value.

Static Methods

protected
mapOptions(options: CheckboxOptions): CheckboxValueSettings

Map string option values to options and set option defaults.

inject(value: string[]): void

Inject prompt value. Can be used for unit tests or pre selections.

prompt(options: CheckboxOptions): Promise<string[]>

Execute the prompt and show cursor on end.

separator(label?: string): CheckboxOption

Create list separator.