Skip to content

docs:update advanced usage #463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Klakurka merged 1 commit into from
Feb 3, 2025
Merged

docs:update advanced usage #463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 75 additions & 37 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,47 +29,83 @@ Example using JavaScript to generate a PayButton:
<div id="my_button"></div>

<script>
function mySuccessFunction(txid, amount) {
console.log( { txid, amount } );
}
function mySuccessFunction(transaction) {
const transactionAttrs = {
hash,
amount,
paymentId,
confirmed,
message,
timestamp,
address,
rawMessage,
inputAddresses
} = transaction;

console.log(transactionAttrs);
}

function myTransactionFunction(txid, amount) {
console.log( 'Received: ' + amount );
}
function myTransactionFunction(transaction) {
const transactionAttrs = {
hash,
amount,
paymentId,
confirmed,
message,
timestamp,
address,
rawMessage,
inputAddresses
} = transaction;

console.log(transactionAttrs);
console.log( 'Received: ' + transactionAttrs.amount );
}

function myOpenFunction() {
console.log('Dialog opened.');
}
function myCloseFunction(success, paymentId) {
console.log('Closed!')
console.log('Payment successful?: ' + success)
console.log('Payment ID: ' + paymentId)
}

function myCloseFunction(success) {
console.log(`Dialog closed - user ${success ? 'did' : 'did not'} pay.`);
}
function myOpenFunction(amount, to, paymentId) {
console.log('Opened to: ' + to + ' for ' + amount + ' XEC')
console.log('Payment ID: ' + paymentId)
}

var config = {
to: 'ecash:qrmm7ed0px8tydrlhgvu3putwpwzlfyr0uzfc0slxp',
amount: 4.5,
goalAmount: 300000,
editable: false,
currency: 'USD',
text: 'Tip Us a Coffee!',
hoverText: 'One coffee',
theme: {
palette: {
primary: '#ee8b2b',
secondary: '#fefbf8',
tertiary: '#504030'
}
},
animation: 'invert',
successText: 'Purchase Complete!',
onSuccess: mySuccessFunction,
onTransaction: myTransactionFunction,
onOpen: myOpenFunction,
onClose: myCloseFunction,
randomSatoshis: true
};

PayButton.render(document.getElementById('my_button'), config);
var config = {
to: 'ecash:qrmm7ed0px8tydrlhgvu3putwpwzlfyr0uzfc0slxp',
amount: 4.5,
goalAmount: 300000,
editable: false,
currency: 'USD',
text: 'Tip Us a Coffee!',
hoverText: 'One coffee',
theme: {
palette: {
primary: '#ee8b2b',
secondary: '#fefbf8',
tertiary: '#504030'
}
},
animation: 'invert',
successText: 'Purchase Complete!',
onSuccess: mySuccessFunction,
onTransaction: myTransactionFunction,
onOpen: myOpenFunction,
onClose: myCloseFunction,
randomSatoshis: true,
opReturn:"ABC",
disablePaymentId: true,
disabled: false,
wsBaseUrl: 'http://localhost:5000',
apiBaseUrl: 'http://localhost:3000'
disableAltpayment: true,
contributionOffset: 10
};

