Instance Methods

Method Summary

destroy()

Remove the iframe, clear listeners, and emit destroyed once for the current instance.

1
widget.destroy()

getState()

Read the current lifecycle state of the widget instance.

1
const state = widget.getState()

Return values include loading, authenticating, ready, error, and destroyed.

whenReady()

Wait for the iframe to finish initialization before running dependent UI logic.

1
await widget.whenReady()

setSymbol(symbol)

Switch the trading pair inside the iframe. If the iframe is still initializing, the SDK queues the command and sends it after ready.

1
widget.setSymbol('ETHUSDT')

setTheme(theme)

Update the theme parameter used by the embedded trading iframe.

1
widget.setTheme('dark')
2
widget.setTheme('light')

setLocale(locale)

Switch the iframe language. Supported values are en, en-US, and zh-CN.

1
widget.setLocale('en')
2
widget.setLocale('en-US')
3
widget.setLocale('zh-CN')

setSize(width, height)

Update the iframe DOM size and notify the iframe about the new outer size. Numeric values are converted to px.

1
widget.setSize('100%', 720)

reload()

Reload the current iframe and wait for it to initialize again.

1
widget.reload()

refreshAuth(reason)

Ask the iframe to refresh the current authentication flow. The optional reason value is forwarded for logging and flow control.

1
widget.refreshAuth('manual')

setTokenProvider(provider)

Replace the tokenProvider used by partner-token mode. The SDK calls the provider when the iframe requests a fresh embed token.

1
widget.setTokenProvider(async ({ channelId, symbol, reason }) => {
2
  const resp = await fetch('/api/trading/embed-token', {
3
    method: 'POST',
4
    credentials: 'include',
5
    headers: { 'Content-Type': 'application/json' },
6
    body: JSON.stringify({ channelId, symbol, reason }),
7
  })
8
9
  return resp.json()
10
})

on(event, handler)

Subscribe to a runtime event. The returned function removes the listener.

1
const off = widget.on('order_created', (event) => {
2
  console.log(event)
3
})
4
5
off()