Slint Kit Documentation

Feedback and progress

KitTooltip

Short help associated with a control’s hover and focus.

Short help associated with a control’s hover and focus.
Native screenshot of the same example, rendered with Skia.

Wrap the control as a child, set text and bind target-focused to its has-focus. Mount a KitTooltipLayer at the window root for keyboard help.

Hover uses a native tooltip that does not intercept input; focus publishes a projection in the window layer. Escape or dismiss() hides help until the next focus cycle.

Complete example

This complete Slint file is a visual composition used to produce the screenshot above. Internal strings without a label property retain the kit’s default language; system dialogs follow the host platform. Projected state and callbacks requesting a decision need host wiring; the standalone fixture does not supply that controller. Set up the Rust project, then see the typed controller application for working editing, validation and selection.

// SPDX-License-Identifier: GPL-3.0-or-later
import { KitButton, KitTheme, KitThemes, KitTooltip, KitTooltipLayer } from "@kit/kit.slint";

export component Example inherits Window {
    title: "KitTooltip example";
    preferred-width: 360px;
    preferred-height: 220px;
    max-width: 100000px;
    max-height: 100000px;
    background: root.theme.canvas;
    in-out property <KitTheme> theme: KitThemes.light;
    in-out property <string> status;
    VerticalLayout {
        padding: 24px; spacing: 16px; alignment: start;
        Text { text: "Tooltip"; color: root.theme.text-primary; font-size: 20px * root.theme.text-scale; font-weight: 600; }
        KitTooltip { theme: root.theme; text: "Create a new project in this workspace."; target-focused: true; viewport-width: root.width; viewport-height: root.height; KitButton { theme: root.theme; text: "New project"; activated => { root.status = "Action requested"; } } }
        if root.status != "": Text { text: root.status; color: root.theme.text-secondary; font-size: 12px * root.theme.text-scale; wrap: word-wrap; }
    }
    KitTooltipLayer { viewport-width: root.width; viewport-height: root.height; }
}

Download this example

Public API

Inherits Rectangle. The declarations below come from the component source. Parent properties remain available; see the controller guide for state management.

Properties

Name Type Direction
theme KitTheme in
text string in
target-focused bool in
viewport-width length in
viewport-height length in
keyboard-visible bool out

Functions

See also