This is an Angular wrapper library for Paddle.js.
This is an extension for the previous Angular-Paddle-Wrapper-Library by Oakify modified by adding the capability to toggle between sandbox and production environment.
The author has no affiliation with Paddle.com Market Limited.
This project was generated with Angular CLI version 11.2.14.
Make sure you have an active Paddle account and have read the docs on paddle.com.
$ npm install ngx-paddle
$ yarn add ngx-paddle
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { PaddleModule } from 'ngx-paddle';
@NgModule({
declarations: [AppComponent],
imports: [BrowserModule, PaddleModule.forRoot({ sandbox: true/false })],
providers: [],
bootstrap: [AppComponent],
})
export class AppModule {}
<button
ngxPaddle
[vendor]="123456"
[product]="654321"
email="test@test.com"
(onCheckoutEvent)="checkEvent($event)"
></button>
Since most of the functionality is through the service you can imlpement this yourself to customize to your needs further.
import { Component, AfterViewInit } from '@angular/core';
import {
PaddleService,
PaddleCheckoutOptions,
PaddleEventCallbackData,
PADDLE_EVENT_TYPE,
} from 'ngx-paddle';
export class ComponentThatImplementsPaddle implements AfterViewInit {
private paddleOptions: PaddleCheckoutOptions = {
product: 654321,
title: 'Test Title',
message: 'Test Message',
coupon: 'TEST',
email: 'test@test.com',
};
constructor(private paddleServ: PaddleService) {}
// Create and open programatically once the library is loaded.
ngAfterViewInit() {
// Method 1: If you don't need to extract callback data from paddle to angular application
this.paddleServ.create({
vendor: 123456,
eventCallback: this.checkEvent,
});
// Method 2: Extracting callback data from paddle to angular application
this.paddleServ.create({
vendor: 123456,
eventCallback: (response) => {
console.log(response);
},
});
}
onSubscribe() {
this.paddleServ.open(this.paddleOptions);
}
checkEvent(data: PaddleEventCallbackData) {
// Handle Event
if (data.event === PADDLE_EVENT_TYPE.CheckoutComplete) {
console.log('User has completed checkout!');
} else {
console.log(data.event);
}
}
}
For Directive:
Attribute/prop | input/output | optional/required | Type | Description |
---|---|---|---|---|
vendor | input | required | number | Your vendor id |
product | input | required | number | Your product id |
title | input | optional | string | See docs |
message | input | optional | string | See docs |
coupon | input | optional | string | See docs |
input | optional | string | See docs | |
onCheckoutEvent | output | optional | string | See docs |
For Service: all other options
import { Component, AfterViewInit } from '@angular/core';
import {
PaddleProductPrice,
PaddleService,
PaddleCheckoutOptions,
PaddleEventCallbackData,
PADDLE_EVENT_TYPE,
} from 'ngx-paddle';
export class ComponentThatImplementsPaddle implements AfterViewInit {
private paddleOptions: PaddleCheckoutOptions = {
product: 654321,
title: 'Test Title',
message: 'Test Message',
coupon: 'TEST',
email: 'test@test.com',
};
price: PaddleProductPrice;
constructor(private paddleServ: PaddleService) {}
// Create and open programatically once the library is loaded.
ngAfterViewInit() {
this.paddleServ.create({
vendor: 123456,
eventCallback: this.checkEvent,
});
// GET YOUR PRODUCTS PRICE:
const numberOfProductsToPrice = 2;
this.price = await this.paddleServ.getPrice(this.paddleOptions.product, numberOfProductsToPrice);
// OR (quantity defaults to 1):
this.price = await this.paddleServ.getPrice(this.paddleOptions.product);
}
[...]
}
Just run ng build paddle
and the library will be generated at dist folder
Want to contribute to this project? Awesome! There are many ways you can contribute, see below.
Open an issue to report bugs or to propose new features. If you have a general usage question please note that this is just a wrapper and most questions should be directed to the actual library in Stack Overflow etc.
Pull requests are more than welcome. Note that if you are going to propose drastic changes or new features, be sure to open an issue for discussion first, to make sure that your PR will be accepted before you spend effort coding it.
Tests!