Teleforge API Reference - v0.1.0
    Preparing search index...

    Interface CoordinationProviderProps

    interface CoordinationProviderProps {
        children: ReactNode;
        currentRoute?: string | null;
        config?: ResolvedCoordinationConfig;
        flowSnapshot?: Record<string, unknown>;
        manifest?: TeleforgeManifest;
        navigate?: (route: string, options?: { replace?: boolean }) => void;
        persistFlowState?: (
            input: PersistFlowStateInput,
        ) => UserFlowState | Promise<UserFlowState | null> | null;
        resolveRouteCoordination?: (
            route: string,
            manifest: TeleforgeManifest | null,
        ) => RouteCoordinationMetadata | null;
        resolveStepRoute?: (
            stepId: string,
            state: UserFlowState | null,
        ) => string | null;
        resolveStepState?: (
            route: string,
            state: UserFlowState | null,
        ) => string | null;
        indicatorDurationMs?: number;
        onFreshStart?: (reason: ResumeFlowError | null) => void;
        onResume?: (result: ResumeFlowSuccess) => void;
        parseFlowId?: () => string | null;
        resolveRoute?: (state: UserFlowState) => string | null;
        resolver: FlowStateResolver;
    }

    Hierarchy (View Summary)

    Index

    Properties

    children: ReactNode
    currentRoute?: string | null
    flowSnapshot?: Record<string, unknown>
    navigate?: (route: string, options?: { replace?: boolean }) => void
    persistFlowState?: (
        input: PersistFlowStateInput,
    ) => UserFlowState | Promise<UserFlowState | null> | null
    resolveRouteCoordination?: (
        route: string,
        manifest: TeleforgeManifest | null,
    ) => RouteCoordinationMetadata | null
    resolveStepRoute?: (
        stepId: string,
        state: UserFlowState | null,
    ) => string | null
    resolveStepState?: (route: string, state: UserFlowState | null) => string | null
    indicatorDurationMs?: number
    onFreshStart?: (reason: ResumeFlowError | null) => void
    onResume?: (result: ResumeFlowSuccess) => void
    parseFlowId?: () => string | null
    resolveRoute?: (state: UserFlowState) => string | null