CardElementOptions.md

@bigcommerce/checkout-sdk / CardElementOptions

Interface: CardElementOptions

Hierarchy

• BaseElementOptions_2

  ↳ CardElementOptions

Table of contents

Properties

• classes
• disabled
• hideIcon
• hidePostalCode
• iconStyle
• style
• value

Properties

classes

• Optional classes: StripeElementClasses

Set custom class names on the container DOM element when the Stripe element is in a particular state.

Inherited from

BaseElementOptions_2.classes

---

disabled

• Optional disabled: boolean

Applies a disabled state to the Element such that user input is not accepted. Default is false.

Inherited from

BaseElementOptions_2.disabled

---

hideIcon

• Optional hideIcon: boolean

---

hidePostalCode

• Optional hidePostalCode: boolean

Hide the postal code field. Default is false. If you are already collecting a full billing address or postal code elsewhere, set this to true.

---

iconStyle

• Optional iconStyle: IconStyle

Appearance of the icon in the Element.

---

style

• Optional style: StripeElementStyle

Customize the appearance of an element using CSS properties passed in a Style object, which consists of CSS properties nested under objects for each variant.

Inherited from

BaseElementOptions_2.style

---

value

• Optional value: string

A pre-filled set of values to include in the input (e.g., {postalCode: '94110'}). Note that sensitive card information (card number, CVC, and expiration date) cannot be pre-filled