@myparcel/checkout
Advanced tools
Comparing version 3.0.9 to 3.0.10
{ | ||
"name": "@myparcel/checkout", | ||
"version": "3.0.9", | ||
"version": "3.0.10", | ||
"types": "index.d.ts", | ||
@@ -37,2 +37,3 @@ "scripts": { | ||
"babel-plugin-intl": "^0.1.1", | ||
"copy-webpack-plugin": "^5.0.4", | ||
"coveralls": "^3.0.6", | ||
@@ -39,0 +40,0 @@ "cross-env": "^5.2.1", |
@@ -11,3 +11,3 @@ # MyParcel Checkout | ||
## Introduction | ||
This is the MyParcel checkout module. It's used to show your customers the possible delivery and/or pickup options for their location, based on your settings. It barely has any css styling by itself so it should integrate with the design of your website easily. | ||
This is the MyParcel delivery options module for use in any e-commerce platform's checkout. It's used to show your customers the possible delivery and/or pickup options for their location, based on your settings. It barely has any css styling by itself so it should integrate with the design of your webshop easily. | ||
@@ -21,6 +21,6 @@ ![alt text](/demo/screenshots/checkout1.png) | ||
### Support | ||
The checkout is written in [Vue.js], it supports IE9 and up. | ||
This app is written in [Vue.js], it supports IE9 and up. | ||
## Example | ||
An example of the checkout functionality can be found in our [sandbox]. Here you can try out every combination of settings and copy the code for your project. | ||
An example of the delivery options functionality can be found in our [sandbox]. Here you can try out every combination of settings and copy the code for your project. | ||
@@ -35,10 +35,11 @@ ## Installation | ||
3. Include `dist/myparcel.js` in your project. | ||
4. Place `<div id="myparcel-checkout"></div>` in your HTML. | ||
5. The checkout will be rendered inside that element! | ||
4. Place `<div id="myparcel-delivery-options"></div>` in your HTML. | ||
5. Follow the usage instructions. | ||
6. The delivery options will be rendered inside the div created in step 4. | ||
## Usage | ||
You have to provide a configuration file in the following format as `window.MyParcelConfig` and initialize the checkout with an event. | ||
You have to provide a configuration file in the following format as `window.MyParcelConfig` and initialize the delivery options with an event. | ||
### Minimum required data | ||
This is the minimum amount of data you need to provide for the checkout to work correctly as a SendMyParcel user. | ||
This is the minimum amount of data you need to provide for the delivery options to work correctly as a SendMyParcel user. | ||
```js | ||
@@ -56,5 +57,5 @@ window.MyParcelConfig = { | ||
// Trigger this event on the document to tell the checkout to update. | ||
// Trigger this event on the document to tell the delivery options to update. | ||
// Usually only needed on initializing and when the address changes. | ||
document.dispatchEvent(new Event('myparcel_update_checkout')); | ||
document.dispatchEvent(new Event('myparcel_update_delivery_options')); | ||
``` | ||
@@ -142,3 +143,3 @@ | ||
To get the object with the selected options from the checkout do the following: | ||
To get the object with the selected options from the delivery options do the following: | ||
```js | ||
@@ -145,0 +146,0 @@ const data = document.querySelector('#mypa-input').value; |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Shell access
Supply chain riskThis module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
403022
5
554
167
24
1