Skip to main content

PurseHeadlessCheckoutXPayButtonUIOptions

Apple, Google and PayPal buttons are treated differently and all the config is exposed through this object.

Properties​

apple?​

optional apple?: object;

borderRadius?​

optional borderRadius?: string;

buttonstyle?​

optional buttonstyle?: "black" | "white" | "white-outline";

height?​

optional height?: string;

locale?​

optional locale?: string;

Locale code is a combination of ISO 639-1 language code and ISO 3166-1 country code . For example, fr_FR is a locale code for French language in France.

Example​
'fr-FR'

padding?​

optional padding?: string;

type?​

optional type?: 
  | "plain"
  | "buy"
  | "donate"
  | "check-out"
  | "book"
  | "subscribe"
  | "add-money"
  | "contribute"
  | "order"
  | "reload"
  | "rent"
  | "support"
  | "tip"
  | "top-up";

width?​

optional width?: string;

google?​

optional google?: Partial<Pick<ButtonOptions, 
  | "buttonColor"
  | "buttonType"
  | "buttonLocale"
  | "buttonRadius"
  | "buttonSizeMode">> & object;

Type Declaration​

height?​
optional height?: number;

paypal?​

optional paypal?: object;

color?​

optional color?: "black" | "white" | "silver" | "gold" | "blue";

disableMaxWidth?​

optional disableMaxWidth?: boolean;

When true, removes the max-width constraint applied by PayPal on the button container. See https://developer.paypal.com/sdk/js/reference/#width

height?​

optional height?: number;

label?​

optional label?: "paypal" | "checkout" | "buynow" | "pay" | "installment";

layout?​

optional layout?: "vertical" | "horizontal";

shape?​

optional shape?: "rect" | "pill";