Skip to content

[MNY-236] Portal: Update BridgeWidget script docs to reflect new typescript type #8200

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
merged 1 commit into from
Oct 6, 2025
Merged

[MNY-236] Portal: Update BridgeWidget script docs to reflect new typescript type #8200

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
22 changes: 9 additions & 13 deletions apps/portal/src/app/bridge/bridge-widget-script/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,6 @@ The BridgeWidget Script makes it easy to embed cross-chain swaps and fiat onramp
BridgeWidget.render(container, {
clientId: "your-thirdweb-client-id",
theme: "dark",
buy: {
chainId: 8453,
amount: "0.1",
},
});
</script>
```
Expand Down Expand Up @@ -126,9 +122,9 @@ type Options = {
};
};
};
buy: {
amount: string;
chainId: number;
buy?: {
amount?: string;
chainId?: number;
tokenAddress?: string;
buttonLabel?: string;
onCancel?: (quote: BuyOrOnrampPrepareResult | undefined) => void;
Expand Down Expand Up @@ -310,8 +306,8 @@ The options to configure the "Buy" tab UI.

```ts
type Buy = {
amount: string; // Required
chainId: number; // Required
amount?: string;
chainId?: number;
tokenAddress?: string;
buttonLabel?: string;
onCancel?: (quote: BuyOrOnrampPrepareResult | undefined) => void;
Expand All @@ -327,21 +323,21 @@ type Buy = {
```


<Details summary="amount" tags={["Required"]}>
<Details summary="amount">

Set the default token amount shown in the "Buy" tab.

</Details>

<Details summary="chainId" tags={["Required"]}>
<Details summary="chainId">

Specify which chain should be selected in the "Buy" tab.
Specify the default chain to be selected in the "Buy" tab.

</Details>

<Details summary="tokenAddress">

Specify which token should be selected in the "Buy" tab. If not specified, the native token of the selected chain will be selected.
Specify the default token to be selected in the "Buy" tab. If not specified, the native token of the selected chain will be selected.

</Details>

Expand Down
Loading