---
id: ui5tooling
title: UI5 Tooling
sidebar_label: UI5 Tooling
---

## What

Display the active [UI5 tooling][ui5-homepage] version (global or local if present -
see [the documentation][ui5-version-help]).

## Sample Configuration

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

<Config
  data={{
    background: "#f5a834",
    foreground: "#100e23",
    powerline_symbol: "\ue0b0",
    template: " \uf0adui5 {{ .Full }} ",
    style: "powerline",
    type: "ui5tooling",
  }}
/>

## Properties

| Name                   | Type       | Description                                                                                                                                                                                                                                                                                                                                                      |
| ---------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled`         | `boolean`  | display the segment in the HOME folder or not - defaults to `false`                                                                                                                                                                                                                                                                                              |
| `fetch_version`        | `boolean`  | display the UI5 tooling version - defaults to `true`                                                                                                                                                                                                                                                                                                             |
| `missing_command_text` | `string`   | text to display when the java command is missing - defaults to empty                                                                                                                                                                                                                                                                                             |
| `display_mode`         | `string`   | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*ui5*.y(a)ml` file is present in the current folder</li><li>`context`: the segment is only displayed when `*ui5*.y(a)ml` file is present in the current folder or it has been found in the parent folders (check up to 4 levels) (**default**) </li></ul> |
| `version_url_template` | `string`   | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes                                                                                                                                                                                                                                            |
| `extensions`           | `[]string` | allows to override the default list of file extensions to validate                                                                                                                                                                                                                                                                                               |
| `folders`              | `[]string` | allows to override the list of folders names to validate                                                                                                                                                                                                                                                                                                         |
| `cache_version`        | `boolean`  | cache the executable's version or not - defaults to `false`                                                                                                                                                                                                                                                                                                      |

## Template ([info][templates])

:::note default template

```template
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
```

:::

### Properties

| Name     | Type     | Description                                        |
| -------- | -------- | -------------------------------------------------- |
| `.Full`  | `string` | the full version                                   |
| `.Major` | `string` | major number                                       |
| `.Minor` | `string` | minor number                                       |
| `.Patch` | `string` | patch number                                       |
| `.URL`   | `string` | URL of the version info / release notes            |
| `.Error` | `string` | error encountered when fetching the version string |

[go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates
[ui5-homepage]: https://sap.github.io/ui5-tooling
[ui5-version-help]: https://sap.github.io/ui5-tooling/pages/CLI/#ui5-versions