@paypal/react-paypal-js
Version:
React components for the PayPal JS SDK
27 lines (26 loc) • 1.12 kB
TypeScript
import type { ButtonProps } from "../types";
import type { UsePayPalOneTimePaymentSessionProps } from "../hooks/usePayPalOneTimePaymentSession";
type PayPalOneTimePaymentButtonProps = UsePayPalOneTimePaymentSessionProps & ButtonProps & {
autoRedirect?: never;
};
/**
* `PayPalOneTimePaymentButton` is a button that provides a standard PayPal payment flow.
*
* `PayPalOneTimePaymentButtonProps` combines the arguments for {@link UsePayPalOneTimePaymentSessionProps}
* and {@link ButtonProps}.
*
* Note, `autoRedirect` is not allowed because if given a `presentationMode` of `"redirect"` the button
* would not be able to provide back `redirectURL` from `start`. Advanced integrations that need
* `redirectURL` should use the {@link usePayPalOneTimePaymentSession} hook directly.
*
* @example
* <PayPalOneTimePaymentButton
* onApprove={() => {
* // ... on approve logic
* }}
* orderId="your-order-id"
* presentationMode="auto"
* />
*/
export declare const PayPalOneTimePaymentButton: ({ type, disabled, ...hookProps }: PayPalOneTimePaymentButtonProps) => JSX.Element | null;
export {};