Teaching
Description
An onboarding walkthrough that highlights UI elements one by one
Teaching is a component for creating guided onboarding or instructional walkthroughs. It highlights specific UI elements sequentially, displaying a tooltip with contextual information at each step. Steps can require an explicit user action (clicking Next) or auto-advance after a fixed delay.
Use Teaching to help first-time users discover key features in a structured, low-friction way.
API reference
public class TeachingA component for creating onboarding or instructional walkthroughs.
Methods
public Teaching RunIf(Func<bool> condition)Runs the teaching walkthrough if the condition is met.
Parameters
- condition
- The condition.
Returns
The current instance.
public Teaching OnComplete(Action completed)Attaches a handler to the completed event.
Parameters
- completed
- The handler.
Returns
The current instance.
public Teaching FirstDelay(int milliseconds)Sets the initial delay before the walkthrough starts.
Parameters
- milliseconds
- The delay in milliseconds.
Returns
The current instance.
public Teaching StepDelay(int milliseconds)Sets the delay between steps.
Parameters
- milliseconds
- The delay in milliseconds.
Returns
The current instance.
public Teaching RunNow()Runs the teaching walkthrough immediately.
Returns
The current instance.
public Teaching AddStep(IComponent showFor, IComponent tooltip, TooltipAnimation animation = TooltipAnimation.ShiftToward, TooltipPlacement placement = TooltipPlacement.Top, StepType stepType = StepType.NextButton)Adds a step to the teaching walkthrough.
Parameters
- showFor
- The component to anchor the tooltip to.
- tooltip
- The tooltip content.
- animation
- The tooltip animation.
- placement
- The tooltip placement.
- stepType
- The step type.
Returns
The current instance.