IntegrationsPricing

Log in Start building

Start Product guides SDK examples SDK Packages

Packages Package reference

ES module class

createApiClient getInstance init isLoaded loadCheckout loadPortal loadWidgets preload preloadAll reset

BlockConstraint BlockDefinition Cart CartItem CheckoutModule CheckoutSessionPayload Customer Flow FlowContext FlowEvent FlowHandle FlowOpenOptions FlowResult FlowStartOptions FlowState FlowTemplate FrameConfig GateDefinition GateResult HarnessDefinition HarnessHooks MountOptions PageDefinition PaymentIntent PaymentResult PlandalfConfig PlandalfSDK PortalModule PortalMountOptions PortalOpenOptions PromoContext StepDefinition ThemeConfig ValidationResult VisitorIdentity WidgetMountOptions WidgetsModule

EventCallback FlowEventType FlowHandleEvent FlowHandleEventType FlowResultStatus FlowStatus FrameMode GateCheck GateResultStatus GateSyncCallback

FlowHandleEventType FlowResultStatus GateResultStatus

Referenced source types

ContinuityScope FlowSize MetadataValue ApiClient PromoHandle PromoHandleOptions

@plandalf/react

Gate Journey NumiPopupEmbed NumiStandardCheckout OfferFullScreenEmbed OfferPopupEmbed OfferStandardEmbed PlandalfProvider useCountdown useEmbedEvents useGate useGateTrigger useJourney useJourneyOptional useMessageListener useNumiEvents useNumiFrame usePlandalf usePresent usePromo useUser

BaseEmbedProps CheckoutConfig CheckoutHookReturn CheckoutItem CustomerInfo EmbedEventCallbacks FullScreenEmbedProps GateProps JourneyProps LegacyPopupEmbedProps PlandalfProviderProps PopupEmbedProps StandardCheckoutArgs StandardEmbedProps

JourneyContextValue JourneyOptions

FlowResultStatus NumiFullScreenEmbed NumiStandardEmbed

Referenced source types

JourneyType GateContextValue NumiFrame CountdownOptions NumiFrameOptions ResolvedPromo

Browse Packages

Package reference @plandalf/sdk ES module class Plandalf Named exports createApiClient getInstance init isLoaded loadCheckout loadPortal loadWidgets preload preloadAll reset Interfaces BlockConstraint BlockDefinition Cart CartItem CheckoutModule CheckoutSessionPayload Customer Flow FlowContext FlowEvent FlowHandle FlowOpenOptions FlowResult FlowStartOptions FlowState FlowTemplate FrameConfig GateDefinition GateResult HarnessDefinition HarnessHooks MountOptions PageDefinition PaymentIntent PaymentResult PlandalfConfig PlandalfSDK PortalModule PortalMountOptions PortalOpenOptions PromoContext StepDefinition ThemeConfig ValidationResult VisitorIdentity WidgetMountOptions WidgetsModule Type aliases EventCallback FlowEventType FlowHandleEvent FlowHandleEventType FlowResultStatus FlowStatus FrameMode GateCheck GateResultStatus GateSyncCallback Constants FlowHandleEventType FlowResultStatus GateResultStatus Referenced source types ContinuityScope FlowSize MetadataValue ApiClient PromoHandle PromoHandleOptions @plandalf/react Functions Gate Journey NumiPopupEmbed NumiStandardCheckout OfferFullScreenEmbed OfferPopupEmbed OfferStandardEmbed PlandalfProvider useCountdown useEmbedEvents useGate useGateTrigger useJourney useJourneyOptional useMessageListener useNumiEvents useNumiFrame usePlandalf usePresent usePromo useUser Interfaces BaseEmbedProps CheckoutConfig CheckoutHookReturn CheckoutItem CustomerInfo EmbedEventCallbacks FullScreenEmbedProps GateProps JourneyProps LegacyPopupEmbedProps PlandalfProviderProps PopupEmbedProps StandardCheckoutArgs StandardEmbedProps Type aliases JourneyContextValue JourneyOptions Constants FlowResultStatus NumiFullScreenEmbed NumiStandardEmbed Referenced source types JourneyType GateContextValue NumiFrame CountdownOptions NumiFrameOptions ResolvedPromo

Function: useJourney()

export function useJourney(): JourneyContextValue

Defined in: embeds/Journey.tsx:40

Returns

JourneyContextValue

PrevioususeGateTrigger NextuseJourneyOptional

Feature detail

Related