Interface PromptOptions

interface PromptOptions {
    $rules: any;
    $type: string;
    addToHistory: Function;
    getCompletions: Function;
    getPrefix: Function;
    hasDescription: boolean;
    history: Function;
    ignoreFocusOut: boolean;
    maxHistoryCount: number;
    name: string;
    onAccept: Function;
    onCancel: Function;
    onInput: Function;
    placeholder: string;
    prompt: string;
    selection: [number, number];
}

Properties

$rules $type addToHistory getCompletions getPrefix hasDescription history ignoreFocusOut maxHistoryCount name onAccept onCancel onInput placeholder prompt selection

Properties

$rules

$rules: any

Specific rules for input like password or regexp.

$type

$type: string

Use prompt of specific type (gotoLine|commands|modes or default if empty).

addToHistory

addToHistory: Function

getCompletions

getCompletions: Function

Function for defining list of options for value.

getPrefix

getPrefix: Function

Function for defining current value prefix.

hasDescription

hasDescription: boolean

Set to true if prompt has description below input box.

history

history: Function

Function for defining history list.

ignoreFocusOut

ignoreFocusOut: boolean

Set to true to keep the prompt open when focus moves to another part of the editor.

maxHistoryCount

maxHistoryCount: number

name

name: string

Prompt name.

onAccept

onAccept: Function

Function called when Enter is pressed.

onCancel

onCancel: Function

Function called when Esc|Shift-Esc is pressed.

onInput

onInput: Function

Function called when input is added to prompt input box.

placeholder

placeholder: string

Placeholder for value.

prompt

prompt: string

Description below input box.

selection

selection: [number, number]

Defines which part of the predefined value should be highlighted.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc