Skip to main content
Module

x/tui/src/components/mod.ts>TextboxComponentOptions

🦕 Deno module for creating Terminal User Interfaces
Im-Beast/deno_tui
Go to Latest
interface TextboxComponentOptions
import { type TextboxComponentOptions } from "https://deno.land/x/tui@1.3.4/src/components/mod.ts";

Interface defining object that {TextboxComponent}'s constructor can interpret

Properties

optional
theme: DeepPartial<TextboxTheme>
optional
multiline: boolean

Whether texbox should allow new lines

optional
hidden: boolean

Whether textbox value should be starred ("*")

optional
value: string

Current value of textbox

optional
placeholder: string

Text displayed as a proposition of example text input

optional
lineHighlighting: boolean

Whether to highlight currently selected text row

optional
lineNumbering: boolean

Whether to number textbox rows

optional
keyboardHandler: (textbox: TextboxComponent<EventRecord>) => (keyPress: KeyPress) => void

Function that defines what key does what while textbox is focused/active