Interface IOptions

The options to create a stdin widget.

interface IOptions {
    future: IShellFuture<
        IShellMessage<ShellMessageType>,
        IShellMessage<ShellMessageType>,
    >;
    inputHistoryScope?: "session" | "global";
    parent_header: IHeader<"input_request">;
    password: boolean;
    prompt: string;
    showInputPlaceholder?: boolean;
    translator?: ITranslator;
}

Properties

future inputHistoryScope? parent_header password prompt showInputPlaceholder? translator?

Properties

future

future: IShellFuture<
    IShellMessage<ShellMessageType>,
    IShellMessage<ShellMessageType>,
>

The kernel future associated with the request.

OptionalinputHistoryScope

inputHistoryScope?: "session" | "global"

Whether to split stdin line history by kernel session or keep globally accessible.

parent_header

parent_header: IHeader<"input_request">

The header of the input_request message.

password

password: boolean

Whether the input is a password.

prompt

prompt: string

The prompt text.

OptionalshowInputPlaceholder

showInputPlaceholder?: boolean

Show placeholder text

Optional Readonlytranslator

translator?: ITranslator

Translator

Settings

Member Visibility

On This Page

Properties