Elements Appearance API

Themes

Start customizing Elements by selecting one of the following themes:

• stripe
• night
• flat

const appearance = {
  theme: 'night'
};

// Pass the appearance object when initializing checkout
const checkout = stripe.initCheckoutElementsSdk({clientSecret, elementsOptions: {appearance}});

Inputs and labels

Customize the appearance of input fields and their associated labels.

const appearance = {
  inputs: 'spaced',
  labels: 'auto'
}

Inputs

Choose the style of input fields to suit your design.

Labels

Control the position and visibility of labels associated with input fields.

Variables

Set variables to affect the appearance of many components appearing throughout each Checkout element.

[Payment form with card input fields, major credit card icons, and Klarna payment option, with labeled Appearance API variables for colors and styling.]

The variables option works like CSS variables. You can specify CSS values for each variable and reference other appearance variables with the var(--myVariable) syntax. You can even inspect the resulting DOM using the DOM explorer in your browser.

const appearance = {
  theme: 'stripe',

  variables: {
    colorPrimary: '#0570de',
    colorBackground: '#ffffff',
    colorText: '#30313d',
    colorDanger: '#df1b41',
    fontFamily: 'Ideal Sans, system-ui, sans-serif',
    spacingUnit: '2px',
    borderRadius: '4px',
    // See all possible variables below
  }
};

// Pass the appearance object when initializing checkout
const checkout = stripe.initCheckoutElementsSdk({clientSecret, elementsOptions: {appearance}});

Commonly used variables

Rules

The rules option is a map of CSS-like selectors to CSS properties, allowing more customization of individual components. After defining your theme and variables, use rules to integrate the UI to match the design of your site.

const appearance = {
    rules: {
      '.Tab': {
        border: '1px solid #E0E6EB',
        boxShadow: '0px 1px 1px rgba(0, 0, 0, 0.03), 0px 3px 6px rgba(18, 42, 66, 0.02)',
      },

      '.Tab:hover': {
        color: 'var(--colorText)',
      },

      '.Tab--selected': {
        borderColor: '#E0E6EB',
        boxShadow: '0px 1px 1px rgba(0, 0, 0, 0.03), 0px 3px 6px rgba(18, 42, 66, 0.02), 0 0 0 2px var(--colorPrimary)',
      },

      '.Input--invalid': {
        boxShadow: '0 1px 1px 0 rgba(0, 0, 0, 0.07), 0 0 0 2px var(--colorDanger)',
      },

      // See all supported class names and selector syntax below
    }
  };

// Pass the appearance object when initializing checkout
const checkout = stripe.initCheckoutElementsSdk({clientSecret, elementsOptions: {appearance}});

All rules

The selector for a rule can target any of the public class names in the UI, and the supported states, pseudo-classes, and pseudo-elements for each class. For example, the following are valid selectors:

• .Tab, .Label, .Input
• .Tab:focus
• .Input--invalid, .Label--invalid
• .Input::placeholder

The following are not valid selectors:

• .p-SomePrivateClass, img, only public class names can be targeted
• .Tab .TabLabel, ancestor-descendant relationships in selectors are unsupported
• .Tab--invalid, the .Tab class doesnt support the --invalid state

Each class name used in a selector supports an allowlist of CSS properties, that you specify using camel case (for example, boxShadow for the box-shadow property).

The following is the complete list of supported class names and corresponding states, pseudo-classes, and pseudo-elements.

Tabs

[exampleRulesTabs@2x.9c36db7ee4c98d7b2d6f00e91e6d4f20.png]

Inputs (above labels)

[exampleRulesFormInputs@2x.4ed082ee74fcbad043a80e2d4b133b35.png]

Make sure that you choose a font size of at least 16px for input fields on mobile.

Inputs (floating labels)

[exampleRulesFormInputsFloating@2x.daec4a823ac24cc86d94a44664104eb8.png]

Block

[exampleRulesBlock@2x.556532f7e919aaf1d775ceb0253f5c22.png]

Code Input

[exampleRulesCodeInput@2x.64975e4945d393068a2f207a2d48f25c.png]

Checkbox

[exampleRulesCheckbox@2x.d7bedd38a342344eb06d5bff5dd6ae43.png]

Dropdown

[exampleRulesDropdown@2x.d635e032d2a254d672c11825a2d3d23d.png]

Switch

[exampleRulesSwitch@2x.a263ba8361af937d5228a35d18c63645.png]

Picker

[exampleRulesPicker@2x.aa78c665be0c7e33a62992c8e7e33014.png]

Make sure your .PickerItem active state stands out from the other states.

[uxTipPickerDo@2x.cc709dc96a8e99e6b020f53216d4d585.png]	[uxTipPickerDont@2x.b31bc4b51910a6eece59d44fa92c5b4d.png]
DO Use a noticeable, high-contrast primary color, weight, and/or outline to distinguish the active state your customer has already selected.	DONT Dont use two equally weighted options or low-contrast colors for your .PickerItem states because it makes distinguishing which one is active more difficult.

Menu

Accordion

Payment Method Messaging Element

Radio Icon

[exampleRulesRadioIcon@2x.25886d6b352ac0a8d003e7e2cd39677d.png]

You can control the overall size of the icon with the width property on .RadioIcon. You can control the relative size of .RadioIconInner with the r (radius) property. .RadioIconOuter and .RadioIconInner are SVG elements and can be styled with stroke and fill properties. See the full list of supported CSS properties below.

const appearance = {
  rules: {
    '.RadioIcon': {
      width: '24px'
    },
    '.RadioIconOuter': {
      stroke: '#E0E6EB'
    },
    '.RadioIconInner': {
      r: '16'
    }
  }
};

Toggle

[exampleRulesToggleItem@2x.88891aff38f391f7c792a4bfeb8ad026.png]

Other configuration options

In addition to themes, labels, inputs, variables and rules, you can style Elements using other appearance configuration options.

You can customize these by adding them to the appearance object:

const appearance = {
  disableAnimations: true,

  // other configurations such as `theme`, `labels`, `inputs`, `variables` and `rules`...
}

We currently support the below options: