Widget API Reference
Methods
Method | Description |
---|---|
open() | Opens the widget (modal) or renders the embedded element |
close() | Closes the widget dialog (modal) |
destroy() | Removes the web-component from the DOM |
subscribe(event, listener) | Listens to SDK & widget events. Returns an unsubscribe function |
setWalletClient(walletClient) | Injects / replaces a viem WalletClient |
setProvider(provider) | Injects an EIP-1193 provider (e.g., window.ethereum , WalletConnect) |
authenticate(params) | SIWE auth. Accepts { walletClient? , provider?, jwt? } |
`switchChain(chainId: number | null)` |
Events
Widget re-emits all SDK events plus its own lifecycle events.
Event | Payload | Notes |
---|---|---|
widget_open | undefined | Emitted after .open() |
widget_close | undefined | Emitted after .close() |
IxEventType.CHAT | ParsedChatJson | SDK event |
IxEventType.ORDER | ParsedOrderJson | SDK event |
IxEventType.QUICK_TRADE | QuickTradeNotificationData | SDK event |
Example
const disposer = widget.subscribe("widget_open", () => console.log("opened"));
// stop listening
disposer();