Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/cliffy/prompt/mod.ts>GenericListOptions

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...
c4spar/deno-cliffy
Extremely Popular
Go to Latest
interface GenericListOptions
implements Omit<GenericInputPromptOptions<TReturnValue, TRawValue>, UnsupportedInputOptions>
import { type GenericListOptions } from "https://deno.land/x/cliffy@v1.0.0-rc.1/prompt/mod.ts";

Generic list prompt options.

Type Parameters

TValue
TReturnValue
TRawValue

Properties

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

Keymap to assign key names to prompt actions.

optional
listPointer: string

Change list pointer. Default is brightBlue("❯").

optional
maxRows: number

Limit max displayed rows per page.

optional
searchLabel: string

Change search label. Default is brightBlue("🔎").

optional
info: boolean

Display prompt info.

optional
maxBreadcrumbItems: number

Limit maximum amount of breadcrumb items.

optional
breadcrumbSeparator: string

Change breadcrumb separator. Default is ›.

optional
backPointer: string

Change back pointer. Default is ❮.

optional
groupPointer: string

Change group pointer. Default is ❯.

optional
groupIcon: string | boolean

Change group icon. Default is 📁.

optional
groupOpenIcon: string | boolean

Change opened group icon. Default is 📂.

optional
format: (value: TValue) => string

Format option value.