Crate pyri_tooltip

Powerful tooltips for Bevy.

Getting started

Import the prelude to bring common types into scope:

use pyri_tooltip::prelude::*;

Add TooltipPlugin to set up the tooltip system:

app.add_plugins(TooltipPlugin::default());

Spawn a UI node with the Tooltip component:

commands.spawn(Tooltip::cursor("Hello, world!"));

Advanced

To customize the behavior and appearance of a tooltip, see Tooltip.

To replace the default primary tooltip, see TooltipPlugin and PrimaryTooltip.

Modules

prelude

Re-exports for commonly used types.

Structs

PrimaryTooltip

A Resource containing the Entity IDs of the global primary tooltip.

RichText

A rich text string in the shape of Bevy 0.14’s Text component.

RichTextSystems

A system set for the systems that update rich text entities in PostUpdate.

TextSection

A section of RichText in the shape of Bevy 0.14’s TextSection.

TextStyle

A text style in the shape of Bevy 0.14’s TextStyle.

Tooltip

A Component that specifies a tooltip to be displayed on hover.

TooltipActivation

Tooltip activation conditions.

TooltipDismissal

Tooltip dismissal conditions.

TooltipPlacement

The tooltip placement configuration.

TooltipPlugin

A Plugin that sets up the tooltip widget system.

TooltipTransfer

Tooltip transfer conditions.

Enums

TooltipContent

Tooltip content to be displayed.

TooltipSet

A SystemSet for tooltip systems.