Skip to content

Simple Renderer

SimpleRenderer is an alternative to DefaultRenderer, which does not directly update the terminal but works more in a logger-like manner.

SimpleRenderer still requires vt100 terminal compatibility if you are using prompts, but can work in non-TTY environments other than that.

demo

Renderer Options

Details

Documentation / listr2 / ListrSimpleRendererOptions

Interface: ListrSimpleRendererOptions

Inject your custom style map consisting of icons and coloring for the ListrLogger.

See

https://listr2.kilic.dev/renderer/logger.html

Extends

Properties

timer?

optional timer: PresetTimer

Show duration for the tasks.

Inherited from

RendererPresetTimer.timer

Defined in

packages/listr2/src/presets/timer/preset.interface.ts:9


timestamp?

optional timestamp: PresetTimestamp

Show timestamp for each event that has been logged.

Inherited from

RendererPresetTimestamp.timestamp

Defined in

packages/listr2/src/presets/timestamp/preset.interface.ts:9


pausedTimer?

optional pausedTimer: PresetTimer

Show duration for the pauses.

Default Value

PRESET_TIMER

Defined in

packages/listr2/src/renderer/simple/renderer.interface.ts:14


color?

optional color: Partial<Record<ListrLogLevels, LoggerFormat>>

Coloring of the levels.

See

https://listr2.kilic.dev/renderer/logger.html#style

Inherited from

ListrLoggerStyleMap.color

Defined in

packages/listr2/src/utils/logger/logger.interface.ts:33


icon?

optional icon: Partial<Record<ListrLogLevels, string>>

Icons of the levels.

See

https://listr2.kilic.dev/renderer/logger.html#style

Inherited from

ListrLoggerStyleMap.icon

Defined in

packages/listr2/src/utils/logger/logger.interface.ts:39


logger?

optional logger: ListrLogger<ListrLogLevels>

Inject your custom implementation of the ListrLogger.

See

https://listr2.kilic.dev/renderer/logger.html

Inherited from

RendererLoggerOptions.logger

Defined in

packages/listr2/src/utils/logger/logger.interface.ts:82

Renderer Task Options

Details

Documentation / listr2 / ListrSimpleRendererTaskOptions

Interface: ListrSimpleRendererTaskOptions

Extends

Properties

timer?

optional timer: PresetTimer

Show duration for the tasks.

Inherited from

RendererPresetTimer.timer

Defined in

packages/listr2/src/presets/timer/preset.interface.ts:9