Interface OnboardingStepConfig

Configuration and metadata for a single onboarding step.

Source

export interface OnboardingStepConfig {
  id: OnboardingStep;
  title: string;
  description: string;
  instructions: string;
  icon: string;
  optional?: boolean;
}
interface OnboardingStepConfig {
    id: OnboardingStep;
    title: string;
    description: string;
    instructions: string;
    icon: string;
    optional?: boolean;
}

Properties

id title description instructions icon optional?

Properties

id

id: OnboardingStep

Unique identifier matching an OnboardingStep.

title

title: string

User-facing title displayed in the UI.

description

description: string

Brief description of the step's purpose.

instructions

instructions: string

Detailed instructions for completing the step.

icon

icon: string

Icon name (e.g., "Sparkles", "Upload") from icon library.

Optionaloptional

optional?: boolean

Whether this step can be skipped (optional steps still mark completion).

Settings

Member Visibility

On This Page

Properties