Block
Let's take a closer look at what defines a block.
- type:
prompt
|rprompt
- newline:
boolean
- alignment:
left
|right
- filler:
string
- segments:
array
of one or moresegments
#
TypeTells the engine what to do with the block. There are two options:
prompt
renders one or more segmentsrprompt
renders one or more segments aligned to the right of the cursor. Only onerprompt
block is permitted. Supported on zsh, bash, PowerShell, cmd and fish.
#
NewlineStart the block on a new line - defaults to false
.
#
AlignmentTell the engine if the block should be left or right-aligned.
#
FillerWhen you want to join a right and left aligned block with a repeated set of characters, add the character(s) to be repeated to this property. Add this property to the right aligned block. This supports the use of color overrides.
#
SegmentsArray of one or more segments.