Skip to content

SusSpotlightTour ​

SusSpotlightTour

Fullscreen onboarding overlay: scrim + Painter2D hole, glide between targets, AdvanceMode, Elevate, fluent tour builder (StepChanged / Completed / Cancelled).

Package

SusKit · Overlay (commercial)

Open in Playground

SusKit · Overlay

Props

NameTypeDefault
ModelProp<bool>falsev-model
CurrentIndexProp<int>-1v-model
ElevateProp<bool>truev-model
HolePaddingProp<float>8fv-model
GlideDurationProp<float>0.28fv-model
AdvanceModeProp<string>"ClickAnywhere"v-model
ShowCardProp<bool>truev-model

Slots

No slots.

Events

No public events.

Style hooks ​

USS class contract — override appearance without touching C#. States toggle via these classes:

  • sus-hidden
  • sus-spotlight-tour
  • sus-spotlight-tour__actions
  • sus-spotlight-tour__body
  • sus-spotlight-tour__card
  • sus-spotlight-tour__dim
  • sus-spotlight-tour__elevate
  • sus-spotlight-tour__elevated
  • sus-spotlight-tour__next
  • sus-spotlight-tour__scrim
  • sus-spotlight-tour__skip
  • sus-spotlight-tour__title
  • sus-spotlight-tour--elevate
  • sus-spotlight-tour--open

Usage ​

xml
<sus:SusSpotlightTour />