Methods

Here are the methods available in our JavaScript API

Show

Make TransactionLinks widget reveal itself.

window.transactionlink.open();

Hide

Hide TransactionLink widget.

window.transactionlink.close();

SetOptions

Use this method to set options of widget.

window.transactionlink.setOptions({
  token: 'exampleToken'
});

Ready

Trigger a function when a widget is fully loaded.

 window.transactionlink_ready = () => {
      transactionlink.setOptions({
          token: 'exampleToken'
      })
      window.transactionlink.open()
}

On

We expose the methods that allow reacting and listening to events emitted from the widget.

Listening for the event about opening widget

transactionlink.on("widget-opened", () => {
    console.log("OPENED")
})

Listening for the event about closing widget

transactionlink.on("widget-closed", () => {
    console.log("CLOSED")
})

Listening for the event about error

transactionlink.on("error", () => {
    console.log("ERROR")
})

Listening for the event about workflow finished

transactionlink.on("workflow-finished", (event) => {
    console.log(event)
})

UnmountWidget

Use this method to remove widget from DOM. Once unmounted, reload widget script and repeat initialisation of widget. (https://docs.transactionlink.io/docs/js-api#how-to-implement-widget-communication)

window.transactionlink.unmountWidget()