Vue-stripe-better-elements

Breaking changes in v2.0.0 (18/09/2019)

Version 2.0.0, released on September 18 2019, introduced some breaking changes:

• A new prop elsOptions has been introduced to enable passing options to the underlying stripe.elements() method
• The options prop has been renamed to elOptions to preserve naming consistency

What?

vue-stripe-elements, but different.

Why?

I needed Iban support, not provided by vue-stripe-elements

Moreover vue-stripe-elements, prevents you from using multiple <stripe-elements/> components on the same page, as there is only one instance of the createToken and createSource methods needed to further process payment.

Anyway, I forked vue-stripe-elements and added scoped slots and made createToken and createSource methods accessible per component.

How?

Install the package:

// if your one of the cool kidz:
yarn add vue-stripe-better-elements
// or if you're old school:
npm i vue-stripe-better-elements

Make sure you include the Stripe.js library somewhere in your page

<script src="https://js.stripe.com/v3/"></script>

You should be good to go!

What you get for free:

The library exports several properties, but you will mainly use:

• The StripeElement component, that calls the Stripe.js library under the hood and display the stripe Element matching the type props:

  import { StripeElement } from
  <stripe-element type="card" />
  <stripe-element type="iban" />

• A Stripe object with the following structure:

  {
    components: [ /* list of instanciated components*/ ],
    get: function (componentType, stripeKey) {
      // return the component matching type and key
    }
  }

Each component looks like this:

{
  type: 'card',         // element type (card, iban...)
  key: 'pk_test_xxxx',  // the stripe key used for this component,
  element: {/*..*/},    // the stripe element created by the Stripe library,
  elements: {/*..*/},   // the stripe elements created by the Stripe library,
  createToken: fn,      // the element's createToken function
  createSource: fn,     // the element's createSource function
  retrieveSource: fn    // the element's retrieveSource function
}

Component props:

Breaking changes in v2.0.0 (18/09/2019):

• type (required):

  A string containing a stripe Element type. Currently accepts one of the following: card, iban, cardNumber, cardExpiry, cardCvc

• stripe:

  Your stripe public key (pk_test_xxxxxxxxxxxxxxxxxxxxxxxx) or a stripe instance.

• elOptions

  A stripe Element option object used to create the current element. For example, the Iban element needs a {supportedCountries: ['SEPA']} option object. Practically, it will be passed as the option parameter in the call to elements.create('iban', options) See the Stripe documentation for further information.

• elsOptions

  An object that will be used to create an instance of elements, which manages a group of Elements. You can use this to change the locale of your component (ie: set it to { locale: 'de' } to switch the current component to German. More information on the Stripe documentation

• stripeOptions

  A object to create an instance of the Stripe object. Attention : Please note that this option will overwrite any custom elsOptions defined. ie: if you set your locales via this option, you won't be able to set your locale per component via ``elsOptions.

Documentation for v1.0.x [deprecated]

• options

  A stripe Element options to instanciate the current element. For example, the Iban element needs a {supportedCountries: ['SEPA']} option object.

• stripeOptions

  A stripe Elements option

STFU & Show me the code

There are two ways to use the library:

Using Scoped Slots

<template>
  <div class="container">
    <!-- stripe Iban element -->
    <stripe-element
      type="iban"
      :stripe="stripeKey"
      :options="ibanOptions"
      @change="ibcompleted = $event.complete"
    >
      <template slot-scope="slotProps">
        <button :disabled="!ibcompleted" @click="payByIban(slotProps.elements)">
          Pay by IBAN
        </button>
      </template>
    </stripe-element>

    <!-- stripe Card element -->
    <stripe-element
      type="card"
      :stripe="stripeKey"
      :elsOptions="elsOptions"
      @change="cdcompleted = $event.complete"
    >
      <template slot-scope="slotProps">
        <button :disabled="!cdcompleted" @click="payByCard(slotProps)">
          Pay by Card
        </button>
      </template>
    </stripe-element>
  </div>
</template>

<script>
  import { StripeElement } from "vue-stripe-better-elements";

  export default {
    components: {
      StripeElement
    },
    data: () => ({
      stripeKey: "pk_test_xxxxxxxxxxxxxxxxxxxxxxxx",
      elsOptions: {
        locale: "fr"
      },
      ibanOptions: {
        supportedCountries: [`SEPA`],
        placeholderCountry: `DE`
      },
      ibcompleted: false,
      cdcompleted: false
    }),
    methods: {
      payByIban({ createSource }) {
        createSource({
          type: "sepa_debit",
          currency: "eur",
          owner: {
            name: "foobar",
            email: "[email protected]"
          },
          mandate: {
            notification_method: "email"
          }
        })
          .then(console.log)
          .catch(console.error);
      },
      payByCard(slotProps) {
        slotProps.elements
          .createToken()
          .then(console.log)
          .catch(console.error);
      }
    }
  };
</script>

Using global Stripe object

If you need to display the payment button somewhere else in your page, then this is for you:

<template>
  <div class="container">
    <!-- stripe Iban element -->
    <stripe-element
      type="iban"
      :stripe="stripeKey"
      :elOptions="ibanOptions"
      @change="ibcompleted = $event.complete"
    />

    <!-- stripe Card element -->
    <stripe-element
      type="card"
      :stripe="stripeKey"
      :elsOptions="elsOptions"
      @change="cdcompleted = $event.complete"
    />
    <div class="buttons has-addons is-centered">
      <button
        class="button is-info"
        :disabled="!cdcompleted"
        @click="payByCard"
      >
        Pay by Card
      </button>
      <button
        class="button is-info"
        :disabled="!ibcompleted"
        @click="payByIban"
      >
        Pay by IBAN
      </button>
    </div>
  </div>
</template>

<script>
  import { StripeElement, Stripe } from "vue-stripe-better-elements";

  export default {
    components: {
      StripeElement
    },
    data: () => ({
      // set the locale to german
      elsOptions: {
        locale: "de"
      },
      ibanOptions: {
        supportedCountries: [`SEPA`],
        placeholderCountry: `DE`
      },
      ibcompleted: false,
      cdcompleted: false
    }),
    methods: {
      payByIban() {
        Stripe.get("iban", this.stripeKey)
          .createSource({
            type: "sepa_debit",
            currency: "eur",
            owner: {
              name: "foobar",
              email: "[email protected]"
            },
            mandate: {
              notification_method: "email"
            }
          })
          .then(console.log)
          .catch(console.error);
      },
      payByCard() {
        Stripe.get("card", this.stripeKey)
          .createToken()
          .then(console.log)
          .catch(console.error);
      }
    }
  };
</script>

Example

You will find an example in the example folder (how original).

git clone https://github.com/Cl3MM/vue-stripe-better-elements.git
cd example
yarn global add @vue/cli-service-global
echo "VUE_APP_STRIPE_KEY=pk_test_xxxxxxxxxxxxxxxxxxxxxxxx" > .env
yarn serve

Then, point your browser to the URL displayed in your terminal.

Rant

Not carefully tested, use at your own risks.

If you find a bug, make a PR. If you find more bugs, make more PR.

Don't open an issue asking for unit tests. If you need tests, write a PR.