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.
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
RendererPresetTimer.RendererPresetTimestamp.RendererLoggerOptions<ListrLogLevels>.ListrLoggerStyleMap<ListrLogLevels>
Properties
timer?
optionaltimer:PresetTimer
Show duration for the tasks.
Inherited from
Source
packages/listr2/src/presets/timer/preset.interface.ts:9
timestamp?
optionaltimestamp:PresetTimestamp
Show timestamp for each event that has been logged.
Inherited from
RendererPresetTimestamp.timestamp
Source
packages/listr2/src/presets/timestamp/preset.interface.ts:9
pausedTimer?
optionalpausedTimer:PresetTimer
Show duration for the pauses.
Default Value
PRESET_TIMER
Source
packages/listr2/src/renderer/simple/renderer.interface.ts:14
color?
optionalcolor:Partial<Record<ListrLogLevels,LoggerFormat>>
Coloring of the levels.
See
https://listr2.kilic.dev/renderer/logger.html#style
Inherited from
Source
packages/listr2/src/utils/logger/logger.interface.ts:33
icon?
optionalicon:Partial<Record<ListrLogLevels,string>>
Icons of the levels.
See
https://listr2.kilic.dev/renderer/logger.html#style
Inherited from
Source
packages/listr2/src/utils/logger/logger.interface.ts:39
logger?
optionallogger:ListrLogger<ListrLogLevels>
Inject your custom implementation of the ListrLogger.
See
https://listr2.kilic.dev/renderer/logger.html
Inherited from
Source
packages/listr2/src/utils/logger/logger.interface.ts:82
Renderer Task Options
Details
Documentation / listr2 / ListrSimpleRendererTaskOptions
Interface: ListrSimpleRendererTaskOptions
Extends
Properties
timer?
optionaltimer:PresetTimer
Show duration for the tasks.
Inherited from
Source
packages/listr2/src/presets/timer/preset.interface.ts:9