Documentation / @ripl/terminal / TerminalContextOptions
Interface: TerminalContextOptions
Defined in: terminal/src/context.ts:125
Options for constructing a terminal rendering context.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
dragThreshold? | number | Minimum pointer movement, in pixels, before a drag gesture is recognised. | ContextOptions.dragThreshold | core/src/context/types.ts:134 |
height? | number | Grid height in terminal rows. Defaults to the output adapter's rows. | - | terminal/src/context.ts:129 |
interactive? | boolean | Whether the context listens for and emits pointer and drag events. | ContextOptions.interactive | core/src/context/types.ts:132 |
logicalHeight? | number | Logical height counterpart to TerminalContextOptions.logicalWidth. | - | terminal/src/context.ts:141 |
logicalWidth? | number | Author the scene in this logical width (e.g. CSS pixels) instead of raw braille pixels. Rendering uniformly scales and letterboxes the logical space into the character grid, so a scene written for a canvas-sized viewport renders proportionally in any terminal. Requires logicalHeight. Text glyphs remain cell-sized (inherent to terminals); only their position (and maxWidth clipping) follows the logical space. | - | terminal/src/context.ts:139 |
meta? | Record<string, unknown> | Arbitrary metadata attached to the context. | ContextOptions.meta | core/src/context/types.ts:136 |
rasterizer? | Rasterizer | Custom rasterizer to use instead of the default BrailleRasterizer. | - | terminal/src/context.ts:131 |
width? | number | Grid width in terminal columns. Defaults to the output adapter's columns. | - | terminal/src/context.ts:127 |