Reading progress

use RoundlyConsulting\Onboarding\Facades\Onboarding;

$flow = Onboarding::for($user);  // a copy bound to $user — or $user->onboarding()

$flow?->title;                   // "Profile Onboarding"
$flow?->isCompleted();           // bool — every required, non-excluded step is complete
$flow?->isInProgress();          // bool — at least one required step remains
$flow?->currentStep();           // the first incomplete Step (the one to resume on), or null
$flow?->steps();                 // Collection<int, Step> visible to this model (excluded steps removed)
$flow?->all();                   // Collection<int, Step> including excluded steps
$flow?->percentageCompleted();   // float across all visible steps, e.g. 66.67
$flow?->sections();              // Collection<int, SectionData> grouped by step group
$flow?->redirectToCurrentStep(); // ?RedirectResponse to the current step's target
$flow?->toArray();               // a JSON-ready array for your API/frontend
$flow?->toData();                // a typed FlowData DTO

// three visible steps, only the first one complete
$flow->count();                 // 3
$flow->completedCount();        // 1
$flow->position();              // 2 — "step 2 of 3"
$flow->currentStepIndex();      // 1 — 0-based, null when complete
$flow->isStarted();             // true — at least one step complete
$flow->isEmpty();               // false
$flow->percentageCompleted();   // 33.33

<p>Step {{ $flow->position() }} of {{ $flow->count() }}</p>