Expand description
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 TooltipSettings
.
Modules§
- prelude
- Re-exports for commonly used types.
Structs§
- Rich
Text - A rich text string in the shape of Bevy 0.14’s
Text
component. - Rich
Text Systems - A
SystemSet
for the systems that update rich text entities inPostUpdate
. - Text
Section - A section of
RichText
in the shape of Bevy 0.14’sTextSection
. - Text
Style - A text style in the shape of Bevy 0.14’s
TextStyle
. - Tooltip
- A
Component
that specifies a tooltip to be displayed on hover. - Tooltip
Activation - Tooltip activation conditions.
- Tooltip
Dismissal - Tooltip dismissal conditions.
- Tooltip
Placement - The tooltip placement configuration.
- Tooltip
Plugin - A
Plugin
that sets up the tooltip widget system. - Tooltip
Settings - A
Resource
containing theEntity
IDs of the global primary tooltip. - Tooltip
Transfer - Tooltip transfer conditions.
Enums§
- Tooltip
Content - Tooltip content to be displayed.
- Tooltip
Systems - A
SystemSet
for tooltip systems.