# AtlasToolTip

> A small rounded hint on a raised card, opened after the hover delay.

AtlasToolTip is the tool tip for Atlas apps. Declare it inside the item it describes, set `text`, and bind `shown` to the hover state of its parent. Bind it to the keyboard focus too, so keyboard users get the hint.

AtlasToolTip is a Qt Quick Templates `ToolTip` ([Qt documentation](https://doc.qt.io/qt-6/qml-qtquick-controls-tooltip.html)); its inherited properties (`text`, `delay`, `timeout`) work as usual. It opens after the hover delay, closes at once when `shown` ends and goes by itself after a while.

## Example

```qml
AtlasButton {
    text: qsTr("Refresh")
    AtlasToolTip {
        text: qsTr("Check for updates")
        shown: parent.hovered || parent.visualFocus
    }
}
```

## Properties

| Name | Type | Default | Description |
|---|---|---|---|
| `shown` | `bool` | `false` | Opens the tip after the hover delay when it becomes true and closes it at once when it becomes false. Usually bound to the parent's hover state. |

> [!NOTE]
> Setting `visible` opens the tip at once, without the delay. The text is plain text.