Function useOnboardingStep

  • useOnboardingStep(
        step: OnboardingStep,
    ): {
        isCurrentStep: boolean;
        isStepActive: boolean;
        completeStep: () => void;
    }

    Hook for tracking and controlling onboarding progress for a specific step.

    Parameters

    Returns { isCurrentStep: boolean; isStepActive: boolean; completeStep: () => void }

    Object with step state and completion control.

    • isCurrentStep: boolean
    • isStepActive: boolean
    • completeStep: () => void

    Source

    export function useOnboardingStep(step: OnboardingStep) {
      const { isActive, currentStep, isStepActive, completeStep } = useOnboarding();

      const isCurrentStep = isStepActive(step) && isActive;

      /**
       * Call this when the user has completed the action for this step.
       * @source
       */
      const markStepComplete = () => {
        completeStep(step);
      };

      return {
        isCurrentStep,
        isStepActive: currentStep === step,
        completeStep: markStepComplete,
      };
    }

Settings

Member Visibility