startGuide method

void startGuide(
  1. List<GuideStep> steps
)

Starts the onboarding process with the provided steps.

steps - List of onboarding steps to display in sequence.

The onboarding will begin immediately and show the first step. Make sure all target widgets are already rendered before calling this.

Example:

controller.startGuide([
  GuideStep(
    targetKey: _menuKey,
    title: 'Menu',
    description: 'Access app features here.',
  ),
]);

Implementation

void startGuide(List<GuideStep> steps) {
  steps = steps;
  _currentStep = 0;
  _isActive = true;
  notifyListeners();
  _showOverlay();
}