@paypal/paypal-js
    Preparing search index...

    Type Alias LearnMoreBase

    Base type for all LearnMore implementations. Represents the common public API shared by all LearnMore variants.

    type LearnMoreBase = {
        close: (trigger?: string) => void;
        isOpen: boolean;
        open: (userLearnMoreOptions?: LearnMoreOptions) => Promise<void>;
        setupPostMessenger: () => void;
        show: () => void;
        update: (userLearnMoreOptions?: LearnMoreOptions) => Promise<void>;
    }
    Index

    Properties

    close isOpen open setupPostMessenger show update

    Properties

    close: (trigger?: string) => void

    Closes the Learn More presentation.

    Type Declaration

      • (trigger?: string): void

      • Parameters

        • Optionaltrigger: string

          Optional trigger identifier (e.g., "viaCustomButton").

        Returns void

    isOpen: boolean

    Indicates whether the Learn More presentation is currently open.

    open: (userLearnMoreOptions?: LearnMoreOptions) => Promise<void>

    Opens the Learn More presentation.

    Type Declaration

      • (userLearnMoreOptions?: LearnMoreOptions): Promise<void>

      • Parameters

        • OptionaluserLearnMoreOptions: LearnMoreOptions

          Optional configuration to update before opening.

        Returns Promise<void>

        Promise that resolves when the presentation is opened and configured.

    setupPostMessenger: () => void

    Sets up the PostMessenger for communication with the Learn More content.

    show: () => void

    Shows the Learn More presentation (internal display method).

    update: (userLearnMoreOptions?: LearnMoreOptions) => Promise<void>

    Updates the Learn More presentation with new options.

    Type Declaration

      • (userLearnMoreOptions?: LearnMoreOptions): Promise<void>

      • Parameters

        Returns Promise<void>

        Promise that resolves when the update is complete.

    Settings

    On This Page

    Properties