Skip to content

SusTooltip

Package

SusKit · Overlay (commercial)

Rich hover card (.sharq). For app-wide hover APIs prefer TooltipService + WithTooltip — see the Tooltips guide.

No API metadata for SusTooltip. Run npm run extract.

TooltipService (kit)

Wire once at bootstrap (OverlayHost from SusApp / SusBootstrap):

csharp
var tooltip = new TooltipService();
tooltip.Init(app.Overlay);
tooltip.CreateTooltip = () => new SusTooltip();
TooltipService.Instance = tooltip;

Fluent API

csharp
// Text
button.WithTooltip("Click to save");
icon.WithTooltip("Help", TooltipPlacement.Right);

// Rich entry (CreateCard factory)
spell.WithTooltip(new SusTooltipCardEntry {
    Title = "Fireball",
    Description = "Damage 50–70",
});

// Custom VisualElement card (ShowContent) — any factory
slot.WithTooltip(() => BuildItemCard(item), TooltipPlacement.Right);
APIRole
ShowAtElementText via CreateTooltip
ShowContentCustom Func<VisualElement> on OverlayHost Tooltip layer
ShowRichSusTooltipCardEntry via CreateCard
Hide / HideAfterDelayDismiss

Only one service tooltip is active at a time. Placement: Auto / Top / Bottom / Left / Right with edge clamp.

Component usage

xml
<sus:SusTooltip Text="activator">
  <ui:VisualElement /><!-- hover target -->
</sus:SusTooltip>

SusTooltip teleports its card to OverlayHost on open (same Tooltip category as the service).

Rarity headers

Inventory / item cards may set sus-tooltip--rarity-*. Colors come from kit tokens --sk-rarity-* (override in consumer theme):

ClassToken
…--rarity-common--sk-rarity-common
…--rarity-uncommon--sk-rarity-uncommon
…--rarity-rare--sk-rarity-rare
…--rarity-epic--sk-rarity-epic
…--rarity-legendary--sk-rarity-legendary
…--rarity-exotic--sk-rarity-exotic

Open-core: Core & Router MIT · Kit & Game commercial