PayButton.render(document.getElementById('my_button'), config);
</script>
```

Expand Down Expand Up @@ -115,7 +151,9 @@ render( '#advanced-usage-example', {
onTransaction: myTransactionFunction,
onOpen: myOpenFunction,
onClose: myCloseFunction,
randomSatoshis: true
randomSatoshis: true,
hideToasts: true,
opReturn: ''
})

// render 'react' button
Expand Down
108 changes: 72 additions & 36 deletions docs/zh-cn/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,47 +29,83 @@
<div id="my_button"></div>

<script>
function mySuccessFunction(txid, amount) {
console.log( { txid, amount } );
}
function mySuccessFunction(transaction) {
const transactionAttrs = {
hash,
amount,
paymentId,
confirmed,
message,
timestamp,
address,
rawMessage,
inputAddresses
} = transaction;

console.log(transactionAttrs);
}

function myTransactionFunction(txid, amount) {
console.log( 'Received: ' + amount );
}
function myTransactionFunction(transaction) {
const transactionAttrs = {
hash,
amount,
paymentId,
confirmed,
message,
timestamp,
address,
rawMessage,
inputAddresses
} = transaction;

console.log(transactionAttrs);
console.log( 'Received: ' + transactionAttrs.amount );
}

function myOpenFunction() {
console.log('Dialog opened.');
}
function myCloseFunction(success, paymentId) {
console.log('Closed!')
console.log('Payment successful?: ' + success)
console.log('Payment ID: ' + paymentId)
}

function myCloseFunction(success) {
console.log(`Dialog closed - user ${success ? 'did' : 'did not'} pay.`);
}
function myOpenFunction(amount, to, paymentId) {
console.log('Opened to: ' + to + ' for ' + amount + ' XEC')
console.log('Payment ID: ' + paymentId)
}

var config = {
to: 'ecash:qrmm7ed0px8tydrlhgvu3putwpwzlfyr0uzfc0slxp',
amount: 4.5,
goalAmount: 300000,
editable: false,
currency: 'USD',
text: 'Tip Us a Coffee!',
hoverText: 'One coffee',
theme: {
palette: {
primary: '#ee8b2b',
secondary: '#fefbf8',
tertiary: '#504030'
}
},
animation: 'invert',
successText: 'Purchase Complete!',
onSuccess: mySuccessFunction,
onTransaction: myTransactionFunction,
onOpen: myOpenFunction,
onClose: myCloseFunction,
randomSatoshis: true
};

PayButton.render(document.getElementById('my_button'), config);
var config = {
to: 'ecash:qrmm7ed0px8tydrlhgvu3putwpwzlfyr0uzfc0slxp',
amount: 4.5,
goalAmount: 300000,
editable: false,
currency: 'USD',
text: 'Tip Us a Coffee!',
hoverText: 'One coffee',
theme: {
palette: {
primary: '#ee8b2b',
secondary: '#fefbf8',
tertiary: '#504030'
}
},
animation: 'invert',
successText: 'Purchase Complete!',
onSuccess: mySuccessFunction,
onTransaction: myTransactionFunction,
onOpen: myOpenFunction,
onClose: myCloseFunction,
randomSatoshis: true,
opReturn:"ABC",
disablePaymentId: true,
disabled: false,
wsBaseUrl: 'http://localhost:5000',
apiBaseUrl: 'http://localhost:3000'
disableAltpayment: true,
contributionOffset: 10
};

PayButton.render(document.getElementById('my_button'), config);
</script>
```

Expand Down
108 changes: 72 additions & 36 deletions docs/zh-tw/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,47 +29,83 @@
<div id="my_button"></div>

<script>
function mySuccessFunction(txid, amount) {
console.log( { txid, amount } );
}
function mySuccessFunction(transaction) {
const transactionAttrs = {
hash,
amount,
paymentId,
confirmed,
message,
timestamp,
address,
rawMessage,
inputAddresses
} = transaction;

console.log(transactionAttrs);
}

function myTransactionFunction(txid, amount) {
console.log( 'Received: ' + amount );
}
function myTransactionFunction(transaction) {
const transactionAttrs = {
hash,
amount,
paymentId,
confirmed,
message,
timestamp,
address,
rawMessage,
inputAddresses
} = transaction;

console.log(transactionAttrs);
console.log( 'Received: ' + transactionAttrs.amount );
}

function myOpenFunction() {
console.log('Dialog opened.');
}
function myCloseFunction(success, paymentId) {
console.log('Closed!')
console.log('Payment successful?: ' + success)
console.log('Payment ID: ' + paymentId)
}

function myCloseFunction(success) {
console.log(`Dialog closed - user ${success ? 'did' : 'did not'} pay.`);
}
function myOpenFunction(amount, to, paymentId) {
console.log('Opened to: ' + to + ' for ' + amount + ' XEC')
console.log('Payment ID: ' + paymentId)
}

var config = {
to: 'ecash:qrmm7ed0px8tydrlhgvu3putwpwzlfyr0uzfc0slxp',
amount: 4.5,
goalAmount: 300000,
editable: false,
currency: 'USD',
text: 'Tip Us a Coffee!',
hoverText: 'One cofee',
theme: {
palette: {
primary: '#ee8b2b',
secondary: '#fefbf8',
tertiary: '#504030'
}
},
animation: 'invert',
successText: 'Purchase Complete!',
onSuccess: mySuccessFunction,
onTransaction: myTransactionFunction,
onOpen: myOpenFunction,
onClose: myCloseFunction,
randomSatoshis: true
};

PayButton.render(document.getElementById('my_button'), config);
var config = {
to: 'ecash:qrmm7ed0px8tydrlhgvu3putwpwzlfyr0uzfc0slxp',
amount: 4.5,
goalAmount: 300000,
editable: false,
currency: 'USD',
text: 'Tip Us a Coffee!',
hoverText: 'One coffee',
theme: {
palette: {
primary: '#ee8b2b',
secondary: '#fefbf8',
tertiary: '#504030'
}
},
animation: 'invert',
successText: 'Purchase Complete!',
onSuccess: mySuccessFunction,
onTransaction: myTransactionFunction,
onOpen: myOpenFunction,
onClose: myCloseFunction,
randomSatoshis: true,
opReturn:"ABC",
disablePaymentId: true,
disabled: false,
wsBaseUrl: 'http://localhost:5000',
apiBaseUrl: 'http://localhost:3000'
disableAltpayment: true,
contributionOffset: 10
};

PayButton.render(document.getElementById('my_button'), config);
</script>
```

Expand Down