Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TextboxOptions

Hierarchy

Index

Properties

Optional _data

_data: object

Miscelanus options. Currently JavaScript/Blessed allows to pass anything as option, this is just a bucket for TypeScript and have impact

Type declaration

  • [name: string]: any

Optional align

align: "left" | "center" | "right"

Text alignment: left, center, or right.

Optional alwaysScroll

alwaysScroll: boolean

A option which causes the ignoring of childOffset. This in turn causes the childBase to change every time the element is scrolled.

Optional baseLimit

baseLimit: number

A limit to the childBase. Default is Infinity.

Optional bg

bg: Color

Optional bindings

bindings: any

Optional blink

blink: boolean

Optional bold

bold: boolean

Optional border

Border object, see below.

Optional bottom

bottom: TPosition

Optional censor

censor: boolean

Replace text with asterisks (*).

Optional ch

ch: string

Background character (default is whitespace ).

Optional children

children: Node[]

Optional clickable

clickable: boolean

Element is clickable.

Optional content

content: string

Element's text content.

Optional dockBorders

dockBorders: boolean

Automatically "dock" borders with other elements instead of overlapping, depending on position (experimental).

Optional draggable

draggable: boolean

Allow the element to be dragged with the mouse.

Optional effects

effects: object

Same as style.focus and style.hover

Type declaration

Optional fg

fg: Color

Optional fixed

fixed: boolean

Optional focusEffects

focusEffects: TStyle

Same as style.focus

Optional focusable

focusable: boolean

If true, the node will obtain focus when m

Optional focused

focused: boolean

Element is focused.

Optional height

height: number | string

Offsets of the element relative to its parent. Can be a number, percentage (0-100%), or keyword (center). right and bottom do not accept keywords. Percentages can also have offsets (50%+1, 50%-1).

Optional hidden

hidden: boolean

Whether the element is hidden.

Optional hoverBg

hoverBg: Color

Same as style.hover.bg

Optional hoverEffects

hoverEffects: TStyle

Same as style.hover

Optional hoverText

hoverText: string

A floating text label for the element which appears on mouseover.

Optional input

input: boolean

Element is focusable and can receive key input.

Optional inputOnFocus

inputOnFocus: boolean

Call readInput() when the element is focused. Automatically unfocus.

Optional inverse

inverse: boolean

Optional invisible

invisible: boolean

Optional keyable

keyable: boolean

Keys enabled for this element.

Optional keys

keys: string | string[] | boolean

Use pre-defined keys (i or enter for insert, e for editor, C-e for editor while inserting).

Optional label

label: string

A simple text label for the element.

Optional left

left: TTopLeft

Optional mouse

mouse: boolean

Whether to enable automatic mouse support for this element. Use pre-defined mouse events (right-click for editor).

Optional name

name: string

Optional noOverflow

noOverflow: boolean

Hide content or children outside this element's viewport.

Optional padding

padding: number | Padding

Amount of padding on the inside of the element. Can be a number or an object containing the properties: left, right, top, and bottom.

Optional parent

parent: Node

Optional position

position: Position

Can contain the above options.

Optional ref

accursed library custom support for React-like Refs. Declare the option here so it works out of the box. https://reactjs.org/docs/refs-and-the-dom.html. TODO: documentation

Optional right

right: TPosition

Optional screen

screen: Screen

Optional scrollable

scrollable: boolean

Whether the element is scrollable or not.

Optional scrollbar

scrollbar: object & TStyle | boolean

Object enabling a scrollbar. Style of the scrollbar track if present (takes regular style options).

Optional secret

secret: boolean

Completely hide text.

Optional shadow

shadow: boolean

Draw a translucent offset shadow behind the element.

Optional shrink

shrink: boolean

Shrink/flex/grow to content and child elements. Width/height during render.

Optional style

style: TStyle

Optional tags

tags: boolean

Optional top

Optional transparent

transparent: boolean

Optional underline

underline: boolean

Optional valign

valign: "top" | "middle" | "bottom"

Vertical text alignment: top, middle, or bottom.

Optional value

value: string

Initial value.

Optional vi

vi: boolean

Use vi keys with the keys option.

Optional width

width: number | string

Width/height of the element, can be a number, percentage (0-100%), or keyword (half or shrink). Percentages can also have offsets (50%+1, 50%-1).

Optional wrap

wrap: boolean

Wrap content inside this element viewport.

Generated using TypeDoc