@cowprotocol/widget-lib 0.6.0 → 0.7.1

package/README.md

@@ -10,7 +10,7 @@ See the widget in action in the [widget configurator](https://widget.cow.fi)
 
 ## Docs
 
-You can find a detailed description of all widget parameters in the [documentation](../../libs/widget-lib/docs/README.md)
+You can find a detailed description of all widget parameters in the [documentation](https://docs.cow.fi/cow-protocol/tutorials/widget)
 
 ## Quick start
 
@@ -31,27 +31,28 @@ Create a container somewhere in your website, the widget will be rendered inside
 Import the widget and initialise it:
 
 ```js
-import { cowSwapWidget, CowSwapWidgetParams } from '@cowprotocol/widget-lib'
+import { createCowSwapWidget, CowSwapWidgetParams } from '@cowprotocol/widget-lib'
 
 // Initialise the widget
 const widgetContainer = document.getElementById('cowswap-widget')
 
+// instantiate your own web3 provider
+const provider = window.ethereum
+
 const params: CowSwapWidgetParams = {
-  appCode: '<YOUR_APP_KEY>', // Just an unique identifier for your app
+  appCode: 'NAME-OF-YOU-APP', // Add here the name of your app. e.g. "Pig Swap"
   sell: { asset: 'DAI' },
   buy: { asset: 'USDC', amount: '0.1' },
-  // instantiate your own web3 provider
-  provider: window.ethereum,
 }
 
-const updateWidget = cowSwapWidget(
+const {updateParams} = createCowSwapWidget(
   widgetContainer,
   // Optionally, you can provide some additional params to customise your widget
-  params
+  {params, provider}
 )
 
 // You also can change widget configuration on the fly
-updateWidget({ ...params, tradeType: 'limit' })
+updateParams({ ...params, tradeType: 'limit' })
 ```
 
 ## Developers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/widget-lib",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "type": "commonjs",
   "description": "CoW Swap Widget Library. Allows you to easily embed a CoW Swap widget on your website.",
   "main": "index.js",
@@ -21,6 +21,6 @@
     "widget-lib"
   ],
   "dependencies": {
-    "@cowprotocol/events": "^0.1.0"
+    "@cowprotocol/events": "^0.2.0"
   }
 }

package/types.d.ts

@@ -122,9 +122,7 @@ export interface CowSwapWidgetParams {
     tradeType?: TradeType;
     /**
      * The base url of the widget implementation
-     *
      * The parameter can have the URL directly, or an object with the environment property,
-     *
      * The base URL will default to the production environment if not specified, so it will use https://swap.cow.fi by default.
      */
     baseUrl?: string;