feat: add maxHeight parameter to widget

cowprotocol · Nov 26, 2024 · fa811df · fa811df
1 parent 5fa9631
commit fa811df
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/docs/cow-protocol/tutorials/widget/widget.md b/docs/cow-protocol/tutorials/widget/widget.md
@@ -269,9 +269,10 @@ createCowSwapWidget(document.getElementById('cowswap-widget'), {
 > All params are optional
 
 | Parameter                             | Type                   | Default                | Description                                                                                                                                                                                                                                                                                                                                                                                  |
-| ------------------------------------- | ---------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|---------------------------------------|------------------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `width`                               | `string`               | 400px                  | The width of the widget in css values (px, vh, etc.).                                                                                                                                                                                                                                                                                                                                        |
 | `height`                              | `string`               | 600px                  | The height of the widget in css values (px, vh, etc.).                                                                                                                                                                                                                                                                                                                                       |
+| `maxHeight`                           | `number`               | ---                    | The widget automatically adjusts its height depending on the content. By default, the maximum height is `body.offsetHeight`, but it might be customized using the `maxHeight` parameter.                                                                                                                                                                                                     |
 | `appCode`                             | `string`               | ---                    | The unique identifier of the widget consumer. Please fill the for to let us know a little about you: <https://cowprotocol.typeform.com/to/rONXaxHV>.                                                                                                                                                                                                                                         |
 | `provider`                            | `EthereumProvider`     | ---                    | The Ethereum provider to be used for interacting with a wallet. To connect, for example, to Rabby Wallet or Metamask, just set `window.ethereum`. You also might like to use <https://web3modal.com>.                                                                                                                                                                                        |
 | `chainId`                             | `number`               | 1                      | The blockchain ID on which the trade will take place. Currently supported: 1 (Mainnet), 100 (Gnosis chain), 42161 (Arbitrum one), 11155111 (Sepolia).                                                                                                                                                                                                                                        |