> For the complete documentation index, see [llms.txt](https://docs.eximee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.eximee.com/documentation/documentation-en/budowanie-aplikacji/interfejs-uzytkownika/formularze/praca-z-komponentami-bazowymi/pomoc-kontekstowa.md).

# Context help

Most components in Eximee Designer can have context help defined. Exceptions are components **QR code generator** and **Page**.

<figure><img src="https://2112972046-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2FAJFsHSGojqoYKF3MtRsS%2Fimage.png?alt=media&amp;token=c59b3184-718e-44bb-8fea-92c8a97adcfd" alt=""><figcaption><p align="center"><em><strong>Figure 1.</strong> Appearance of the property that provides access to the context help editor</em></p></figcaption></figure>

When entering the context help editor, a drawer slides out. If the component has no context help added, the drawer contents look as shown in the illustration below.

<figure><img src="https://2112972046-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2FmSfXS3D1VCwS5399vHtx%2Fimage.png?alt=media&amp;token=66158061-7a69-4656-9ec5-4f3e5e5abbbd" alt=""><figcaption><p align="center"><em><strong>Figure 2.</strong> Appearance of the editor drawer with no context helps added</em></p></figcaption></figure>

Clicking the button located at the bottom of the drawer **Add context help** adds an item to the drawer. It represents a new context help.

<figure><img src="https://2112972046-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2FtulPS6bGZIlxv5vvLdiu%2Fimage.png?alt=media&amp;token=05c7218c-a572-4dcc-920b-abf074994ed2" alt=""><figcaption><p align="center"><em><strong>Figure 3.</strong> Appearance of the newly added and unconfigured context help</em><br></p></figcaption></figure>

The basic editable properties are the context help key name and its display condition.

Before adding a key with the help content, the key and its content should be added in the tab **Translations**. Editing is done by clicking in the field **Enter key name**.

In the field **Add condition** you can define dynamic context help with content depending on conditions:

* session variable values,
* values of other components.

If several context helps are defined, only the first context help whose condition is met will be displayed. To change the order of the help content, drag & drop functionality can be used.

<figure><img src="https://2112972046-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2Fbgb6OGXHabAYI5lGMWqE%2Fimage.png?alt=media&amp;token=7be80d14-c052-49e9-9968-ed57f285cb67" alt=""><figcaption><p align="center"><em><strong>Figure 4.</strong> Example of two different context helps defined and displayed conditionally</em></p></figcaption></figure>

Clicking in **Show details** expands the tile and allows access to additional options, visible in the illustration below:

<figure><img src="https://2112972046-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2FWVirCyXrwPJoVhANli4x%2Fimage.png?alt=media&amp;token=4f8fb9d4-d066-455e-b1de-153c389e2f20" alt=""><figcaption><p align="center"><em><strong>Figure 5.</strong> Appearance of the expanded context help editing window</em></p></figcaption></figure>

In the detailed view, the following properties can be defined:

* **Style name** - name of the style to be applied to the context help,
* **Help icon** - determine whether a context help icon should be displayed,
* **Visible on field focus** - determine whether context help should be displayed during selection,
* **Interactive context help** - determine whether it will be possible to interact with the context help content,
* **Width/Height** context help tooltip,
* **Position** of the context help relative to the component it applies to.

In the context help editor drawer, multiple tooltips can be defined. They are then considered from top to bottom. Each context help tile has a handle on the left side that allows you to grab it and then move it to the desired position. In this way the entire list can be sorted and the order of the items changed.

**Context help visibility**

In the detailed view, one of two ways of presenting context help must be specified:

* Help icon,
* Visible on field focus.

Context help visibility is also controlled by an optional condition.

<figure><img src="https://2112972046-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2F9tVYoYCTtDKRgoJWg29E%2Fimage.png?alt=media&amp;token=c4db43e0-ebf7-4e1a-8453-55dac006efde" alt=""><figcaption><p align="center"><em><strong>Figure 6.</strong> Example appearance of the tooltip in the application</em></p></figcaption></figure>

<figure><img src="https://2112972046-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2FAyY2OjiurZb8TYFJdfAK%2Fimage.png?alt=media&amp;token=c0ef40a0-f5f8-4e46-9e0f-973fa7f2f097" alt=""><figcaption><p align="center"><em><strong>Figure 7.</strong> Example appearance of the tooltip in the application</em></p></figcaption></figure>

{% hint style="info" %}
Demo application: demoTooltips
{% endhint %}

{% hint style="info" %}
♿WCAG: [Good WCAG practices for low-code dev](/documentation/documentation-en/budowanie-aplikacji/proces-biznesowy/tworzenie-procesu-biznesowego-w-bpmn-2.0/dobre-praktyki.md)
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.eximee.com/documentation/documentation-en/budowanie-aplikacji/interfejs-uzytkownika/formularze/praca-z-komponentami-bazowymi/pomoc-kontekstowa.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.