oh-my-posh/website/docs/configuration/block.md
2022-05-13 08:19:35 +02:00

1.3 KiB

id title sidebar_label
block Block 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": [
        ...
      ]
    }
  ]
}
  • type: prompt | rprompt
  • newline: boolean
  • alignment: left | right
  • filler: string
  • segments: array of one or more segments

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

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": "."

Segments

Array of one or more segments.