Skip to main content

Block

Let's take a closer look at what defines a block.

{
"$schema": "https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json",
...
"blocks": [
{
"type": "prompt",
"alignment": "left",
"segments": [
...
]
}
]
}

Propertiesโ€‹

NameType
typestring
newlineboolean
alignmentstring
fillerstring
overflowstring
segmentsarray

Typeโ€‹

Tells the engine what to do with the block. There are two options:

  • prompt renders one or more segments
  • rprompt renders one or more segments aligned to the right of the cursor. Only one rprompt block is permitted. Supported on zsh, bash, PowerShell, cmd and fish.

Newlineโ€‹

Start the block on a new line - defaults to false.

Alignmentโ€‹

  • left
  • right

Tell the engine if the block should be left or right-aligned.

Fillerโ€‹

When 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.

"alignment": "right",
"filler": "."

Overflowโ€‹

  • break
  • hide

When the right aligned block is so long it will overflow the left aligned block, the engine will either break the block or hide it based on the setting. By default it is printed as is on the same line.

Segmentsโ€‹

Array of one or more segments.