Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ectoflow/vue-stripe-elements
A Vue 2 component collection for Stripe.js
https://github.com/ectoflow/vue-stripe-elements
checkout payments stripe stripe-elements vue vue-component vue-stripe
Last synced: about 1 hour ago
JSON representation
A Vue 2 component collection for Stripe.js
- Host: GitHub
- URL: https://github.com/ectoflow/vue-stripe-elements
- Owner: ectoflow
- License: mit
- Archived: true
- Created: 2017-02-23T17:09:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-20T08:31:59.000Z (9 months ago)
- Last Synced: 2024-08-03T20:14:16.454Z (3 months ago)
- Topics: checkout, payments, stripe, stripe-elements, vue, vue-component, vue-stripe
- Language: JavaScript
- Homepage:
- Size: 377 KB
- Stars: 530
- Watchers: 29
- Forks: 125
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ⚠️ Deprecated ⚠️
This package is no longer maintained. Vue 2 [reached its end-of-life](https://blog.vuejs.org/posts/vue-2-eol) on December 31st, 2023.
# Vue Stripe Elements
- Vue 2: deprecated ❗️
- Vue 3: use [vue-stripe-js](https://github.com/ectoflow/vue-stripe-js) ✅
# Quickstart
### 1. Install package:
```bash
# npm
npm i vue-stripe-elements-plus --save-dev
# yarn
yarn add vue-stripe-elements-plus --dev
```
### 2. Add Stripe.js library to the page:
```
```
> Alternatively, you can load Stripe library dynamically. Just make sure it's ready before your components mount.
### 3. Use built-in components
Create card
```html
Pay
import { StripeElements, StripeElement } from 'vue-stripe-elements-plus'
export default {
name: 'PaymentSimple',
components: {
StripeElements,
StripeElement
},
data () {
return {
stripeKey: 'pk_test_TYooMQauvdEDq54NiTphI7jx', // test key, don't hardcode
instanceOptions: {
// https://stripe.com/docs/js/initializing#init_stripe_js-options
},
elementsOptions: {
// https://stripe.com/docs/js/elements_object/create#stripe_elements-options
},
cardOptions: {
// reactive
// remember about Vue 2 reactivity limitations when dealing with options
value: {
postalCode: ''
}
// https://stripe.com/docs/stripe.js#element-options
}
}
},
methods: {
pay () {
// ref in template
const groupComponent = this.$refs.elms
const cardComponent = this.$refs.card
// Get stripe element
const cardElement = cardComponent.stripeElement
// Access instance methods, e.g. createToken()
groupComponent.instance.createToken(cardElement).then(result => {
// Handle result.error or result.token
})
}
}
}
```
### 4. Get advanced
Create multiple elements
```html
```
### 5. Go wild
You can even create multiple groups, don't ask me why. It's possible.
```html
```
# Styles
No base style included. Main reason: overriding it isn't fun. Style as you wish via element options: [see details](https://stripe.com/docs/js/appendix/style).
# API Reference
## StripeElements.vue
Think of it as of individual group of elements. It creates stripe instance and elements object.
```js
import { StripeElements } from 'vue-stripe-elements-plus'
```
### props
```js
// https://stripe.com/docs/js/initializing#init_stripe_js-options
stripeKey: {
type: String,
required: true,
},
// https://stripe.com/docs/js/elements_object/create#stripe_elements-options
instanceOptions: {
type: Object,
default: () => ({}),
},
// https://stripe.com/docs/stripe.js#element-options
elementsOptions: {
type: Object,
default: () => ({}),
},
```
### data
You can access `instance` and `elements` by adding ref to StripeElements component.
```js
// data of StripeElements.vue
instance: {},
elements: {},
```
### default scoped slot
Elegant solution for props. Really handy because you can make `instance` and `elements` available to all children without adding extra code.
```html
```
## StripeElement.vue
Universal and type agnostic component. Create any element supported by Stripe.
### props
```js
// elements object
// https://stripe.com/docs/js/elements_object/create
elements: {
type: Object,
required: true,
},
// type of the element
// https://stripe.com/docs/js/elements_object/create_element?type=card
type: {
type: String,
default: () => 'card',
},
// element options
// https://stripe.com/docs/js/elements_object/create_element?type=card#elements_create-options
options: {
type: [Object, undefined],
},
```
### data
```js
stripeElement
domElement
```
### options
Element options are reactive. Recommendation: don't use v-model on `StripeElement`, instead pass value via options.
```js
data() {
return {
elementOptions: {
value: {
postalCode: ''
}
}
}
},
methods: {
changePostalCode() {
// will update stripe element automatically
this.elementOptions.value.postalCode = '12345'
}
}
```
### events
Following events are emitted on StripeElement
- change
- ready
- focus
- blur
- escape
```html
```
## Helpers
In case you like the manual gearbox. Check [stripeElements.js](src/stripeElements.js) for details.
```js
import { initStripe, createElements, createElement } from 'vue-stripe-elements-plus'
```