Bevy Nested Tooltips

A library for creating headless(unstyled) tooltips that can be arbitrarily nested and highlight other nodes.

Features

This library strives to handle the logic behind common tooltip features, while you focus on your unique data and design needs.

• Tooltips can be spawned by hovering or by user pressing the middle mouse button, your choice which and you can change at runtime.
• Nesting to arbitrary levels, the only limitation is memory.
• Despawns if the user hasn't interacted with them in a configurable time period, or they mouse away after interacting with them.
• Locking by pressing of the middle mouse button. using observers you can implement your specific design to inform your users.
• Highlight other Entites using a linked text, highlight designs are up to you.

Usage

Import the prelude

use bevy_nested_tooltips::prelude::*;

Add the plugin

        .add_plugins((
            NestedTooltipPlugin,
        ))

(Optional) Configure tooltips

    commands.insert_resource(TooltipConfiguration {
        activation_method: ActivationMethod::MiddleMouse,
        ..Default::default()
    });

Load your tooltips

    let mut tooltip_map = TooltipMap {
        map: HashMap::new(),
    };

    tooltip_map.insert(
        "tooltip".into(),
        ToolTipsData::new(
            "ToolTip",
            vec![
                TooltipsContent::String("A way to give users infomation can be ".into()),
                TooltipsContent::Term("recursive".into()),
                TooltipsContent::String(" Press middle mouse button to lock me. ".into()),
            ],
        ),
    );

    tooltip_map.insert(
        "recursive".into(),
        ToolTipsData::new(
            "Recursive",
            vec![
                TooltipsContent::String("Tooltips can be ".into()),
                TooltipsContent::Term("recursive".into()),
                TooltipsContent::String(
                    " You can highlight specific ui panels with such as the ".into(),
                ),
                TooltipsContent::Highlight("sides".into()),
                TooltipsContent::String(" Press middle mouse button to lock me. ".into()),
            ],
        ),
    );

Add links to relevant entities

TooltipHighlight("sides".into()),

Or

 TooltipTermLink::new("tooltip"),

Style your tooltips

Check the examples files for examples.

Limitations

This plugin assumes a single fullscreen and camera is used.

Using this library when not fullscreen will likely trigger the links at the wrong time, this limitation will be removed once textspans support observers.

Bevy compatability