oh-my-posh/website/docs/configuration/block.mdx

63 lines
1.3 KiB
Plaintext
Raw Normal View History

---
2022-04-20 09:43:59 -07:00
id: block
title: Block
sidebar_label: Block
---
Let's take a closer look at what defines a block.
```json
{
"$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`
2022-02-04 08:22:40 -08:00
- 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.
2021-12-01 10:11:38 -08:00
Supported on zsh, bash, PowerShell, cmd and fish.
### Newline
2021-11-20 02:14:26 -08:00
Start the block on a new line - defaults to `false`.
### Alignment
Tell the engine if the block should be left or right-aligned.
2022-02-04 08:22:40 -08:00
### Filler
2022-02-12 09:40:02 -08:00
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][color-overrides].
2022-02-04 08:22:40 -08:00
```json
2022-02-06 02:01:46 -08:00
"alignment": "right",
2022-02-04 08:22:40 -08:00
"filler": "."
```
### Segments
Array of one or more segments.
2022-02-12 09:40:02 -08:00
2022-04-20 09:43:59 -07:00
[color-overrides]: /docs/configuration/colors#color-overrides