> For the complete documentation index, see [llms.txt](https://zsx-development.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zsx-development.gitbook.io/docs/resources/user-interface-v2/exports/interfaces/help-notification.md).

# Help Notification

Help Notifications are displayed in the top-left corner of the screen. They are specifically designed to manage job-related updates and other critical tasks.

### Add

To add Help Notification, you can simply call the export:

```lua
exports['ZSX_UIV2']:HelpNotification(data)
```

Data object contains:

<pre class="language-lua"><code class="lang-lua"><strong>-- Example with text as an object (it creates thing like tasks-list)
</strong><strong>local data = {
</strong>    icon = 'fas fa-warehouse',
    header = 'Task Example',
    text = {
        {
            name = 'point1', -- make sure to add name otherwise it won't be added!
            active = true, -- make sure to set one as an active element!
            complete = false,
            text = 'Go to Point #1',
        }, {
            name = 'point2',
            active = false,
            complete = false,
            text = 'Finish by going to Point #2',
        }
    }
}

-- Example with text as an string
local data = {
    icon = 'fas fa-warehouse',
    header = 'Task Example',
    text = 'Do anything else!'
}
</code></pre>

#### Data layout

<table><thead><tr><th>Key</th><th width="547">Value</th><th data-type="checkbox">Optional</th></tr></thead><tbody><tr><td>icon</td><td><mark style="color:green;">String</mark><br>Icon of the help notification, <a href="https://fontawesome.com/v5/search">list</a></td><td>false</td></tr><tr><td>header</td><td><mark style="color:green;">String</mark><br>Header of the help notification.</td><td>false</td></tr><tr><td>text</td><td><mark style="color:green;">String</mark>/<mark style="color:yellow;">Object</mark><br>Text/<a href="#text-as-object-layout">Object</a> of the help notification.</td><td>false</td></tr></tbody></table>

#### Text as object layout

<table><thead><tr><th width="136">Key</th><th width="547">Value</th><th data-type="checkbox">Optional</th></tr></thead><tbody><tr><td>name</td><td><mark style="color:green;">String</mark><br>Unique name of the task.</td><td>false</td></tr><tr><td>active</td><td><mark style="color:orange;">Boolean</mark><br>Mark stage as active (current).</td><td>true</td></tr><tr><td>complete</td><td><mark style="color:orange;">Boolean</mark><br>Mark stage as already done.</td><td>true</td></tr><tr><td>text</td><td><mark style="color:green;">String</mark><br>Text of the stage</td><td>false</td></tr></tbody></table>

### Manually updating stage

This mainly focuses on the text as an object, since you can't update the stage for non-task element.

```lua
exports['ZSX_UIV2']:HelpNotification_UpdateStage(data)
```

Data object contains:

```lua
-- Updating stage by switching element to active one
local data = {
    stage = 'point1',
    key = 'active',
    value = true
}
```

<table><thead><tr><th width="146">Key</th><th>Value</th></tr></thead><tbody><tr><td>stage</td><td><mark style="color:green;">String</mark><br>Unique name set for the stage.</td></tr><tr><td>key</td><td><mark style="color:green;">String</mark><br>Key of the updated element.</td></tr><tr><td>value</td><td><mark style="color:orange;">Boolean</mark><br>Value of the updated element.</td></tr></tbody></table>

### Marking stage as active

```lua
exports['ZSX_UIV2']:HelpNotification_SetStageAsActive(stageName)
```

### Marking stage as complete

```etlua
exports['ZSX_UIV2']:HelpNotification_SetStageAsComplete(stageName)
```

### Remove

In order to remove Help Notification you can use that export:

```lua
exports['ZSX_UIV2']:HelpNotification_Remove()
```