Inttegro Web SDKs - v0.5.4
    Preparing search index...

    Interface CheckoutPropsBase

    Props accepted by the Inttegro Checkout component.

    features, the Checkout reference, presentation, timeout, and title identify a hosted experience; changing one destroys the current controller and mounts or presents a new one. appearance and locale update the current controller in place.

    interface CheckoutPropsBase {
        appearance?: CheckoutAppearance;
        class?: string;
        features?: CheckoutFeatures;
        locale?: string;
        onCanceled?: (event: CheckoutCanceledEvent) => void;
        onCompleted?: (event: CheckoutCompletedEvent) => void;
        onError?: (error: Error) => void;
        onEvent?: (event: CheckoutEvent) => void;
        onFailed?: (event: CheckoutFailedEvent) => void;
        onReady?: (event: CheckoutReadyEvent) => void;
        presentation?: CheckoutPresentation;
        timeout?: number;
        title?: string;
    }
    Index
    appearance? class? features? locale? onCanceled? onCompleted? onError? onEvent? onFailed? onReady? presentation? timeout? title?
    appearance?: CheckoutAppearance

    Initial and reactive theme preference for hosted Checkout.

    class?: string

    CSS class applied to the outer container owned by your Svelte application.

    features?: CheckoutFeatures

    Hosted Checkout content and actions. Changing it replaces the controller.

    locale?: string

    Initial and reactive BCP 47 locale preference.

    onCanceled?: (event: CheckoutCanceledEvent) => void

    Called when a payer dismisses managed modal Checkout before completion.

    onCompleted?: (event: CheckoutCompletedEvent) => void

    Called after the successful hosted terminal state. Reconcile the Order on your server before fulfillment.

    onError?: (error: Error) => void

    Called for loader or mount failures.

    onEvent?: (event: CheckoutEvent) => void

    Called for every sanitized lifecycle event.

    onFailed?: (event: CheckoutFailedEvent) => void

    Called when Checkout reaches a terminal failure state.

    onReady?: (event: CheckoutReadyEvent) => void

    Called once Checkout is initialized and interactive.

    presentation?: CheckoutPresentation

    Displays Checkout inline by default or in an Inttegro-managed modal.

    timeout?: number

    Mount timeout from 1,000–60,000 ms; defaults to 15,000 ms.

    title?: string

    Accessible iframe title; defaults to Checkout.

    Settings
    Member Visibility

    On This Page
    Properties