Templates

import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import Config from "@site/src/components/Config.js";

Every segment has a template property to tweak the text that is displayed. Under the hood, this uses go's text/template feature extended with sprig and offers a few standard properties to work with.

Global properties

These properties can be used anywhere, in any segment. If a segment contains a property with the same name, the segment property value will be used instead. In case you want to use the global property, you can prefix it with .$ to reference it directly.

Segment

Environment variables

:::tip For the shells below, you can override a function to execute some logic before the prompt is rendered. This can be used to for example populate an environment variable with a specific context.

<Tabs queryString="shell" defaultValue="powershell" groupId="shell" values={[ { label: 'powershell', value: 'powershell', }, { label: 'zsh', value: 'zsh', }, { label: 'bash', value: 'bash', }, { label: 'fish', value: 'fish', }, { label: 'nu', value: 'nu', }, ] }> <TabItem value="powershell">

function Set-EnvVar([bool]$originalStatus) {
    $env:POSH=$(Get-Date)
}
New-Alias -Name 'Set-PoshContext' -Value 'Set-EnvVar' -Scope Global -Force

function set_poshcontext() {
    export POSH=$(date)
}

function set_poshcontext() {
    export POSH=$(date)
}

function set_poshcontext
  set --export POSH $(date)
end

$env.SET_POSHCONTEXT = {
	$env.POSH = ( date now );
}

:::

Config variables

Example

<Config data={{ version: 4, var: { Hello: "hello", World: "world", }, blocks: [ { type: "prompt", alignment: "left", segments: [ { type: "text", style: "plain", foreground: "p:white", template: "{{ .Var.Hello }} {{ .Var.World }} ", }, ], }, ], }} metastring={{ json: "{3-6,16}", yaml: "{2-4,12}", toml: "{3-5,15}", }} />

Template logic

Helper functions

Sprig

Oh My Posh has all sprig functions included, meaning you can do operations on strings, paths and a lot of other manipulations straight from your template. Have a look at their documentation for available options and how to use them.

Custom

Cross segment template properties

To use another segment's template properties in a template, you can make use of {{ .Segments.Segment }} in your template where .Segment is the name of the segment you want to use with the first letter uppercased.

If you want to for example use the git segment's .UpstreamGone property in the status segment, you can do so like this:

<Config data={{ template: " {{ if .Segments.Git.UpstreamGone }}\ueb05{{ else if gt .Code 0 }}\uf00d{{ else }}\uf00c{{ end }} ", }} />

:::caution For this to work, the segment you refer to needs to be in your config. The above example won't work if your config does not contain a git segment as Oh My Posh only populates the properties when it needs to. :::

:::tip If you have two identical segments for a different purpose, you can make use of the alias property on the segment to distinct between both. :::

<Config data={{ segments: [ { type: "git", alias: "GitMain", style: "plain", foreground: "#ffffff", options: { branch_icon: "", }, }, { type: "git", alias: "GitSecondary", style: "plain", foreground: "#ffffff", options: { branch_icon: "", }, }, { type: "text", style: "plain", foreground: "#ffffff", template: "{{ .Segments.GitMain.HEAD }} - {{ .Segments.GitSecondary.HEAD }}", }, ], }} />

If you want to know if a specific segment is active, you can use the .Segments.Contains function, for example:

<Config data={{ template: '{{ if .Segments.Contains "Git" }}\ueb05{{ else if gt .Code 0 }}\uf00d{{ else }}\uf00c{{ end }} ', }} />

Text decoration

You can make use of the following syntax to decorate text:

This can be used in templates and icons/text inside your config.